How to setup a BI-Beacon

Setup BI-Beacon via Wifi

You can setup a BI-Beacon using a mobile or desktop device that connects to the Beacons own setup web page.

  1. Find your WiFi credentials (password and WiFi name)
  2. Plugin your BI-Beacon (it turns blue)
  3. Disable cellular network (if on mobile device)
  4. Wait up to 30 seconds until BI-Beacon starts shifting slowly between blue and green (this means setup mode is active)
  1. Connect to WiFi “BI-Beacon-A1B2C3” (where A1B2C3 is unique for your Beacon)
  1. Browse to BI-Beacon’s Setup Page:

  2. Enter details

    a. WiFi name: the WiFi lamp should connect to (also known as SSID)

    b. WiFi password: password of WiFi to connect to (leave empty if no password)

    c. Channel key: the string identifier controlling the beacon state (read more in the API section)

    Optional settings available from firmware version 0.84 and upwards:

    d. State server: The channel state server to connect to. Default:

    e. Port: The TCP port to connect to on the channel state server. Default: 4040.

  1. This should then happen:
    1. The Beacon will turn blue meaning it is trying to connect to the router
    2. It will turn purple which means it is connecting to state server
    3. Then it will turn green if all goes well!


If you have any issues, please refer to troubleshooting.


To reset or reconfigure a BI-Beacon, reboot it whilst it cannot connect to the router. E.g by doing any of the following:

  1. Change SSID or password on the router
  2. Turn off the router temporarily
  3. Move the BI-Beacon far away from the router

When you plug it in again, the Beacon will try to connect and fail. It will then go into setup mode again.

Setup BI-Beacon via USB

You can also setup a BI-Beacon using a USB data cable. (This, however, requires that your user is on a Linux machine and has the proper permissions (often this means being part of the dialout user group.)

Clone the cli repo (see Repositories).

Then, in a terminal of your choice,

$ python <ssid> <password> <channelkey> [stateserver] [port]