iBKS Config Tool User Manual – iOS

ABSTRACT

This document is the iBKS Config Tool User Manual (iOS version) which explains how to use all functions.

AUDIENCE

This document is focused for users with basic knowledge of beacons

IMPORTANT

The new iBKS Config Tool iOS requires:

  • iOS 9 or higher
  • Both Bluetooth and location must be enabled on the mobile device

downloadapple_store_qrmac_app_store_badge_us-uk_165x40

  1. Install & setup
  2. Connect to a beacon
  3. Configure Eddystone Service
  4. Configure iBeacon Service
  5. Change Connectable Mode
  6. Configure Connectable Window
  7. Configure Advertising Window
  8. Lock Beacon
  9. Disable relock Beacon
  10. Change Password
  11. Change Device Name
  12. Factory Reset
  13. Add Deployment File and scan iBKS beacons
  14. Annex I. Eddystone fields configuration guide
  15. Annex II. iBeacon fields configuration guide
  16. Annex III. Understanding Connectable Window
  17. Annex IV. Understanding Advertising Window

Install & setup

  1. Install the App from iTunes
  2. Open the App
  3. The screen “Google Sign In” appears. You need to sign in if you would like to register Eddystone EID. Otherwise, skip this step by clicking on the arrow placed in the top left side 1111
  4. Once signed in, choose a Google Project from the list (choose “Not Selected” if you don’t have any), for registering Eddystone EID
    1. Select project img_2333
    2. Click on return 1aaaaaaa

Connect to a beacon

  1. Click scan button to find the specific beacon to connect (you may wait the scan to end or once you find the beacon, click on the scan button again to stop it) img_2315
  2. Click on the beacon to connect img_2315
  3. Connected! img_2317

 

IMPORTANT

If this screen does not appear, the beacon could be in a non-connectable mode. Reset the beacon to entry in a connectable mode period.

 

Configure Eddystone Service

  1. Being connected, click on Eddystone Service to expand (the current configuration is shown). img_2317
    1. Select the slot to configure
    2. Choose Eddystone type
    3. Fill all the required fields img_2322
    4. 70912d2ac4b5441beae8618b50dbc918a42fd24e5b8d09b373pimgpsh_fullsize_distr Check Annex I for further information

  2. Disconnect to save changes
    1. Click on return img_2324
    2. Click on return img_2318
    3. Click on “SAVE” or “SAVE & DISCONNECT” img_2338
    4. Click “OK” img_2339

Configure iBeacon Service

  1. Being connected, click on iBeacon Service to expand (the current configuration is shown) 2aaaaa
    1. Select the slot to configure
    2. Fill all the required fields img_232570912d2ac4b5441beae8618b50dbc918a42fd24e5b8d09b373pimgpsh_fullsize_distr Check Annex II for further information
  2. Disconnect to save changes
    1. Click on return img_2325_2
    2. Click on return img_2319
    3. Click on “SAVE” or “SAVE & DISCONNECT” img_2338
    4. Click “OK” img_2339

Change Connectable Mode

  1. Being connected, click on Global Service to expand (the current configuration is shown) img_2317-23
  2. Select mode img_2326_2
  3. Disconnect to save changes
    1. Click on return img_2326
    2. Click on return img_2320
    3. Click on “SAVE” or “SAVE & DISCONNECT” img_2338
    4. Click on “OK” img_2339

Configure Connectable Window

70912d2ac4b5441beae8618b50dbc918a42fd24e5b8d09b373pimgpsh_fullsize_distr How does it work? See Annex III

  1. Being connected, click on Global Service to expand (the current configuration is shown) img_2317-23
    1. Enable “Connectable mode”
    2. Enable connectable window
    3. Set connectable period
    4. Set connectable window img_2340_2
  2. Disconnect to save changes
    1. Click on return img_2326
    2. Click on return img_2320
    3. Click on “SAVE” or “SAVE & DISCONNECT” img_2338
    4. Click “OK” img_2339

Configure Advertising Window

70912d2ac4b5441beae8618b50dbc918a42fd24e5b8d09b373pimgpsh_fullsize_distr How does it work? See Annex IV

  1. Being connected, click on Global Service to expand (the current configuration is shown) img_2317-23
    1. Enable “Advertising Window” (if disabled, it advertises all the time)
    2. Set starting time
    3. Set ending time img_2341_2
  2. Disconnect to save changes
    1. Click on return img_2341
    2. Click on return img_2320
    3. Click on “SAVE” or “SAVE & DISCONNECT” img_2338
    4. Click “OK” img_2339

Lock Beacon

  1. Being connected, click on Global Service to expand (the current configuration is shown) img_2317-23
  2. Click on “Lock and Disconnect” img_2341
  3. A warning message appears. Click on YES if you agree.

IMPORTANT

The device gets lock with the previous password saved. By default, password is 32 ‘0’ chars (00000000….000). Check “Change password” to change it.

 

img_2342

Disable relock Beacon

  1. When connecting, in order to unlock the beacon, the password will be requested. img_2343
  2. Being connected, click on Global Service to expand (the current configuration is shown) img_2317-23
  3. Click on “Disable Relock” img_2344

Change Password

  1. Being connected, click on the menu in the top right side. img_2317
  2. In the menu, click on “Change Password” img_2321
  3. Enter current password (up) and the new one (down). Then, click on SAVE. img_2346

IMPORTANT

When a new password is set the beacon automatically gets locked. In case you want to keep it unlocked, disable relock to retrieve (see chapter 9 “Disable relock beacon).

 

Change Device Name

  1. Being connected, click on the menu in the top right side. img_2317
  2. In the menu, click on “Change Device Name” img_2321
  3. Enter the new name and click on SAVE img_2347
  4. A warning message appears. Click on YES if you agree. img_2348

Factory Reset

  1. Being connected, click on the menu in the top right side. img_2317
  2. In the menu, click on “Factory Reset” img_2345

    IMPORTANT

    For the factory reset the beacon must be connected from the locked state. So:

    1. Lock the beacon (see chapter 8)
    2. Connect to the beacon entering password
    3. Apply factory reset
  3. A warning message appears. Click on YES if you agree. img_2349

Add Deployment File and scan iBKS beacons

IMPORTANT

  • The deployment file is provided only for orders of 100 beacons or more and when a custom configuration for each beacon was requested.
  • The deployment file cannot be used for mass programming. It is for deployment purposes and it is only used to show the configuration of the beacons according to their QR code without the need to connect to it.
  1. Click on “Deployment” tab img_2315
  2. Use iTunes on a PC or MAC to load the CSV file you previously received from Accent Systems. img_2328
  3. Click Scan button to start scanning iBKS beacons
    1. Click on “scan” beacon img_2329
    2. Scan a beacon img_2350
    3. Get iBKS beacon deployment info img_2351

Annex I. Eddystone fields configuration guide

1. Common fields

ADVERTISING INTERVAL
  • Advertising Interval in milliseconds (ms)
  • UID, EID & URL: from 100ms to 10000ms
  • TLM: from 1000ms to 65535ms (as long as there is at least one slot active a part of this. Otherwise the maximum is 10000ms).
TX. POWER
  • Radio TX power values in hexadecimal (00 – 07). Next table shows the equivalence between power and hexadecimal value to be set:

radio-power

CAL. POWER 0m (dBm)
  • Calibration Power: The transmit power as measured zero meters away from the beacon.
  • Values between -126dBm and 127dBm.
  • We suggest -21dBm as default configuration value and we also encourage you to update it after calibrating again once the beacon is placed.

2. Eddystone UID configuration

UID
  • 16-byte hexadecimal (32 hex chars)10-byte Namespace + 6-byte Instance. Example: BA1C51BAB3147EFEE8E5252423222120

3. Eddystone EID configuration

ID
  • 16-byte hexadecimal (32 hex chars)10-byte Namespace + 6-byte Instance. Example: BA1C51BAB3147EFEE8E5252423222120
  • The ID status field shows the ID status in the google platform: if the ID is still available, if it is already registered, if it is still synchronized, …
EID Rotaion Period (K)
  • It sets from several predefined values how often the advertised encrypted ID is changed.

4. Eddystone URL configuration

URL
  • 18-ASCII chars maximum taking into account the following prefixes and suffixes are encoded to a 1 char size:
    http://
    https://
    http://www.
    https://www.
    .com/
    .org/
    .edu/
    .net/
    .info/
    .biz/
    .gov/
    .com
    .org
    .edu
    .net
    .info
    .biz
    .gov

    For example, http://www.accent-systems.com would be “http://www.” = 1 char, “accent-systems” = 14 chars and “.com” = 1 char, being 16 chars in total amount.

Annex II. iBeacon fields configuration guide

ADVERTISING INTERVAL

Advertising Interval in milliseconds (ms) from 100ms to 10000ms

TX. POWER

Radio TX power values in hexadecimal (00 – 07). Next table shows the equivalence between power and hexadecimal value to be set:
radio-power

CAL. POWER 1m (dBm)
  • Calibration Power: The transmit power as measured 1 meter away from the beacon.
  • Values between -126dBm and 127dBm.
  • We suggest -58dBm as default configuration value and we also encourage you to update it after calibrating again once the beacon is placed.
UUID [HEX]

A 16-byte hexadecimal (32 hex chars) organizational identifier for your beacon. Example: BA1C51BAB3147EFEE8E5252423222120

Major [HEX]

A 2-byte hexadecimal (4 hex chars) group identifier for your beacon. Example: 0E56

Minor [HEX]

A 2-byte hexadecimal (4 hex chars) unit identifier for your beacon. Example: 09FA

Extra Byte

If enabled, the battery level is advertised in the iBeacon Frame

Annex III. Understanding Connectable Window

In order to configure the connectable window, 2 parameters must be set:

  • Connectable period: how often the beacon enters in connectable mode. Connectable window: how long the beacon is able to connect.
  • Look at the next example where the connectable period is set to 60s and the connectable window to 20s. Therefore, every 60s the beacon will be connectable during 20s.

connectable period window

Annex IV. Understanding Adverstising Window

In order to configure the advertising window, 2 parameters must be set:

  • Advertising ON: what time the advertising starts
  • Advertising OFF: what time the advertising stops

Note: the difference between ON and OFF times cannot be greater than 17h!

Look at the next example where the advertising ON is set to 8h and the advertising OFF to 21h. Therefore, the beacon will be advertising from 8am till 9pm and will be in stand-by from 9pm till 8am.
advertising window

Last modified: August 9, 2017

CONTACT US

Lead Source
Lead Status
Lead Status

Max File(s) size limit is 20 MB