157
edits
Changes
Iridium Edge Communication Protocol (view source)
Revision as of 10:48, 8 August 2023
, 10:48, 8 August 2023no edit summary
* Timestamp – Indicates when record was generated
* Timestamp – Indicates when record was generated
* Longitude - 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.
* Longitude - 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 - 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 (as only periodic records are generated, id is not used)
*Latitude - 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.
* Din/Dout info - Displays configured IO elements in parameter id 99422
*SBD AVL ID and flags – Custom id that will indicate what caused the record to be generated (as only periodic records are generated, id is not used)
* Reserved - Not used anywhere, but left due to compatibility with fm6 project.
*Din/Dout info - Displays configured IO elements in parameter id 99422
* Speed – Indicates the speed of the vehicle if configured. If not (or in case of no gps) – will display 255
*Reserved - Not used anywhere, but left due to compatibility with fm6 project.
*Speed – Indicates the speed of the vehicle if configured. If not (or in case of no gps) – will display 255
==Data Sending Parameters==
==Data Sending Parameters==
==SBD IO source==
==SBD IO source==
Configures IO source which can trigger SBD record saving. 9 elements can generate Alarm for SDB sending. These elements are:
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 1
* Digital input 2
*Digital input 2
* Digital output 1
*Digital output 1
* Speed
*Speed
* Crash
*Crash
<br></br>
<br><br>
Configurator parameter IDs and their explanation:
Configurator parameter IDs and their explanation:
{| class="nd-othertables_2" style="width:100%;"
{| class="nd-othertables_2" style="width:100%;"
|- style="font-weight:bold; text-align:center;"
|- style="font-weight:bold; text-align:center;"
! '''Parameter ID'''<br />
!'''Parameter ID'''<br />
! '''Parameter name'''
!'''Parameter name'''
! colspan="3" | '''Values'''
! colspan="3" |'''Values'''
! '''Explanation'''
!'''Explanation'''
|- style="font-weight:bold; text-align:center;"
|- style="font-weight:bold; text-align:center;"
| style="font-weight:normal;" |
| style="font-weight:normal;" |
| style="font-weight:normal;" |
| style="font-weight:normal;" |
| '''Min'''
|'''Min'''
| '''Max'''
|'''Max'''
| '''Default'''
|'''Default'''
| style="font-weight:normal;" |
| style="font-weight:normal;" |
|-
|-
| 99420
|99420
| Iridium Edge
|Iridium Edge
| 0
|0
| 1
|1
| 0
|0
| This parameter enables or disables Iridium Edge functionality
|This parameter enables or disables Iridium Edge functionality
|-
|-
| 99421
|99421
| Save/Send period
|Save/Send period
| 0
|0
| 1440
|1440
| 1440
|1440
| This parameter lets to configure Iridium Edge sending period
|This parameter lets to configure Iridium Edge sending period
|-
|-
| 99422
|99422
| SBD IO source'''*'''
|SBD IO source'''*'''
| 0
|0
| 8
|8
| 0
|0
| SBD IO elements which when enabled are included into the SBD record
|SBD IO elements which when enabled are included into the SBD record
|-
|-
| 99423
|99423
| SBD UploadLimit
|SBD UploadLimit
| 0
|0
| 30000
|30000
| 8000
|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.
|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
|99424
| Power control DOUT
|Power control DOUT
| 1
|1
| 5
|5
| 0
|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
|-
|-
| 151
|151
| RS232 Mode
|RS232 Mode
| 0
|0
| 23
|23
| 0
|0
| RS-232 mode selection. "Satellite backup" - 15
|RS-232 mode selection. "Satellite backup" - 15
|}
|}
<br></br>
<br><br>
In order to configure parameter 99422 manually users must simply set the appropriate values of bit positions, according to their needs:
In order to configure parameter 99422 manually users must simply set the appropriate values of bit positions, according to their needs:
* Bit1 - DIN 1
*Bit1 - DIN 1
* Bit2 - DIN 2
*Bit2 - DIN 2
* Bit5 - DOUT 1
*Bit5 - DOUT 1
* Bit9 - Speed
*Bit9 - Speed
* Bit10 - Crash
*Bit10 - Crash
==SDB record structure==
==SDB record structure==
{| class="nd-othertables_2" style="width:100%;"
{| class="nd-othertables_2" style="width:100%;"
|-style="text-align:center"
|- 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;"
|4B
|4B
'''''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. 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.
<br></br>
Example:
Longitude: 910DA0 (in hexadecimal) → 9506208 (in decimal)
To convert Longitude:
(9506208 / 46603,375) - 180 = 23.9811065<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 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.
<br></br>
Example:
Latitude: CE1AEB (in hexadecimal) → 13507307 (in decimal)
To convert Latitude:
(13507307 / 93206.750) - 90 = 54.91769<br><br>
'''Din/Dout info''' - Displays configured IO elements in parameter id 99422 (only din/dout). If IO is not set, it will send be replaced by 0.
'''Din/Dout info''' - Displays configured IO elements in parameter id 99422 (only din/dout). If IO is not set, it will send be replaced by 0.
<br></br>
<br><br>
'''Reserved''' - Not used anywhere.
'''Reserved''' - Not used anywhere.
<br></br>
<br><br>
'''Speed''' – Indicates the speed (from GNSS) of the vehicle if configured. If not (or in case of no gps) – will display 255.
'''Speed''' – Indicates the speed (from GNSS) of the vehicle if configured. If not (or in case of no gps) – will display 255.
<br></br>
<br><br>
'''''SBD AVL ID and flags''''' – Custom ID that will indicate what caused the record to be generated
'''''SBD AVL ID and flags''''' – Custom ID that will indicate what caused the record to be generated
This byte is divided in two parts of four bits, as shown in table below:
This byte is divided in two parts of four bits, as shown in table below:
{| class="nd-othertables_2" style="width:100%;"font-weight:bold; vertical-align:middle;"
{| class="nd-othertables_2" style="width:100%;" font-weight:bold; vertical-align:middle;"
! style="font-weight:bold;" | <br />ID
! style="font-weight:bold;" |<br />ID
! <br />0
!<br />0
! <br />1
!<br />1
! <br />2
!<br />2
! <br />24
!<br />24
! <br />179
!<br />179
! <br />247
!<br />247
|-
|-
| style="font-weight:bold;" | <br />IO element
| style="font-weight:bold;" |<br />IO element
| <br />Periodic rec.
|<br />Periodic rec.
| <br />Digital Input 1
|<br />Digital Input 1
| <br />Digital input 2
|<br />Digital input 2
| <br />Speed
|<br />Speed
| <br />DOUT1
|<br />DOUT1
| <br />Crash
|<br />Crash
|}
|}
<br></br>
<br><br>
==SBD packet example==
==SBD packet example==
<span style="color:#0000ff">''01004C01001CF99DD263333030323334303634303730383330000018000059282DBC03000B0036A2B8193D120000000302001C''
<span style="color:#0000ff">''01004C01001CF99DD263333030323334303634303730383330000018000059282DBC03000B0036A2B8193D120000000302001C''
<span style="color:#008000"> ''59282BA391F5ABCDBFDD0180000059282BA891F5ABCDBFDD0180000059282BA391F5AB'' </span>
<span style="color:#008000"> ''59282BA391F5ABCDBFDD0180000059282BA891F5ABCDBFDD0180000059282BA391F5AB'' </span>
<br></br>
<br><br>
<span style="color:#0000ff">{01} – Protocol revision number</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">{00}{4C} – overall message length</span><br><br>
<span style="color:#0000ff">{01} – MO header IEI</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">{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">{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">{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} – 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}{18} – MOMSN</span><br><br>
<span style="color:#0000ff">{00}{00} – MTMSN</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">{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">{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}{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}{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">{00}{00}{00}{03} – CEP radius</span><br><br>
<span style="color:#0000ff">{02} – Payload IEI </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:#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}{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>
<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:
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>
<br><br>
<span style="color:#008000">{59}{28}{2B}{A3} – Timestamp of record generation in GMT0;</span> <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">{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">{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">{01} – DIN1 generated event </span><br><br>
<span style="color:#008000">{80} – DIN1 on, while DIN2, DOUT1, – off </span><br></br>
<span style="color:#008000">{80} – DIN1 on, while DIN2, DOUT1, – off </span><br><br>
<span style="color:#008000">{00} – Reserved byte</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>
<span style="color:#008000">{00} – Vehicle was stopped when the record was generated</span> <br><br>