Jump to content

EYE SENSOR / BTSMP1: Difference between revisions

m
Reverted edits by Martynas.juozaitis (talk) to last revision by Gabrielius Gaušys
No edit summary
m (Reverted edits by Martynas.juozaitis (talk) to last revision by Gabrielius Gaušys)
Tag: Rollback
Line 653: Line 653:


<br>
<br>
[[File:BLE 4,0 Common settings.png]]
[[File:Configurator GUI changes.png]]
<br>
<br>
<br>
<br>
'''Sensors'''
'''EYE Sensor'''
<br>
<br>
Sensor Configuration can be set to Custom Sensors, Eye Sensors or both.
With the Custom Sensors setting enabled, [https://wiki.teltonika-gps.com/view/FMB130_Bluetooth_4.0_settings#Advanced_Mode| any BLE sensor can be configured.]<br>
When '''EYE Sensors''' is selected, Eye Sensor connectionless functionalities or EYE list search window will appear, depending on the selected EYE Sensor filter.
<br>
<br>
[[File:EYE Sensors NAME.png]]
'''EYE Sensor''' functionality allows to configure MAC addresses for 4 sensors that user wants to read
<br>'''Name''' <br>
When EYE Sensors Filter is set to '''Name''', the Eye List search window will appear on the configurator. With this setting, separate EYE Sensor records (AVL ID: 11317) will be generated according to the configured parameters, which are described below:
<br>
<br>
*'''Data Clear period'''- defines how long the FM tracker waits when the Eye sensor is not detected before removing it from the Eye Sensor list and not sending the sensor values. If Data Clear Period is set to 0, then the EYE Sensor will not be removed from the EYE Sensor list and it will always be included in the periodic records.<br>
'''Data clear period''' - if value equal or higher than 1, it will clear sensors BLE IO elements values if they were not updated for configurated amount of time.
 
*'''RSSI'''- Parameter defines the dBm threshold value of when the EYE sensor will be added to the sensor list. If the FM tracker detects the RSSI lower than the configured value, it will not be added to the EYE Sensor list. <br>
 
*'''Record period''' - Defines how often the EYE Sensor record (AVL ID: 11317) will be generated when the FM tracker is operating On Stop or On Move modes, according to the configured [https://wiki.teltonika-gps.com/view/FMB140_System_settings#Movement_Source| movement source.].<br>
 
*'''EYE Sensor Settings''' - Define what sensor readings data is included in to the EYE Sensor Records. Sensor readings which are not needed can be disabled, to reduce data consumption.<br>
*'''EYE Name list''' - Defines what EYE sensors will be added to EYE Sensor list. For EYE Sensors to be added to the list, only the beginning part of the EYE Sensor local name has to match. For example, if in the EYE name list “EYE_SENSOR” is added and the FM tracker detects EYE_SENSOR1, EYE_SENSOR2, EYE_SENSORXYZ, all these EYE Sensors will be added to EYE Sensor list. If the EYE name list is left empty, all the detected EYE Sensors will be included in the EYE Sensor list. '''NOTE:''' If EYE Sensor has a name that matches configured one in EYE Name List and if it has a MAC address, that matches configured one in EYE Sensors filtered by MAC address, then such sensor will not be added to EYE Sensor list, but it’s data will be added according EYE Sensor filtered by MAC IO elements.<br>
[[File:EYE List name search.png]]
<br>
<br>
[[File:Sensor 1 EYE.png]]
<br>
<br>
Once Eye Sensor filtering by name list is selected, EYE Sensor records containing the AVL ID:11317 will start being generated. Below is an example of how EYE Sensor data is packed into AVL ID 11317 <br>
<br>'''I/O elements'''
'''AVL ID 11317 structure''' <br>
<br>Starting with firmware 03.27.10.Rev.323 there is additional tabs available in Bluetooth 4.0 section that allow for easier configuration to connect FM and EYE sensor or beacon. <br>'''Note:''' If you are using presets(firmware/configurator without EYE product support), then refer to [[FMB130 Teltonika Data Sending Parameters ID#BLE%20Sensors%20I.2FO%20elements|BLE Sensors I/O elements]] table instead.
{| class="wikitable"
|+
! colspan="2" |Eye Sensor #1 Data
|-
|1st Parameter ID
|1 byte
|-
|1st Parameter Data Length
|1 byte
|-
|1st Parameter Data
|variable
|-
|2nd Parameter ID
|1 byte
|-
|2nd Parameter Data Length
|1 byte
|-
|2nd Parameter Data
|variable
|-
|Nth Parameter ID
|1 byte
|-
|Nth Parameter Data Length
|1 byte
|-
|Nth Parameter  Data
|variable
|-
! colspan="2" |Eye Sensor #2 Data
|-
|1st Parameter ID
|1 byte
|-
|1st Parameter Data Length
|1 byte
|-
|1st Parameter Data
|variable
|-
|2nd Parameter ID
|1 byte
|-
|2nd Parameter Data Length
|1 byte
|-
|2nd Parameter Data
|variable
|-
|Nth Parameter ID
|1 byte
|-
|Nth Parameter Data Length
|1 byte
|-
|Nth Parameter  Data
|variable
|-
! colspan="2" |Eye Sensor #N Data
|-
!...
!...
|}
 
Parameter IDs are used to identify what type of EYE Sensor information is included AVL ID 11317. Below is the table describing the possible EYE Sensor parameter IDs, along with their data type and data length. <br> <br>
{| class="wikitable nd-othertables_2" style="width:125%;" ;
|+'''Table 1. EYE SENSOR PARAMETER IDS'''
|-
!Parameter ID!!Name
!Data type!!Description!!
|-
| -||1
|1 byte unsigned integer||Reserved. Added To each Eye Sensor start. Currently always 0.
|-
|5||Eye Sensor #1 Device Name
|Array||Device’s name from Device Name List tab
|-
|6
|EYE Sensor #1 Temperature
|2 byte signed integer
|Temperature value measured by EYE Sensor from List Values from -32768 to +32768 with 0.01 C delta
|-
|7
|EYE Sensor #1 Humidity
|1 byte unsigned integer
|Humidity measured by EYE Sensor from List Values from 0 to 100%
|-
|8
|EYE Sensor #1 Magnet
|1 byte unsigned integer
|Magnet measured by EYE Sensor from List Values from 0 to1
|-
|9
|EYE Sensor #1 Magnet Trigger Count
|2 byte unsigned integer
|Magnetic sensor trigger counts measured by EYE Sensor from List Values
|-
|10
|EYE Sensor #1 Movement
|1 byte unsigned integer
|Movement measured by EYE Sensor from List Values
|-
|11
|EYE Sensor #1 Movement count
|2 byte unsigned integer
|Movement counts measured by EYE Sensor from List Values
|-
|12
|EYE Sensor #1 Angle Pitch
|1 byte unsigned integer
|Pitch Angle measured by EYE Sensor from List Values from
|-
|13
|EYE Sensor #1 Angle Roll
|2 byte unsigned integer
|Roll Angle measured by EYE Sensor from List Values from
|-
|14
|EYE Sensor #1 Low Battery State
|1 byte unsigned integer
|Low battery state measured by EYE Sensor from List Values from 0 to1
|-
|15
|EYE Sensor #1 Battery Voltage
|2 byte unsigned integer
|Battery voltage measured by EYE Sensor from Lis
|}


 
Table below describes I/O elements which were added for EYE sensor and proximity functionalities.
<br>
<br>
[[File:EYE Sensors MAC.png]]
<br>
'''MAC''' <br>
IF EYE Sensors are selected to be filtered by '''MAC address''', separate EYE sensor records will not be generated; EYE sensor values will be included into regular records with their corresponding IO elements. Up to 4 EYE Sensors can be configured with different MAC Addresses.
In the case of filtering by MAC Address, more advanced configuration is possible, as EYE Sensors’ IOs’ Low, High level, Event Only and Operand parameters can also be configured separately for each IO.  <br>
*'''Working Mode''' - parameter has 2 options – Disabled and EYE Sensor. When it is disabled, EYE Sensor IO values will not be included into the records. When EYE Sensor is selected, EYE Sensor IO values will be included into records. <br>
*'''MAC Settings''' - parameter specifies the MAC address of the EYE Sensor for the FM tracker to read, parse its data and put to corresponding IO elements. If the sensor is not found for set amount of scan retries, error values will be stored into IO elements. <br>
*'''I/O elements''' - allows for advanced EYE sensor [https://wiki.teltonika-gps.com/view/FMB130_I/O_settings I/O elements configuration].
[[File:Eye Sensor Connectionless Functionalities.png]]
<br>
<br>
'''EYE Sensor AVL IDs''' <br>
Table below describes I/O elements which were added for EYE sensor with the new functionalities release.


<br><table class="nd-othertables_2" style="width: 100%;">
<br><table class="nd-othertables_2" style="width: 100%;">
Line 838: Line 682:
         <th style="width: 25%; text-align:center; vertical-align:middle;">Description</th>
         <th style="width: 25%; text-align:center; vertical-align:middle;">Description</th>
     </tr>
     </tr>
<tr>
        <td style="width: 10%; text-align:center; vertical-align:middle;">11317</td>
        <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Sensor List</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">variable length</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">HEX</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">0 bytes</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">1024 bytes</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 25%; text-align:center; vertical-align:middle;">EYE Sensor List</td>
         <tr>
         <tr>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10800</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10800</td>
Line 1,148: Line 982:
         <td style="width: 25%; text-align:center; vertical-align:middle;">Battery Voltage of EYE sensor 4</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">Battery Voltage of EYE sensor 4</td>
     </tr>
     </tr>
    <tr>
         <tr>
        <td style="width: 10%; text-align:center; vertical-align:middle;">10832</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10828</td>
        <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Roll 1</td>
         <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Proximity Near</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">2</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">1024</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">signed</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">HEX</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">-180</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">180</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 25%; text-align:center; vertical-align:middle;">Roll value of EYE Sensor 1</td>
    </tr>
<tr>
        <td style="width: 10%; text-align:center; vertical-align:middle;">10833</td>
        <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Roll 2</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">2</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">signed</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">-180</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">180</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 25%; text-align:center; vertical-align:middle;">Roll value of EYE Sensor 2</td>
    </tr>
<tr>
        <td style="width: 10%; text-align:center; vertical-align:middle;">10834</td>
        <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Roll 3</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">2</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">signed</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">-180</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">180</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 25%; text-align:center; vertical-align:middle;">Roll value of EYE Sensor 3</td>
    </tr>
<tr>
        <td style="width: 10%; text-align:center; vertical-align:middle;">10835</td>
        <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Roll 4</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">2</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">signed</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">-180</td>
        <td style="width: 10%; text-align:center; vertical-align:middle;">180</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
        <td style="width: 25%; text-align:center; vertical-align:middle;">Roll value of EYE Sensor 4</td>
    </tr>
<tr>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10836</td>
         <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Movement Count 1</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">2</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">unsigned</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">0</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">0</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">65535</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">1024</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">Movement count value of EYE Sensor 1</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">Beacon list in Near Proximity zone</td>
     </tr>
     </tr>
<tr>
        <tr>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10837</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10829</td>
         <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Movement Count 2</td>
         <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Proximity Away</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">2</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">1024</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">unsigned</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">HEX</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">0</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">0</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">65535</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">1024</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">Movement count value of EYE Sensor 2</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">Beacon list in Away Proximity zone</td>
     </tr>
     </tr>
<tr>
        <tr>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10838</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10830</td>
         <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Movement Count 3</td>
         <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Proximity Far Away</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">2</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">1024</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">unsigned</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">HEX</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">0</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">0</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">65535</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">1024</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">Movement count value of EYE Sensor 3</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">Beacon list in Away Far zone</td>
     </tr>
     </tr>
<tr>
        <tr>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10839</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">10831</td>
         <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Movement Count 4</td>
         <td style="width: 20%; text-align:center; vertical-align:middle;">EYE Proximity Lost</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">2</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">1024</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">unsigned</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">HEX</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">0</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">0</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">65535</td>
         <td style="width: 10%; text-align:center; vertical-align:middle;">1024</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 5%; text-align:center; vertical-align:middle;">-</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">Movement count value of EYE Sensor 4</td>
         <td style="width: 25%; text-align:center; vertical-align:middle;">List of Beacon which were lost from proximity zones</td>
     </tr>
     </tr>


</table>
</table>
<br>'''Note:''' If you are using presets(firmware/configurator without EYE product support), then refer to [[FMB130 Teltonika Data Sending Parameters ID#BLE%20Sensors%20I.2FO%20elements|BLE Sensors I/O elements]] table instead.


==<p style="font-size:32px"><span style="color:#0054A6">EYE Sensor Protocol overview</span></p>==
==<p style="font-size:32px"><span style="color:#0054A6">EYE Sensor Protocol overview</span></p>==