ABSTRACT

This document is an iBKS Config Tool App User Manual that explains how to use all its functions.

AUDIENCE

This document is focused for users with basic knowledge of beacons

Install & setup

1. Install the App by giving access permissions
   
2. Open the App
   
3. Check the first tips by scrolling left and click “Done”
4. Choose a google account to associate with
   
5. The first time every feature is open, a virtual guide appears to help with some tips
   
6. Select a project for registering EID by clicking on the menu in the top right side
7. Choose one project from the list (choose none if you don’t have any)

2. Connect to a beacon

1. Click on the scan button to find the specific beacon to connect (you may need to wait for the scan to end or once you find the beacon, click on the scan button again to stop it)
   
2. Click on the beacon to connect. Connected!
   
3. If this screen does not appear, the beacon could be in a non-connectable mode. Reset the beacon to enter in a connectable mode period.
   

3. Configure Eddystone Service

1. Being connected, click on Eddystone Service to expand (the current configuration is shown)
   1. Select the slot to configure
   2. Choose Eddystone type
   3. Fill all the required fields
      
      Check Annex I for further information
2. Disconnect to save changes
   1. Click on return
      
   2. Click on return
      
   3. Click on “YES”
      
   4. Click OK
      

4. Configure iBeacon Service

1. Being connected, click on iBeacon Service to expand (the current configuration is shown)
   1. Select the slot to configure
   2. Fill all the required fields
      Check Annex II for further information
2. Disconnect to save changes
   1. Click on return
      
   2. Click on return
      
   3. Click on “YES”
      
   4. Click OK
      

5. Change Connectable Mode

1. Being connected, click on Global Service to expand (the current configuration is shown)
2. Select mode
   
3. Disconnect to save changes
   1. Click on return
      
   2. Click on return
      
   3. Click on “YES”
      
   4. Click OK
      

6. Configure Connectable Window

This mode is incompatible with Static Mode (Only iBKS Card Beacon). Always remains the last configured. How does it work? See Annex III

1. Being connected, click on Global Service to expand (the current configuration is shown)
   1. Enable “Connectable mode”.
   2. Enable connectable window.
   3. Set connectable period.
   4. Set connectable window.
      
2. Disconnect to save changes
   1. Click on return
      
   2. Click on return
      
   3. Click on “YES”
      
   4. Click OK
      

7. Configure Advertising Window

How does it work? See Annex IV

1. Being connected, click on Global Service to expand (the current configuration is shown)
   1. Enable “Advertising Window”.
      (if disabled, it advertises all the time)
   2. Set starting time
   3. Set ending time
      
   1. Click on return
      
   2. Click on return
      
   3. Click on “YES”
      
   4. Click OK
      

8. Lock Beacon

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

   IMPORTANT

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

9. Disable relock Beacon

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

10. Configure Static Mode (Only Card Beacon)

This mode is incompatible with connectable window. Always remains the last configured. How does it work? See Annex V

1. Being connected, click on Global Service to expand (the current configuration is shown)
2. Select mode to turn on/off
   
3. Disconnect to save changes
   1. Click on return
      
   2. Click on return
      
   3. Click on “SAVE” or “SAVE & DISCONNECT”
      
   4. Click OK
      

11. Change Password

1. Being connected, click on the menu on the top right side
   
2. In the menu, click on “Change Password”
   
3. Enter current password and the new one. Then, click on SAVE
   

   IMPORTANT

   When a new password is set the beacon automatically gets locked. In case you want to keep it unlocked, disable relock to retrieve it.

12. Change Device Name

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

13. Factory Reset

1. Being connected, click on the menu on the top right side
   

   IMPORTANT

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

   1. 1. Lock the beacon (see chapter 8)
      2. Connect to the beacon entering password
      3. Apply factory reset
2. In the menu, click on “Change Device Name”
   
3. A warning message appears. Click on YES if you agree.
   

14. Add deployment file and scan iBKS beacons

1. Click on “Deployment” tab
   
2. Click on “Add Deployment File” and select the CSV file you previously received from Accent Systems.
3. Click Scan button to start scanning iBKS beacons
   1. Click on “Scan”
      
   2. Scan a beacon
      
   3. Get iBKS beacon deployment info
      

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:

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

Register Eddystone-UID

• When checked, it registers the eddystone UID 16-byte ID in the project selected of the google platform. Register the UID allows to set attachments such as Nearby Notifications.
• If checkbox not enabled, indicates that the UID is already registered by you or another user.

Register Eddystone-UID

• When checked, it registers the eddystone UID 16-byte ID in the project selected of the google platform. Register the UID allows to set attachments such as Nearby Notifications.
• If checkbox not enabled, indicates that the UID is already registered by you or another user.

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-dev.com.mialias.net 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:

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

Register iBeacon

• When checked, it registers the iBeacon iD (UUID, Major & Minor) in the project selected of the google platform. Register the iBeacon allows to set attachments such as Nearby Notifications.
• If checkbox not enabled, indicates that the iBeacon ID is already registered by you or another user.

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.

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.

Annex V. Understanding Static Mode

The static mode is only available for iBKS Card Beacon and only works for the version PRO.

When the static mode is enabled (ON), the beacon advertises for 10 seconds when a movement is detected by the integrated accelerometer and it does not advertise when there is no movement.

When the static mode is disabled (OFF), the beacon does not take into account the accelerometer status for advertising.