Changes

EYE BEACON / BTSID1 (view source)

Revision as of 08:53, 26 September 2022

11,157 bytes added ,  08:53, 26 September 2022
no edit summary
Line 198: Line 198:  
'''Bluetooth 4.0'''
 
'''Bluetooth 4.0'''
 
<br>
 
<br>
−
Functionalities were reorganized and transferred to Bluetooth 4.0 configuration tab with additional horizontal tabs selection for specific settings:
  −
<br>
  −
* '''Global''' - Parameters responsible for device scanning ability like power and duratations.
  −
* '''Beacon''' - Parameters to enable Beacon scanning scenarios.
   
<br>
 
<br>
 
'''Common settings'''
 
'''Common settings'''
Line 213: Line 209:  
* ''' BLE connection control''' - Connection mode settings. If broadcasting ID is configured, parameter should be set to Prohibit.
 
* ''' BLE connection control''' - Connection mode settings. If broadcasting ID is configured, parameter should be set to Prohibit.
 
<br>
 
<br>
−
[[File:Configurator GUI changes.png]]
+
[[File:BLE_4.0.png]]
 
<br>
 
<br>
 
<br>
 
<br>
 
'''Beacons'''
 
'''Beacons'''
 +
<br>
 
<br>
 
<br>
 
Beacons configuration instruction: [https://wiki.teltonika-gps.com/view/How_to_start_with_FMB_devices_and_Beacons%3F How to start with FMB devices and Beacons?]
 
Beacons configuration instruction: [https://wiki.teltonika-gps.com/view/How_to_start_with_FMB_devices_and_Beacons%3F How to start with FMB devices and Beacons?]
 
<br>
 
<br>
 
<br>
 
<br>
−
[[File:EYE Beacons configurator.png]]
+
[[File:Beacon settings.png]]
 
<br>
 
<br>
 
<br>
 
<br>
−
'''Beacon detection''' - Parameter controls over all Beacons scanning: [[File:Beacon detection configurator.png|right|border]]
+
[[File:Beacon all settings.png|right|border]]
 +
'''Beacon detection''' - Parameter controls over all Beacons scanning:  
 
* '''Disabled''' – Beacon scanning and transmitting disabled.
 
* '''Disabled''' – Beacon scanning and transmitting disabled.
 
* '''All''' – Read all visible beacons;
 
* '''All''' – Read all visible beacons;
 
* '''Configured''' – Read only beacons set in Beacon List;
 
* '''Configured''' – Read only beacons set in Beacon List;
−
* '''Teltonika MAC''' – Filter and transmit only Teltonika EYE packets*.
+
'''Beacon Mode'''  
−
    *It allows to filter only MAC addresses which will be assigned to BTSX device. The MAC address that is currently filtered by this parameter is 7C:D9:F4:0X:XX:XX.
+
* '''Simple''' - beacon parsing is done automatically (Eddystone and iBeacon protocols are supported).  
−
<br>
+
* '''Advanced''' - beacon data capturing can be configured.<br>
−
<br>
+
'''Beacon record'''  
−
'''Beacon record''' [[File:Beacon record on change.png|right|border]]
  −
'''Eventual''' settings have two modes:
  −
* '''Monitoring''' - Beacon record generating every scan period
   
* '''On change''' - Beacon records are generated only when there are changes in scanned list.
 
* '''On change''' - Beacon records are generated only when there are changes in scanned list.
−
'''Periodic''' - records are generated according to Period settings. When there is no visible beacons, empty record will be generated.
+
* '''Periodic''' - Beacon record generating according to the configured Record Period on Move and Record Period on Stop parameters.
 +
*'''Beacon Record Priority''' - When set to '''None''' Records will not be generated. '''Low priority''' means the Module makes an additional record which will be sent according to configured send period. When '''High Priority''' is configured, the Beacon record will be sent immediately to the server as soon as it is generated.<br>
 
<br>
 
<br>
 +
'''EYE Beacon Settings'''
 
<br>
 
<br>
−
'''Beacon Mode''' [[File:Beacon Mode SImple.png|right|border]]
  −
* '''Simple''' - beacon parsing is done automatically (Eddystone and iBeacon protocols are supported).
  −
* '''Advanced''' - beacon data capturing can be configured.
   
<br>
 
<br>
 +
[[File:Beacon detection.gif]]
 
<br>
 
<br>
−
'''Filter type''' [[File:Filter Type.png|right|border]]
+
*The New firmware has two Beacon lists, so it is possible to create two separate lists of beacons, standard one with Beacons ID (UUID:Major:Minor, or Namespace:InstanceID) and new one according Beacon Name (by name or prefix, for example all beacons with prefix "ID1" can be saved.)
−
New firmware has two Beacon lists, so it is possible to create two separate lists of beacons, standard one with Beacons ID (UUID:Major:Minor, or Namespace:InstanceID) and new one according Beacon Name (by name or prefix, for example all beacons with prefix "ID1" can be saved.
   
<br>
 
<br>
−
* '''Beacon ID''' - configurator allows to configure beacon id in iBeacon or Eddystone format.
+
* '''Beacon ID''' - configurator allows to configure beacon ID in iBeacon or Eddystone format in Beacon List.
−
* '''Beacon Name''' - user can enter names of beacons which needs to be filtered. It would filter the full name or only if the prefix of the name is configured like “BTS”.
+
* '''Beacon Name''' - The names of beacons which need to be filtered can be entered. Only the beginning part of the EYE Beacon local name has to match. For example, if in the EYE Beacon name list “EYE_Beacon” is added and the FM tracker detects EYE_Beacon1, EYE_Beacon2, EYE_BeaconXYZ, all these EYE Beacons will be added to EYE Beacon name list.
 +
Both ID and Name filters can work at the same time. If beacon doesn’t match ID filter, but matches the name, it will be added to beacon list. However, Filtering only works Beacon Mode is set to Simple.
 
<br>
 
<br>
−
Both ID and Name filters can work at the same time. If beacon doesn’t match ID filter, but matches the name, it will be added to beacon list. Filtering only works Beacon Mode is set to Simple.
+
<br>  [[File:Eye Beacon Prox.png|right|border]]
 
<br>
 
<br>
−
<br>
+
'''Eye feature mode: Proximity'''
−
'''Proximity''' [[File:Proximity.png|right|border]]
+
 
−
<br>
+
EYE beacon Proximity events is a functionality which creates three different types of records, depending on the captured Beacons RSSI level. This functionality is only supported with Teltonika EYE beacons.<br> Proximity events consist of near, away and lost events: <br>
−
'''Proximity Events''' allow to configure 3 different zones: Near, Away, Far Away. There is additional Lost parameter for beacons which were lost from any of the 3 zones. Averaging timeout determines period how often results are evaluated to avoid fake event detection. Periodic option will generate records at known interval while On Change option will generate record when beacon enters/exits certain zone.
+
*When EYE beacon RSSI level is below the first configured threshold, the beacon will be added to Near Beacon Record '''(AVL ID: 10828)'''
−
<br>
+
*When EYE BEACON RSSI level is between the second and first configured threshold, beacon is added to Away Beacon record '''(AVL ID: 10829)'''
−
<br>
+
*When EYE Beacon RSSI level is lower than the second configured threshold, beacon is added to Lost Beacon record '''(AVL ID: 10831)'''. In the case of EYE Beacon disappearing from the environment and not being detected by the FM tracker anymore, the beacon will be added to Lost Beacon record and will be removed from Beacon list.
−
'''Proximity IO''' elements have the following structure [[File:1st beacon protocol version.png|bottom|border]]
+
 
 +
'''Event modes''' <br>
 +
*Disabled – Record generating is disabled for the selected range
 +
*Periodic – Records will be periodically generated for the selected range, according to the configured record period on move or on stop value.
 +
*On Change – Records will be generated as soon as the Eye Beacon number changes for the selected range.
 +
 
 +
'''Averaging Timeout''' <br>
 +
This parameter specifies how long it will take current RSSI value to reach new RSSI value. For example, current EYE Beacon RSSI value is -40 dBm. FMB captures same EYE Beacon with RSSI value of -60 dBm. If averaging timeout is configured to be 10 seconds, it will take 10 seconds for RSSI value to reach -60 dBm from -40 dBm. Keep in mind that this is assuming perfect conditions and subsequent EYE Beacon RSSI
 +
 
 +
'''Eye feature mode: Lost & Found '''<br>
 +
[[File:Lost & found.png]]
 +
 
 +
'''Lost & Found  EYE Beacon feature.'''<br>
 +
Purpose of this functionality is to '''periodically''' generate records with all EYE Beacon list (AVL ID: 10828) and create eventual '''On Change''' records only when EYE Beacon is lost (AVL ID: 10831) or found (AVL ID: 10829). <br>
 +
Lost and Found Beacon records only include EYE Beacon which was lost or found, not the full Beacon list. <br>
 +
*If multiple EYE Beacons were found or lost at the same time, multiple will be  included into the record. <br>
 +
*If Visible Beacon List is enabled, Beacon records containing the list of visible beacons will be generated according to the configured period parameters ''Record Period on Move'' and ''Record Period on Stop''
 +
Advanced Beacon protocol is being used to send Lost & Found records.  <br>
 +
Note:Same AVL ID’s as for Proximity events are being used, since two features cannot work at the same time.
 +
 
 +
*'''AVL ID: 10828''' Visible Beacon List (periodic)
 +
*'''AVL ID: 10829''' Found Beacon List (On Change)
 +
*'''AVL ID: 10831''' Lost Eye Beacon List (On Change)
 +
 +
 
 +
'''Proximity and Lost & found AVL ID''' elements have the following structure:<br> [[File:1st beacon protocol version.png|border]]
 +
 
 +
When Proximity or Lost & Found events are sent, the records will always include Beacon RSSI, Beacon ID, low battery indicator and Battery Voltage.
 +
 
 +
Below is the mentioned Parameters description:
 +
{| class="wikitable nd-othertables_2" style="width:125%;" ;
 +
|+'''Table 1. EYE Beacon Parameter IDs'''
 +
|-
 +
!Parameter ID!!Name
 +
!Data type!!Description
 +
|-
 +
| 0||Beacon RSSI Level
 +
|1 byte unsigned integer||Received signal strength indication (RSSI) value in dBm.
 +
Hex value must be converted to decimal from signed 2s complement.
 +
|-
 +
|1||Beacon ID
 +
|Array||For Eye Beacons that are transmitting using Eddystone protocol Beacon ID is Namespace , InstanceID (16 bytes),
 +
For iBeacon protocol it is UUID, Major, Minor (20 bytes)
 +
|-
 +
|13
 +
|EYE Beacon Low battery indicator
 +
|1 byte integer
 +
|Low battery state measured by EYE beacon; value is either 0 (low voltage not detected) or 1 (low voltage detected)
 +
|-
 +
|14
 +
|EYE Beacon battery Voltage
 +
|2 byte unsigned integer
 +
|EYE Beacon battery voltage value in mV
 +
|-
 +
|}
    
==<p style="font-size:32px><span style="color:#0054A6">EYE Beacon Protocol overview</span></p>==
 
==<p style="font-size:32px><span style="color:#0054A6">EYE Beacon Protocol overview</span></p>==
Line 644: Line 693:  
| -
 
| -
 
|}
 
|}
 +
 +
 +
 +
 +
==== lost & found FM Packet parsing with the new firmware ====
 +
===<p style="font-size:24px><span style="color:#0054A6">FM EYE Beacon lost & found record parsing example with the new firmware  (not released yet)</span>===
 +
'''Parsing EYE Sensor records example''' <br>
 +
Below You will find an example on how to parse lost (AVL ID 10831) or found (AVL ID 10829) EYE Beacon record.
 +
 +
{| class="nd-othertables_2" style="width:100%;"
 +
|+
 +
! colspan="3" style="border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |Unparsed data
 +
|-
 +
| style="vertical-align: middle; text-align: center;"| Received data in hexadecimal stream: <code>000000000000004b8e010000018368952793000f0e54fc209ab05800b300b40e0000<br>
 +
2a4f000100000000000000000001</code><span style="background-color:#91d4b9;">2a4f001e011c0001a40110eb47706aa38255aa96f21a154e2d00550d01000e020bd6</code><code>010000823f</code>
 +
|}
 +
 +
{| class="nd-othertables_2" style="width:100%;"
 +
|+
 +
 +
! colspan="3" style="border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |AVL Data Packet
 +
|-
 +
! colspan="2" rowspan="1" style="width:60%; vertical-align: middle; text-align: center;" |AVL Data Packet Part
 +
! rowspan="1" style="width:40%; vertical-align: middle; text-align: center;" |HEX Code Part
 +
|-
 +
| rowspan="4" style="vertical-align: middle; text-align: center;" |
 +
| style="vertical-align: middle; text-align: center;" |Zero Bytes
 +
| style="vertical-align: middle; text-align: center;" |00 00 00 00
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Data Field Length
 +
| style="vertical-align: middle; text-align: center;" |00 00 00 4b
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Codec ID
 +
| style="vertical-align: middle; text-align: center;" |8E (Codec8 Extended)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Number of Data 1 (Number of Total Records)
 +
| style="vertical-align: middle; text-align: center;" |01
 +
|-
 +
| rowspan="24" style="vertical-align: middle; text-align: center;" |AVL Data
 +
| style="vertical-align: middle; text-align: center;" |Timestamp
 +
| style="vertical-align: middle; text-align: center;" |00 00 01 83 68 95 27 93 (GMT: Tuesday, 18 June 2019 08:25:22.001)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Priority
 +
| style="vertical-align: middle; text-align: center;" |00
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Longitude
 +
| style="vertical-align: middle; text-align: center;" |0f 0e 54 fc
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Latitude
 +
| style="vertical-align: middle; text-align: center;" |20 9a b0 58
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Altitude
 +
| style="vertical-align: middle; text-align: center;" |00 b3
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Angle
 +
| style="vertical-align: middle; text-align: center;" |00 b4
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Satellites
 +
| style="vertical-align: middle; text-align: center;" |0e
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Speed
 +
| style="vertical-align: middle; text-align: center;" |00 00
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Event IO ID
 +
| style="vertical-align: middle; text-align: center;" |2a 4f (10831)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |N of Total ID
 +
| style="vertical-align: middle; text-align: center;" |00 01
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |N1 of One Byte IO
 +
| style="vertical-align: middle; text-align: center;" |00 00
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |N2 of Two Bytes IO
 +
| style="vertical-align: middle; text-align: center;" |00 00
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO
 +
| style="vertical-align: middle; text-align: center;" |00 00
 +
|-
 +
 +
| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO
 +
| style="vertical-align: middle; text-align: center;" |00 00
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |NX of X Bytes IO
 +
| style="vertical-align: middle; text-align: center;" |00 01
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |N’th IO ID - AVL ID.
 +
| style="vertical-align: middle; text-align: center;" |2a 4f (10831)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Length of Variable Length IO
 +
| style="vertical-align: middle; text-align: center;" |00 1e (30 bytes)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Value of Variable Length IO 10831
 +
| style="vertical-align: middle; text-align: center;" |
 +
'''011c0001a40110eb47706aa38255aa96f21a154e2d00550d01000e020bd6'''
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Number of Data 2 (Number of Total Records)
 +
| style="vertical-align: middle; text-align: center;" |01
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |CRC-16
 +
| style="vertical-align: middle; text-align: center;" |00 01 2a 4f
 +
|-
 +
|}
 +
 +
==== Parsing AVL ID 10831 data ====
 +
 +
{| class="nd-othertables_2" style="width:100%;"
 +
|+
 +
! colspan="3" style="border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |AVL ID 10831 Unparsed data
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |<code>'''011c0001a40110eb47706aa38255aa96f21a154e2d00550d01000e020bd6'''</code>'''<br>
 +
|}
 +
 +
{| class="nd-othertables_2" style="width:100%;"
 +
|+
 +
 +
! colspan="3" style="border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |Parsing the data
 +
|-
 +
! colspan="2" rowspan="1" style="width:60%; vertical-align: middle; text-align: center;" |AVL Data packet part
 +
! rowspan="1" style="width:40%; vertical-align: middle; text-align: center;" |HEX Code Part
 +
|-
 +
| rowspan="3" |
 +
| style="vertical-align: middle; text-align: center;" |Constant
 +
| style="vertical-align: middle; text-align: center;" |01
 +
|-
 +
! style="vertical-align: middle; text-align: center;" |Eye Beacon #1 data length
 +
| style="vertical-align: middle; text-align: center;" |1c (28 bytes)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter ID
 +
| style="vertical-align: middle; text-align: center;" |00 (Eye Beacon RSSI)
 +
|-
 +
| rowspan="60" style="vertical-align: middle; text-align: center;" |AVL Data
 +
| style="vertical-align: middle; text-align: center;" |Parameter data length
 +
| style="vertical-align: middle; text-align: center;" |01 (1 byte)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter data
 +
| style="vertical-align: middle; text-align: center;" |a4 (Converted to Decimal from signed 2s complement = -92dBm)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter ID
 +
| style="vertical-align: middle; text-align: center;" |01 (Beacon ID)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter data length
 +
| style="vertical-align: middle; text-align: center;" |10 (16 bytes)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter data
 +
| style="vertical-align: middle; text-align: center;" |eb 47 70 6a a3 82 55 aa 96 f2 '''1a 15 4e 2d 00 55''' (Eddystone Namespace + '''Instance ID''')
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter ID
 +
| style="vertical-align: middle; text-align: center;" |0d (parameter ID #13 low battery voltage indicator)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter data length
 +
| style="vertical-align: middle; text-align: center;" |01 (1 byte)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter data
 +
| style="vertical-align: middle; text-align: center;" |00 (no low battery voltage detected)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter ID
 +
| style="vertical-align: middle; text-align: center;" |0e (Eye Beacon Battery voltage)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter data length
 +
| style="vertical-align: middle; text-align: center;" |02 (2 bytes)
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |Parameter Data
 +
| style="vertical-align: middle; text-align: center;" |0b d6 (3030mV)
 +
|-
 +
|}
 +
NOTE: The record structure for Lost Beacon Record (AVL ID:10829) is the same
    
==<p style="font-size:32px><span style="color:#0054A6">Safety information</span></p>==
 
==<p style="font-size:32px><span style="color:#0054A6">Safety information</span></p>==
Retrieved from "https://wiki.teltonika-gps.com/view/Special:MobileDiff/76321"

Navigation menu