Configure uBeacon devices

It is recommended to use the ubudu Manager platform in order to manage your beacons, instead of doing it manually. This will bring several benefits such as :

  • Better fleet management of your ( venues X beacons ) distributed setup
  • Less risk to do mistakes when updating beacon configuration
  • Automated beacon battery alerts
  • Easier business management for Contextual Interaction Rules, Indoor Location, and Mesh

Beacon setup via ubudu Manager

Venues

First step is to define the Venues where you're going to place your beacons.

Login to ubudu Manager, Go into "Venues", and choose between "Add Venue" and "Batch Import".

  • Add Venue : the more information you use, the better. Use tags to add seach keywords you will want to use later, when for instance creating a Contextual Interaction Rule. E.g. "Scotland", "Extra-large store format".
  • Batch import : same fields as in Add Venue, using an Excel template.

venues1.JPG

Devices

Go into "Devices" and choose "..." or "Add Beacon Device" , depending whether you want to manage an existing beacon device, declare a new one.

Note : if you're using uBeacon devices, then all yours should already have been assigned to your ubudu Manager account, and be visible on this screen. As such, you shouldnt have to add new beacon devices manually, except perhaps for testing and using the beacon emulator with the uBeacon Manager app on iOS.

devices1.JPG

Beacon's device identification & location

Just enter the identify of this beacon in text form.

devices2.JPG

Beacon's pre-set proximity uuids

Choose the Proximity UUID corresponding to the app you want to use the beacon with. This ID is the main one broadcasted by the beacon, together with Major ID and Minor ID.

Secure Mode and Service Mode should also have their P.UUID specified, if you plan to use them.

devices3.JPG

Beacon's device advertising configuration

Here you define other key advertising (broadcasting) parameters for the beacon.

  • Anti-hacking protocol. Note that all beacons in this case must use the same protocol in the application. Default : none
  • Major, Minor: pre-set but can be changed. Make sure each device has a different major,minor in order to be able to use them together. In case of secured mode only the major is used.
  • Calibration RSSI : Optional. The RSSI value read at 1m distance from the beacon
  • Tx power level : Optional. The Tx power level of advertising signal, as a level between 1 to 15 for uBeacons v1.0 and between 1 to 7 for uBeacons v2.0
  • Advertising frequency:Optional. The advertising interval in ms between two BLE advertising packets. Default values for iBeacon is 100ms.

devices4.JPG

Beacon's device firmware and security settings (Ubudu's hardware only)

You shouldn't have to edit these values much. The main one, to secure the connection to your beacons, is :

Connection password : indicates it uses a anti-hacking protocol. Note that all beacons in this case must use the same protocol in the application. default : none

Other hardware settings (uBeacon >2.0 only)

  • LED Led on status settings. You can turn off led to save additional power or when not required (e.g. sealed boxes). Example JSON: {"enabled":true}

  • USB UART USB-UART settings (requires compatible cable). For nodes connected to a PC / router for instance. Example JSON: {"enabled":true}

  • Advertising schedule : Optional. Advertising schedule for uBeacons >2.0. Example JSON: { "schedule_start": "01:00", "schedule_end": "23:00","mon":2, "tue":2,"wed":2,"thu":1,"fri":2, "sat":2,"sun":0}

Mesh network settings (uBeacon 2.0 Mesh only)

Please refer to the Mesh documentation for instructions.

OTA update

Once you've configured your beacons on ubudu Manager, the next step is to apply these Cloud settings to be beacons themselves, using the uBeacon Manager app on iOS.

  • Login on the uBeacon Manager app using your ubudu Manager credentials
  • Go to "Configure", and choose the relevant venue or View all beacons
  • Switch on the beacon, and press on its button to make it connectable
  • Accept pairing request (first time connection only)
  • Once connected, choose "Apply Cloud Settings" on the top right corner

Beacon manual setup

Connection and Sync

Do this when you want to either manually edit a beacon without impacting the ubudu Manager platform:

  • Login on the uBeacon Manager app using your ubudu Manager credentials
  • Make sure you see the beacon in the Monitor view. If not, try another Proximity UUID in the Edit top right corner.
    • If you still can't see the beacon, make sure it is really switched on. If so, perhaps it is advertising on a Proximity UUID which is not refered in your account. You need to login on ubudu Manager and add/edit an Application with this Proximity UUID.
  • Go to Configure tab in the app
  • Choose a Venue or to view All beacons
  • Press shortly the beacon button to make it connectable. It should now appear highlighted on the beacon view list.
  • Select the beacon on the beacon view list, and accept pairing requests (if first time connection using the iOS device on that beacon).
  • Once connected to the beacon, you can edit its settings by choosing Manual Edit in the top right corner.
    • Other choices in the top right corners are :
    • If you already registered the beacon on ubudu Manager, Apply Cloud Settings will update the beacon settings with those stored on the server
    • If you havent registered the beacon on ubudu Manager, Add beacon to Cloud will register it under your account. Warning: if you do manual edits they will be overriden whenever you do a subsequent Apply Cloud Settings.

Edition

The settings which you can edit using the uBeacon manager app are the same as when doing it on the ubudu Manager interface, as described in the "Devices" section above.