Difference between revisions of "Template:FMX640 Short Burst Data"

From Wiki Knowledge Base | Teltonika GPS
m
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
===Introduction===
 
===Introduction===
−
Since 00.02.05 firmware version device supports Iridium devices - TSM-232 and Iridium Edge which can send ''short burst data'' (SBD) to the server. This means some data can be sent from the FM device to the server through satellites. From firmware version - '''01.02.22.Rev.02''', {{{device|}}} support for '''Iridium Edge''' is added. Iridium Edge features an all-in-one SBD module and antenna, with a power supply. The plug-and-play satellite IoT terminal can be easily paired with {{{device|}}} device in order to expand its functionality to no GSM coverage zones.
+
Since 00.02.05 firmware version device supports Iridium devices which can send ''short burst data'' (SBD) to the server. This means that some data can be sent from the FM device to the server through satellites. From firmware version - '''01.02.22.Rev.02''', {{{device|}}} support for '''Iridium Edge''' is added. Iridium Edge features an all-in-one SBD module and antenna, with power supply. The plug-and-play satellite IoT terminal can be easily paired with {{{device|}}} device in order to expand their functionality to no GSM coverage zones.
−
Current Iridium implementation offers the ability to generate and send SBD records after a set period after the GSM signal is lost. This ensures constant connectivity as the Iridium network is available globally.
+
Current Iridium implementation offers ability to generate and send SBD records after set period after the GSM signal is lost. This ensures constant connectivity as Iridium network is available globally.
  
 
===Connecting Iridium device to {{{device|}}}===
 
===Connecting Iridium device to {{{device|}}}===
−
In order to properly connect the Iridium device to {{{device|}}}, Iridium has to be connected to the device via RS-232 - COM1 or COM2 (with RJ-45 connector, where 4 pin is GND, 5 pin is RS232 Rx and 6 PIN is RS232 Tx). Additionally '''Pin No. 6''' - power control (reference in the image below) must be connected to one of the {{{device|}}} DOUTs (1/2/3/4), in order to allow the device to power ON/OFF Iridium device on demand.
+
In order to properly connect Iridium device to {{{device|}}}, Iridium has to be connect to the device via RS-232 - COM1 or COM2. Additionally '''Pin No. 6''' - power control (reference in image below) must to be connected to one of the {{{device|}}} DOUTs (1/2/3/4), in order to allow device to power ON/OFF Iridium device on demand.
  
−
Iridium Edge pinout and RS232 COM 1/2 connection:  
+
Iridium Edge pinout:  
  
 
[[File:Iridium Edge pinout.png|left]]
 
[[File:Iridium Edge pinout.png|left]]
−
[[File:FMX640 and RS232 illustration v1.2.png|right|906x401px]]
 
  
−
 
+
{| class="wikitable"  
−
{| class="nd-othertables_2" style="width:100%;"  
 
 
|- style="font-weight:bold; text-align:center;"
 
|- style="font-weight:bold; text-align:center;"
 
! <br />Pin. No
 
! <br />Pin. No
Line 55: Line 53:
 
|-
 
|-
 
| <br />8
 
| <br />8
−
| <br />Power Detection
+
| <br />Power detectection
 
| <br />Output
 
| <br />Output
 
| <br />Active high then Iridium Edge is powered
 
| <br />Active high then Iridium Edge is powered
Line 70: Line 68:
 
'''''Save/Send period''''' configures how long will FMB device wait after losing the signal to generate SBD packet. If the signal is not recovered, it will send it indefinitely (or till the SBD Upload limit is reached, if such is set).
 
'''''Save/Send period''''' configures how long will FMB device wait after losing the signal to generate SBD packet. If the signal is not recovered, it will send it indefinitely (or till the SBD Upload limit is reached, if such is set).
  
−
'''''SBD Upload Limit''''' is configurable and resets every month. This option can ensure that no additional data is used so that no unexpected costs are experienced by the customer. The default value is 8000 (for 8KB plan). This option can be disabled by setting the Upload limit to 0. The monthly data usage counter can be reset by using the SMS/GPRS command - '''sbdlimitsreset'''.
+
'''''SBD Upload Limit''''' is configurable and resets every month. This option can ensure that no additional data is used so that no unexpected costs are experienced by the customer. Default value is 8000 (for 8KB plan). This option can be disabled by setting Upload limit to 0. Monthly data usage counter can be reset by using SMS/GPRS command - '''sbdlimitsreset'''.
  
 
'''''SBD IO source''''' configures IO source which can trigger SBD record saving.  9 elements can generate Alarm for SDB sending. These elements are:
 
'''''SBD IO source''''' configures IO source which can trigger SBD record saving.  9 elements can generate Alarm for SDB sending. These elements are:
Line 84: Line 82:
 
<br></br>
 
<br></br>
 
Configurator parameter IDs and their explanation:
 
Configurator parameter IDs and their explanation:
−
{| class="nd-othertables_2" style="width:100%;"
+
{| class="wikitable"  
 
|- style="font-weight:bold; text-align:center;"
 
|- style="font-weight:bold; text-align:center;"
 
! '''Parameter ID'''<br />
 
! '''Parameter ID'''<br />
Line 109: Line 107:
 
| 0
 
| 0
 
| 1440
 
| 1440
−
| 0
+
| 1440
 
| This parameter lets to configure Iridium Edge sending period
 
| This parameter lets to configure Iridium Edge sending period
 
|-
 
|-
Line 130: Line 128:
 
| 1
 
| 1
 
| 5
 
| 5
−
| 1
+
| 0
 
| Device DOUT which can control ON/OFF pin of the Iridium Edge
 
| Device DOUT which can control ON/OFF pin of the Iridium Edge
 
|-
 
|-
Line 142: Line 140:
  
 
<br></br>
 
<br></br>
−
'''*''' SBD IO source parameter is configured with bitmasks (used for configuring I/O source elements via SMS/GPRS command) :  
+
'''*''' SBD IO source parameter is configured with bitmasks:  
−
*Disabled     = 0x00,
+
*eSBD_IO_Bit_Disabled     = 0x00,
−
*Din1         = 0x01,
+
*eSBD_IO_Bit_Din1         = 0x01,
−
*Din2         = 0x02,
+
*eSBD_IO_Bit_Din2         = 0x02,
−
*Din3         = 0x04,
+
*eSBD_IO_Bit_Din3         = 0x04,
−
*Din4         = 0x08,
+
*eSBD_IO_Bit_Din4         = 0x08,
−
*Dout1         = 0x10,
+
*eSBD_IO_Bit_Do1         = 0x10,
−
*Dout2         = 0x20,
+
*eSBD_IO_Bit_Do2         = 0x20,
−
*Dout3         = 0x40,
+
*eSBD_IO_Bit_Do3         = 0x40,
−
*Dout4         = 0x80,
+
*eSBD_IO_Bit_Do4         = 0x80,
−
*Speed       = 0x100
+
*eSBD_IO_Bit_Speed       = 0x100
 
<br></br>
 
<br></br>
−
For example: to enable Din1, Din3 and Dout4: 0x01 + 0x04 + 0x80 = 0x85 convert to decimal --> 133.
+
For example: to enable Din1, Din3 and Do4: 0x01 + 0x04 + 0x80 = 0x85 convert to decimal --> 133.
  
 
===Setting up Alarm priority records===
 
===Setting up Alarm priority records===
Line 161: Line 159:
 
[[File:FMB640 iridium1.png]]
 
[[File:FMB640 iridium1.png]]
 
<br></br>
 
<br></br>
−
In the scenario shown in the above picture when panic record is made (generated by ''Digital Input 1'' or ''Digital Input 2'') internal 90 seconds timer will start to tick and if in that timeout device will not send the record through GPRS network it will be sent with Iridium satellites.
+
In scenario shown in above picture when panic record is made (generated by ''Digital Input 1'' or ''Digital Input 2'') internal 90 seconds timer will start to tick and if in that timeout device will not send record through GPRS network it will be sent with Iridium satellites.
 
===SDB record structure===
 
===SDB record structure===
−
SDB Record which will be sent through the Iridium satellites network will be different than the regular record. It will contain 4 bytes timestamp, 3 bytes longitude, 3 bytes latitude, 1 byte record generation info, 1 byte DIN,DOUT info, 1 byte Speed value.
+
SDB Record which will be sent through Iridium satellites network will be different than the regular record. It will contain: 4 bytes timestamp, 3 bytes longitude, 3 bytes latitude, 1 byte record generation info, 1 byte DIN,DOUT info, 1 byte Speed value.
  
−
{| class="nd-othertables_2" style="width:100%;"
+
{| class="wikitable" style="font-weight:bold;"
−
|-style="text-align:center"
+
|-
−
!Timestamp
+
! Timestamp
−
!Longitude
+
! Longitude
−
!Latitude
+
! Latitude
−
!SDB AVL ID and flags
+
! SDB AVL ID and flags
−
!DIN/DOUT info
+
! DIN/DOUT info
−
!Reserved
+
! Reserved
−
!Speed
+
! Speed
−
|- style="font-weight:normal;"
+
|- style="font-weight:normal; text-align:center;"
−
|4B
+
| 4B
−
|3B
+
| 3B
−
|3B
+
| 3B
−
|1B
+
| 1B
−
|1B
+
| 1B
−
|1B
+
| 1B
−
|1B
+
| 1B
 
|}
 
|}
  
 
'''''Timestamp''''' - Indicates when record was generated.
 
'''''Timestamp''''' - Indicates when record was generated.
 
<br></br>
 
<br></br>
−
'''''Longitude''''' - In this packet is encoded in 3 bytes data. The server that gets this data should divide the result from 46603,375 and subtract 180 to get the actual longitude value. This coefficient is got in the following way: 16777215(maximum 3 bytes value) divided by 360 (maximum longitude value then 180 is added). This calculation is used to fit negative and positive values to 3 bytes width variable.
+
'''''Longitude''''' - In this packet is encoded in 3 bytes data. Server which gets this data should divide result from 46603,375 and subtract 180 in order to get actual longitude value. This coefficient is got in following way: 16777215(maximum 3 bytes value) divided from 360 (maximum longitude value then 180 is added). This calculation is used to fit negative and positive values to 3 bytes width variable.
 
<br></br>
 
<br></br>
−
'''''Latitude''''' - Is calculated in the same way as longitude but since latitude maximum value is two times smaller than longitude it can produce a bit more accurate data. The coefficient for latitude is 93206,75. This coefficient is got in the following way: 16777215(maximum 3 bytes value) divided by 180 (maximum latitude value then 90 is added). This calculation is used to fit negative and positive values to 3 bytes width variable.
+
'''''Latitude''''' - Is calculated in same way as longitude but since latitude maximum value is two times smaller than longitude it can produce a bit more accurate data. Coefficient for latitude is 93206,75. This coefficient is got in following way: 16777215(maximum 3 bytes value) divided from 180 (maximum latitude value then 90 is added). This calculation is used to fit negative and positive values to 3 bytes width variable.
 
<br></br>
 
<br></br>
 
'''''SBD AVL ID and flags''''' – Custom ID that will indicate what caused the record to be generated (final ID will (as only periodic records are generated, ID is not used)).
 
'''''SBD AVL ID and flags''''' – Custom ID that will indicate what caused the record to be generated (final ID will (as only periodic records are generated, ID is not used)).
−
This byte is divided in two parts of four bits, as shown in table below:
 
−
 
−
{| class="nd-othertables_2" style="width:100%;"
 
−
|-
 
−
! colspan="4" style="font-weight:bold;" | <br />Flags  (not used yet)
 
−
! colspan="4" style="font-weight:bold;" | <br />SBD  AVL ID
 
−
|- style="color:#fe0000;"
 
−
| <br />Bit 7
 
−
| <br />Bit 6
 
−
| <br />Bit 5
 
−
| <br />Bit 4
 
−
| style="color:#3531ff;" | <br />Bit 3
 
−
| style="color:#3531ff;" | <br />Bit 2
 
−
| style="color:#3531ff;" | <br />Bit 1
 
−
| style="color:#3531ff;" | <br />Bit 0
 
−
|}
 
 
<br></br>
 
<br></br>
−
SBD AVL ID is used to show which IO element generated the Panic element. The list of currently implemented possible values is described below:
+
'''''DIN/DOUT info''''' - Displays configured IO elements in SBD IO source (parameter ID 99422).
−
<br></br>
 
−
{|  class="nd-othertables_2" style="width:100%;"font-weight:bold; vertical-align:middle;"
 
−
! style="font-weight:bold;" | <br />ID
 
−
! <br />0
 
−
! <br />1
 
−
! <br />2
 
−
! <br />3
 
−
! <br />4
 
−
! <br />5
 
−
! <br />6
 
−
! <br />7
 
−
! <br />8
 
−
! <br />9
 
−
|-
 
−
| style="font-weight:bold;" | <br />IO  element
 
−
| <br />Periodic rec.
 
−
| <br />Digital Input 1
 
−
| <br />Digital input 2
 
−
| <br />Digital input 3
 
−
| <br />Digital input 4
 
−
| <br />Digital output 1
 
−
| <br />Digital output 2
 
−
| <br />Digital output 3
 
−
| <br />Digital output 4
 
−
| <br />Speed
 
−
|}
 
−
<br></br>
 
−
Data from Bit 7 to Bit 4 are not used at the moment. The server should ignore this data part.
 
−
<br></br>
 
−
'''''DIN/DOUT info''''' - Displays configured IO elements values of enabled IO elements in SBD IO source settings - (parameter ID 99422). Since digital inputs can contain only logic 1 or 0 they are bit masked in one byte.
 
−
{| class="nd-othertables_2" style="width:100%;"font-weight:bold; vertical-align:middle;"
 
−
|-
 
−
! <br />DIN1
 
−
! <br />DIN2
 
−
! <br />DIN3
 
−
! <br />DIN4
 
−
! <br />DOUT1
 
−
! <br />DOUT2
 
−
! <br />DOUT3
 
−
! <br />DOUT4
 
−
|- style="font-weight:normal;"
 
−
| <br />Bit 7
 
−
| <br />Bit 6
 
−
| <br />Bit 5
 
−
| <br />Bit 4
 
−
| <br />Bit 3
 
−
| <br />Bit 2
 
−
| <br />Bit 1
 
−
| <br />Bit 0
 
−
|}
 
 
<br></br>
 
<br></br>
 
'''''Reserved''''' - Not used.
 
'''''Reserved''''' - Not used.
 
<br></br>
 
<br></br>
−
'''''Speed''''' – Indicates the speed of the vehicle if configured. If not (or in case of no GPS) – it will display 255.
+
'''''Speed''''' – Indicates the speed of the vehicle if configured. If not (or in case of no GPS) – will display 255.
−
<br> </br>
 
−
 
 
−
==SBD packet example==
 
−
'''Unparsed data:'''
 
−
 
 
−
<span style="color:#0000ff">''01004C01001CF99DD263333030323334303634303730383330000018000059282DBC03000B0036A2B8193D120000000302001C''
 
−
<span style="color:#008000"> ''59282BA391F5ABCDBFDD0180000059282BA891F5ABCDBFDD0180000059282BA391F5AB'' </span>
 
−
<br></br>
 
−
<span style="color:#0000ff">{01} – Protocol revision number</span><br></br>
 
−
<span style="color:#0000ff">{00}{4C} – overall message length</span><br></br>
 
−
<span style="color:#0000ff">{01} – MO header IEI</span><br></br>
 
−
<span style="color:#0000ff">{00}{1C} – MO header length</span><br></br>
 
−
<span style="color:#0000ff">{F9}{9D}{D2}{63} – CDR Reference</span><br></br>
 
−
<span style="color:#0000ff">{33}{30}{30}{32}{33}{34}{30}{36}{34}{30}{37}{30}{38}{33}{30} – IMEI of the device</span><br></br>
 
−
<span style="color:#0000ff">{00} – Session status (Transfer OK in this case)</span><br></br>
 
−
<span style="color:#0000ff">{00}{18} – MOMSN</span><br></br>
 
−
<span style="color:#0000ff">{00}{00} – MTMSN</span><br></br>
 
−
<span style="color:#0000ff">{59}{28}{2D}{BC} – Time of session</span><br></br>
 
−
<span style="color:#0000ff">{03} – MO Location information IEI</span><br></br>
 
−
<span style="color:#0000ff">{00}{0B} – MO Location information length</span><br></br>
 
−
<span style="color:#0000ff">{00}{36}{A2}{B8}{19}{3D}{12} – MO latitude and longitude as described in Iridium documentation. </span><br></br>
 
−
<span style="color:#0000ff">{00}{00}{00}{03} – CEP radius</span><br></br>
 
−
<span style="color:#0000ff">{02} – Payload IEI </span><br></br>
 
−
<span style="color:#0000ff">{00}{1C} – Payload length </span><br></br>
 
−
<span style="color:#008000">{59}{28}{2B}{A3}{91}{F5}{AB}{CD}{BF}{DD}{01}{80}{00}{00} – Record 1</span> <br></br>
 
−
<span style="color:#008000">{59}{28}{2B}{A8}{91}{F5}{AB}{CD}{BF}{DD}{01}{80}{00}{00} – Record 2 </span><br></br>
 
−
 
 
−
There blue part of record is satellite device generated data and green is actual record payload which was sent to server from {{{device|}}}. Information of the first record should be parsed like this:
 
−
<br></br>
 
−
<span style="color:#008000">{59}{28}{2B}{A3} – Timestamp of record generation in GMT0;</span> <br></br>
 
−
<span style="color:#008000">{91}{F5}{AB} – Longitude (recalculated value is 25,255756) </span><br></br>
 
−
<span style="color:#008000">{CD}{BF}{DD} – Latitude (recalculated value is 54,832396) </span><br></br>
 
−
<span style="color:#008000">{01} – DIN1 generated event </span><br></br>
 
−
<span style="color:#008000">{80} – DIN1 on, while DIN2, DIN3, DIN4, DOUT1, DOUT2, DOUT3, DOUT4 – off </span><br></br>
 
−
<span style="color:#008000">{00} – Reserved byte</span> <br></br>
 
−
<span style="color:#008000">{00} – Vehicle was stopped when the record was generated</span> <br></br>
 

Revision as of 14:51, 5 September 2022

Introduction

Since 00.02.05 firmware version device supports Iridium devices which can send short burst data (SBD) to the server. This means that some data can be sent from the FM device to the server through satellites. From firmware version - 01.02.22.Rev.02, support for Iridium Edge is added. Iridium Edge features an all-in-one SBD module and antenna, with power supply. The plug-and-play satellite IoT terminal can be easily paired with device in order to expand their functionality to no GSM coverage zones. Current Iridium implementation offers ability to generate and send SBD records after set period after the GSM signal is lost. This ensures constant connectivity as Iridium network is available globally.

Connecting Iridium device to

In order to properly connect Iridium device to , Iridium has to be connect to the device via RS-232 - COM1 or COM2. Additionally Pin No. 6 - power control (reference in image below) must to be connected to one of the DOUTs (1/2/3/4), in order to allow device to power ON/OFF Iridium device on demand.

Iridium Edge pinout:

Iridium Edge pinout.png

Pin. No
Signal name
Signal direction (with respect to Iridium Edge)
Description

1
Spare
-
Unused

2
Ground
Input
Signal and power GND

3
RS232_RX
Input
RS232 input

4
RS232_TX
Output
RS232 output

5
Power
Input
9-32 V positive terminal

6
ON/OFF
Input
Optional line to power down Iridium edge

7
Network available
Output

8
Power detectection
Output
Active high then Iridium Edge is powered



Configuring

In order to properly configure to get SBD records, first it is necessary to select correct RS232 mode in RS-232 / RS 485 TAB - “Satellite backup” mode must be selected in COM1/COM2 settings. Baudrate should be set to 19200.

RS232 Iridiums.gif

Furthermore, in the Features TAB in Short burst data settings, TSM232 and Iridium Edge must be enabled. Power control DOUT configures DOUT pin which can control Iridium Edge ON/OFF pin. Configure if DOUT pin is connected. Respective power control DOUT to which Iridium device's PIN6 is connect must be selected.

SBD settings.gif

Save/Send period configures how long will FMB device wait after losing the signal to generate SBD packet. If the signal is not recovered, it will send it indefinitely (or till the SBD Upload limit is reached, if such is set).

SBD Upload Limit is configurable and resets every month. This option can ensure that no additional data is used so that no unexpected costs are experienced by the customer. Default value is 8000 (for 8KB plan). This option can be disabled by setting Upload limit to 0. Monthly data usage counter can be reset by using SMS/GPRS command - sbdlimitsreset.

SBD IO source configures IO source which can trigger SBD record saving. 9 elements can generate Alarm for SDB sending. These elements are:

  • Digital input 1
  • Digital input 2
  • Digital input 3
  • Digital input 4
  • Digital output 1
  • Digital output 2
  • Digital output 3
  • Digital output 4
  • Speed



Configurator parameter IDs and their explanation:

Parameter ID
 Parameter name Values Explanation
Min Max Default
99420 Iridium Edge 0 1 0 This parameter enables or disables Iridium Edge functionality
99421 Save/Send period 0 1440 1440 This parameter lets to configure Iridium Edge sending period
99422 SBD IO source* 0 8 0 SBD IO elements which when enabled are included into the SBD record
99423 SBD UploadLimit 0 30000 8000 Limit to save user from exceeding the monthly plan. Max limit of 30000 due to 30KB plan. If set to 0 – limit will be off.
99424 Power control DOUT 1 5 0 Device DOUT which can control ON/OFF pin of the Iridium Edge
151 RS232 Mode 0 23 0 RS-232 mode selection. "Satellite backup" - 15



* SBD IO source parameter is configured with bitmasks:

  • eSBD_IO_Bit_Disabled = 0x00,
  • eSBD_IO_Bit_Din1 = 0x01,
  • eSBD_IO_Bit_Din2 = 0x02,
  • eSBD_IO_Bit_Din3 = 0x04,
  • eSBD_IO_Bit_Din4 = 0x08,
  • eSBD_IO_Bit_Do1 = 0x10,
  • eSBD_IO_Bit_Do2 = 0x20,
  • eSBD_IO_Bit_Do3 = 0x40,
  • eSBD_IO_Bit_Do4 = 0x80,
  • eSBD_IO_Bit_Speed = 0x100



For example: to enable Din1, Din3 and Do4: 0x01 + 0x04 + 0x80 = 0x85 convert to decimal --> 133.

Setting up Alarm priority records

In addition, you can select which IO element can generate Alarm priority record. The configurable IO parameters are listed as SBD IO source in list above. In order to do that you need to configure these IO elements as Panic priority. If properly configured SBD records are generated and sent if there is no GSM connection.

FMB640 iridium1.png

In scenario shown in above picture when panic record is made (generated by Digital Input 1 or Digital Input 2) internal 90 seconds timer will start to tick and if in that timeout device will not send record through GPRS network it will be sent with Iridium satellites.

SDB record structure

SDB Record which will be sent through Iridium satellites network will be different than the regular record. It will contain: 4 bytes timestamp, 3 bytes longitude, 3 bytes latitude, 1 byte record generation info, 1 byte DIN,DOUT info, 1 byte Speed value.

Timestamp Longitude Latitude SDB AVL ID and flags DIN/DOUT info Reserved Speed
4B 3B 3B 1B 1B 1B 1B

Timestamp - Indicates when record was generated.

Longitude - In this packet is encoded in 3 bytes data. Server which gets this data should divide result from 46603,375 and subtract 180 in order to get actual longitude value. This coefficient is got in following way: 16777215(maximum 3 bytes value) divided from 360 (maximum longitude value then 180 is added). This calculation is used to fit negative and positive values to 3 bytes width variable.

Latitude - Is calculated in same way as longitude but since latitude maximum value is two times smaller than longitude it can produce a bit more accurate data. Coefficient for latitude is 93206,75. This coefficient is got in following way: 16777215(maximum 3 bytes value) divided from 180 (maximum latitude value then 90 is added). This calculation is used to fit negative and positive values to 3 bytes width variable.

SBD AVL ID and flags – Custom ID that will indicate what caused the record to be generated (final ID will (as only periodic records are generated, ID is not used)).

DIN/DOUT info - Displays configured IO elements in SBD IO source (parameter ID 99422).

Reserved - Not used.

Speed – Indicates the speed of the vehicle if configured. If not (or in case of no GPS) – will display 255.

Retrieved from "https://wiki.teltonika-gps.com/index.php?title=Template:FMX640_Short_Burst_Data&oldid=75757"