Template:Beacons List: Difference between revisions

(14 intermediate revisions by 5 users not shown)

Line 1:

==Beacon List Settings before FW ver. 3.27.07.Rev.00==

This page is dedicated for explanation of ~~Bluetooth~~ settings and also Beacon parameters in [[Teltonika_Configurator_versions#For_FMB_series|'''FMB device configurator''']]. A more extensive guide can be found [[How to start with FMB devices and Beacons?|'''How to start with FMB devices and Beacons?''']].

This page is dedicated for explanation of Bluetooth® settings and also Beacon parameters in [[Teltonika_Configurator_versions#For_FMB_series|'''FMB device configurator''']]. A more extensive guide can be found [[How to start with FMB devices and Beacons?|'''How to start with FMB devices and Beacons?''']].

===Beacon Settings===

Line 9:

'''Beacon Record'''

* '''''Eventual''''' – Record is sent after scan procedure is completed. This parameter depends from the [[{{{model|FMB120}}} ~~Bluetooth~~ 4.0 settings|'''~~Bluetooth~~ 4.0 Scan Settings'''.]]

* '''''Eventual''''' – Record is sent after scan procedure is completed. This parameter depends from the [[{{{model|FMB120}}} Bluetooth® 4.0 settings|'''Bluetooth® 4.0 Scan Settings'''.]]

* '''''Periodic''''' – All beacons are sent to the server. (Record will be saved according to configured period).

Line 37:

Or by the Major/Minor for iBeacons and Namespace for Eddystone. (see the 3 and 7 elements in the list).

There is also possible to select Beacons Detection as the Configured, in this case, the beacons will only be detected and send if they were added to the Beacons List.

[[File:Beacon list UUID.jpg]]

==Beacon List Settings after FW ver. 3.27.07.Rev.00==

This page is dedicated for explanation of ~~Bluetooth~~ settings and also Beacon parameters in [[Teltonika_Configurator_versions#For_FMB_series|'''FMB device configurator''']]. A more extensive guide can be found [[How to start with FMB devices and Beacons?|'''How to start with FMB devices and Beacons?''']].

This page is dedicated for explanation of Bluetooth® settings and also Beacon parameters in [[Teltonika_Configurator_versions#For_FMB_series|'''FMB device configurator''']]. A more extensive guide can be found [[How to start with FMB devices and Beacons?|'''How to start with FMB devices and Beacons?''']].

===Beacon Settings===

[[File:NewBeaconSettings.png]]

Line 72:

Line 73:

* '''Name''' - particular parameter does not affect Beacon capturing at all. You can name particular beacon capturing line as you wish. Note that if "dot" symbol is placed prior to the name - whole line in the table is disabled and beacons will not be captured;

* '''Manufacturer ID''' - most crucial and important part of the configuration. Device will look for provided ID and capture beacons if ID matches. Manufacturer ID consists of 4 Bytes (8bits) and it is required to write in the table full ID of 4 Bytes. Of course, in some cases Manufacturer ID of some Beacons may be shorter - in such case shorter ID can be configured but do not forget to add zeroes after the ID inside configuration – otherwise configuration will not be valid. Actually any numbers could be written because ID size in found Beacon advertising packet can be configured with further parameters;

'''Note:''' Manufacturer ID can be any set of bytes from the advertisement packet but selected bytes must never change in advertised packet.

* '''Manufacturer ID Offset''' - when device finds advertising packet from a beacon, device will check for the Manufacturer ID in specific part of the packet. Particular parameter commands device from which byte in the advertised packet to look for the ID;

* '''Manufacturer ID Size''' - maximum size is 4 Bytes (''same as maximum configurable parameter in Manufacturer ID''). This parameter indicates how many bytes in found advertising packet after offsetting to check. These bytes must match ID configured in Manufacturer ID section. If bytes match - Beacon advertisement packet is captured, if bytes do not match - packet is neglected;

Line 78:

Line 80:

* '''Additional Data Offset''' and '''Additional Data Size''' - allows to capture specific data of the Beacons advertised packet e.g. battery voltage or status. These additional parameters depend on Beacon type and advertisement packet. In order to capture full packet of the Beacon - Offset can be left at 0 and Size matched by actual length of the advertised packet.

* '''Beacon ID Source'''- Beacon ID source can be selected. When Beacon ID is used, source is used as configured in Beacon ID offset and Beacon ID size columns. When Beacon MAC address is selected, Beacon ID will be replaced with MAC address. IO structure remains the same, but Beacon ID size will always be reported as 0x06.

==== EYE Beacon Capturing Configuration ====

As an example on how to set Beacons Capturing Configuration parameters EYE Beacon can be used. Protocols used can be found [[EYE BEACON / BTSID1|here]].

'''Capturing Flags and Battery voltage example:'''

[[File:Beacon_config_example_flags_and_battery.png|frameless|1143x1143px|Parameter

values]]

'''Capturing Flags example:'''

[[File:IBeacon_EYE_beacon_additional_data_Flag.PNG|frameless|1143x1143px|Parameter values]]

'''Capturing Battery voltage example:'''

[[File:IBeacon_EYE_beacon_additional_data_Battery.PNG|frameless|1143x1143px|Parameter values]]

Information shown after setting the parameters. Red rectangle indicates configured EYE Beacons additional data with Flag and Battery Voltage.

[[File:EddyStone_EYE_beacon_additional_data.PNG|left|frameless|545x545px]]

[[File:IBeacon_EYE_beacon_additional_data.PNG|center|frameless|552x552px|Eddystone

temperature]]

In the bellow picture is EddyStone and iBeacon protocol break down, according to Flag and Battery Voltage configuration in additional data. Same logic applies when configuring Flags or Battery Voltage separately

[[File:Protocol_break_down.PNG|center|frameless|1200x800px]]

==== Parsing additional data for iBeacon and EddyStone: ====

'''Example 1'''

Additional Data sent by the EddyStone protocol: '''805F'''

How to parse '''Flags''':

Flag > '''80''', Value needs to be converted to Binary > '''10000000'''

'''Note:''' only bits 6 and 7 can have value 1, on BTSID1

Bit 6 – Low Battery indication. 0 – Means device battery is from 100 to 15 % (When value changes to 1 Battery level is lower than 15 %.

Bit 7 – Battery voltage value presence. 1 Means device is reading and transmitting battery voltage value.

How to parse '''Battery Voltage''':

Battery > '''5F''' Value needs to be converted to Decimal > '''95''' to get the actual voltage this formula has to be used '''95 * 10 + 2000 = 2950 mV'''

'''Example 2'''

Additional Data sent by the iBeacon protocol: '''8063'''

How to parse '''Flags''':

Flag > '''<span

style="background-color:#fff700;">80''', Value needs to be converted to Binary > '''10000000'''

'''Note:''' only bits 6 and 7 can have value 1, on BTSID1

Bit 6 – Low Battery indication. 0 – Means device battery is from 100 to 15 % (When value changes to 1 Battery level is lower than 15 %.

Bit 7 – Battery voltage value presence. 1 Means device is reading and transmitting battery voltage value.

How to parse '''Battery Voltage''':

Battery > '''63''' Value needs to be converted to Decimal > '''99''' to get the actual voltage this formula has to be used '''99 * 10 + 2000 = 2990mV'''

==== EYE Sensor Capturing Configuration ====

As an example on how to set Beacons Capturing Configuration parameters EYE Sensor can be used. Protocols used can be found [[EYE SENSOR / BTSMP1|here]].

[[File:Beacons Capturing Configuration set.png|frameless|1143x1143px|Parameter values]]

[[File:Beacon temp marked.png|right|frameless|545x545px]]

Information shown after setting the parameters. Red rectangle indicates configured EYE sensors.

[[File:Eddystone temperature.png|left|frameless|552x552px|Eddystone temperature]]

* '''Name''' - Eddystone and iBeacon were typed to name different sensors.

*'''Manufacturer ID''' - is taken from protocol description, which can be found [[EYE SENSOR / BTSMP1#Beacon and sensors data|here]]. UUID and Type value is AAFE00 for Eddystone. CompanyID and Beacon Type are used for iBeacon which is 4C000215.

*'''Manufacturer ID Offset''' - passes 9bytes in advertising packet to indicate when Manufacturer ID starts. 5bytes for iBeacon.

*'''Manufacturer ID Size''' - number which indicates size of Manufacturer ID. 3bytes for Eddystone 4bytes for iBeacon.

*'''Beacon ID Offset''' - number used to indicate when Beacon ID starts in advertising packet.

*'''Beacon ID Size''' - number which indicates length of Beacon ID size, Instance ID is set in Eddystone and whole ID in iBeacon.

*'''Additional Data Offset''' and '''Additional Data Size''' - allows to capture specific data of the Beacons advertised packet e.g. Temperature.

*'''Beacon ID Source'''- configured ID output is shown in pictures. MAC address can be used as Source ID as well, in this case, It would be showed in ID section.

'''Note''': Due to differencies in iBeacon and Eddystone advertising packets, number of Additional Data offset is different as well.

===Beacon List===