Wiki Knowledge Base | Teltonika GPS

Changes

Advanced Beacon Capturing Configuration (view source)

Revision as of 15:14, 6 December 2023

2,976 bytes added ,  15:14, 6 December 2023
m
Text replacement - "Bluetooth®®" to "Bluetooth®"
Line 1: Line 1:  +
==Disclaimer==
 +
 +
[[File:Alert.png|left|link=]] <br> If you are not using Bluetooth®, '''please consider turning it off''' or '''change Bluetooth® PIN''' to remove potential risks.
 +
 +
If you are using Bluetooth® we strongly recommend '''using AES encryption''' for enhanced security.
 +
 +
==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?''']].<br>
 +
===Beacon Settings===
 +
 +
'''Beacon Detection'''<br>
 +
* '''''Disabled''''' – Functionality disabled.<br>
 +
* '''''All''''' – All visible beacons are detected. (Max. 100)<br>
 +
* '''''Configured''''' – Only beacons from the list are sent to server<br>
 +
 +
'''Beacon Record'''<br>
 +
* '''''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'''.]]<br>
 +
* '''''Periodic''''' – All beacons are sent to the server. (Record will be saved according to configured period).<br>
 +
 +
'''Record Period''' - Beacon record saving period:
 +
* Record Period on Move & Record Period on Stop. Timers for record generation when the device is moving and staying at the place.
 +
* Record Period on Move (Default value 60 seconds)<br>
 +
* Record Period on Stop (Default value 60 seconds)<br><br>
 +
 +
[[File:Oldbeaconsets.gif|left]]<br><br><br><br><br><br><br><br><br><br>
 +
 +
While selecting the '''Beacons Detection''' as '''All''', the device will detect all beacons which are located around the device.
 +
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.
 +
 +
===Beacon List===
 +
List of authorized beacons, Eddystone and iBeacon protocols are ''supported*.'' Example of the configured beacons detection in the List:<br>
 +
 +
[[File:BeaconCongif.mp4|1750px]]
 +
 +
''*Beacon Ids can be entered the following way: Namspace:CompanyID, UUID:Major:Minor. Any of the ID parts
 +
can be omitted ex., Namespace:. UUID::, UUID::Minor, etc''
 +
 +
The Beacons settings are configured as showed. The iBeacon or Eddystone is added to the list with the following structure:
 +
* '''''iBeacon''''' – 20 Bytes ('''UUDI''' (16-bytes : '''Major'''(2-bytes) : '''Minor''' (2-bytes))
 +
* '''''Eddystone''''' – 16 Bytes ('''Namespace''' (10-bytes) : '''Instance ID'''(6-bytes))
 +
 +
There is a possibility to detect the devices just by UUID or Namespace (see the 2 and 6 elements in the list).
 +
Or by the Major/Minor for iBeacons and Namespace for Eddystone. (see the 3 and 7 elements in the list).<br/>
 +
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.
 +
 
==Beacon List Settings after FW ver. 3.27.07.Rev.00==
 
==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===
 
===Beacon Settings===
 +
[[File:NewBeaconSettings.png]]
    
'''Beacon Detection'''
 
'''Beacon Detection'''
 
* '''''Disabled''''' – Beacon detection is disabled.
 
* '''''Disabled''''' – Beacon detection is disabled.
 
* '''''All''''' – All visible beacons are detected (Max. 100).
 
* '''''All''''' – All visible beacons are detected (Max. 100).
−
* '''''Configured''''' – device will only capture beacons by given data in Beacon list and Advanced list if enabled.
+
* '''''Configured''''' – device will only capture beacons by given data in Beacon list.
    
'''Beacon Mode'''
 
'''Beacon Mode'''
Line 19: Line 65:  
*'''''None''''' - No records will be generated  
 
*'''''None''''' - No records will be generated  
 
*'''''Low''''' - Beacon record will be generated and sent once link with the server is established
 
*'''''Low''''' - Beacon record will be generated and sent once link with the server is established
−
*'''''High''''' - Beacon record will be generated and sent immediately<br>
+
*'''''High''''' - Beacon record will be generated and sent immediately
−
 
  −
[[File:NewBeaconSettings.png]]
  −
 
  −
While selecting the '''Beacons Detection''' as '''All''', the device will detect all beacons which are located around the device.
  −
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.
      
=== Advanced Beacon Capturing Configuration ===
 
=== Advanced Beacon Capturing Configuration ===
 
Prior to capturing specific Beacon data it is mandatory to have Beacons communication protocol - advertising packet structure. Without knowing packet structure - it is impossible to configure device properly to capture important data.  
 
Prior to capturing specific Beacon data it is mandatory to have Beacons communication protocol - advertising packet structure. Without knowing packet structure - it is impossible to configure device properly to capture important data.  
   −
==== Idea of Beacon Capturing Configuration ====
   
Functionality allows to capture advertising packet of any kind of Beacon which broadcasts its information automatically. Beacon Capturing Configuration list also can be called as the set of rules to capture and transfer Beacon data. Advanced mode main purpose is to capture additional or only specific data (''by Manufacturers ID'') according to configured Offsets and Data sizes.
 
Functionality allows to capture advertising packet of any kind of Beacon which broadcasts its information automatically. Beacon Capturing Configuration list also can be called as the set of rules to capture and transfer Beacon data. Advanced mode main purpose is to capture additional or only specific data (''by Manufacturers ID'') according to configured Offsets and Data sizes.
   Line 35: Line 75:  
[[File:BeaconMode.gif|right]]
 
[[File:BeaconMode.gif|right]]
 
In advanced mode device can detect any Beacon type, the device can be configured to capture data from Universal beacons as seen in the configured in table (The fields in the Beacons Capturing Configuration will be empty), for example this configuration is set to detect iBeacon and EddyStone Beacons, also with additional data(in this case whole packet).
 
In advanced mode device can detect any Beacon type, the device can be configured to capture data from Universal beacons as seen in the configured in table (The fields in the Beacons Capturing Configuration will be empty), for example this configuration is set to detect iBeacon and EddyStone Beacons, also with additional data(in this case whole packet).
−
 
+
[[File:Beaconsss.png|thumb|1154x1154px]]
 
* '''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;
 
* '''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;
 
* '''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;
Line 45: Line 85:  
* '''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.
 
* '''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.
   −
<br>
+
==== EYE Sensor Capturing Configuration ====
−
<br>
+
As an example on how to set Beacons Capturing Configuration parameters EYE Sensor can be used. Protocols used can be found [[EYE SENSOR / BTSMP1#Beacon and sensors data|here]](link).
−
[[Image:Universal Beacons.png]]
+
[[File:Beacons Capturing Configuration set.png|thumb|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]]
 +
<br></br>
 +
<br></br>
 +
<br></br>
 +
<br></br>
 +
<br></br>
 +
 
 +
 
 +
 
   −
When Advanced mode is selected - Beacon data arrives through AVL ID 548 (''Beacon list and Advanced list'' ''are not separated''). In Simple mode data arrives by AVL ID 385. Codec 8 Extended is mandatory for both Beacon capturing modes.
  −
==== Difference between On change and Periodic parameters when using Advanced Beacon Mode: ====
  −
As it is known that Advanced Beacon mode is capturing Beacons by the Manufacturer ID - "On change" mode in some scenarios can be a better option than Periodic. For example in asset tracking scenario – beacons do not leave the range of FMB BLE scan, meaning that device will not constantly send visible beacons to the server but only will report if one beacon goes missing or new (same type) beacon occurs. This allows to save a lot of data and be sure when asset is gone and has returned back. More technical example while "On change" mode is active - device will capture the first seen beacon by e.g. "E1FFA108" ID and if second beacon with '''same''' manufacturer ID approaches FMB device - it will be registered as well, just by different ID or MAC address. Also, in current situation if first beacon leaves the range of FMB but the second with same manufacturer ID stays in the range - device will make a report that one has left the area. Device strictly checks beacons by the manufacturer ID in the Advanced Beacon list. "Periodic" beacon mode would be constantly by configured parameters reporting to the server of visible beacons, regardless if they appear or disappear from the FMB device.
      +
* '''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. E.g. Instance ID is set in Eddystone and whole ID(UUID, Major, Minor) 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===
 
===Beacon List===
Line 262: Line 319:  
|-
 
|-
 
|}
 
|}
 +
 +
 +
[[Category: Frequently Asked Questions - FAQ]]
Retrieved from "https://wiki.teltonika-gps.com/view/Special:MobileDiff/69593...93481"