0
edits
Changes
How to read ELD data with FM3001? (view source)
Revision as of 09:17, 27 February 2019
, 09:17, 27 February 2019Created page with "===Introduction=== This document contains information required for developing an application for receiving Electronic Logging Devices data via Bluetooth from FMB series device..."
===Introduction===
This document contains information required for developing an application for receiving Electronic Logging Devices data via Bluetooth from FMB series devices.
Acronyms and terms used in the document:
*BT – Bluetooth
*ELD – Electronic Logging Devices
===Configurable parameters===
ELD functionality has 3 additional parameters: ELD data send period and ELD VIN.
{| class="wikitable"
|+
! style="width:10%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan=2 | Parameter ID
! style="width:25%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan=2 | Parameter Type
! style="width:10%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan=2 | Default Value
! style="width:5%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" colspan = 2 | Value Range
! style="width:10%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan = 2 | Value
! style="width:15%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan = 2 | Parameter Name
|-
! style="width:5%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center; |Min
! style="width:5%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" |Max
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 40000
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Uint8
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 1
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 0
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 2
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" |
0 - Disable <br>
1 - OBD <br>
2 - ELD
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | OBD Feature
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 40002
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Uint16
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 10
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 2
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 65535
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Seconds
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ELD data send period
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 40003
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | String
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ""
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 17
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 17
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Charactes
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ELD VIN
|}
<br>
ELD VIN number has to be exactly 17-character long, contain uppercase letters and do not include letters I(i), O(o) and Q(q) (to avoid confusion with numerals 1 and 0).
===ELD APP workflow===
ELD functionality start to send data periodically via BT right after external BT device has been connected if OBD Feature (parameter ID 40000) is set to ELD (option 2).
ELD data sending is paused if Configurator is connected. ELD data is resumed after configurator disconnects.
ELD data sending resumes automatically when external BT device reconnects after connection loss.
===ELD data packet structure===
ELD data packets have JSON structure as shown below: <br>
{ <br>
"dashboard_mileage": "919483",<br>
"obd_rpm": "0",<br>
"obd_vin": "4V4NC9EH4FN187825",<br>
"ignition": "0",<br>
"loc": "-10310092,3517679",<br>
"obd_speed": "4",<br>
"engine_hours": "0",<br>
"time": "1518588000",<br>
“can_data”:”0”.<br>
}<br>
Braces “{” and “}” marks packet start and end.
===Parameters definitions===
{| class="wikitable"
|+
! style="width:10%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" | Parameter name
! style="width:25%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" | Parameter definition
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''dashboard_mileage''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Units in km, vehicle Total Distance PGN 65217 SPN 917
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''obd_rpm''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Vehicle RPM PGN 61444 SPN 19065217 SPN 917
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" |''obd_vin''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Vehicle VIN PGN 65260 SPN 237
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''ignition''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Ignition state according to RPM, possible values: 0 – RPM=0 or 1– RPM>0
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''loc''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Current coordinates (longitude and latitude), example value "-10310092,3517679”, actual position is lon=-103.10092, lat=35.17679
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''obd_speed''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Units in km/h, wheel based speed PGN 65265 SPN 84
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''engine_hours''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Total Engine hours PGN 65253 SPN 247
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''time''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | A point in time, defined as the number of seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970. Current timestamp used in FM3001 record saving.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''Can_data''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Shows whether CAN data is being read. 0 – CAN data is not being read; 1 – CAN data is being read.
|}
<br>
{| class="wikitable" style="border-style: solid; border-width: 0px"
|+
|-
| style="text-align: left; background: #F6F6FB;" | [[Image:Bw_nb.png|50px]]
| style="text-align: left; background: #F6F6FB;" | Can_data parameter has been added from firmware version 03.18.00.
|}
<br>
Ignition is set depending on RPM value received from TLT chip:
*ignition is set to 1 if RPM is more than 0 and is set to 0 if RPM is equal to 0. <br>
<br>
RPM and Speed are also saved to Engine RPM and Vehicle Speed OBD IO elements.
This document contains information required for developing an application for receiving Electronic Logging Devices data via Bluetooth from FMB series devices.
Acronyms and terms used in the document:
*BT – Bluetooth
*ELD – Electronic Logging Devices
===Configurable parameters===
ELD functionality has 3 additional parameters: ELD data send period and ELD VIN.
{| class="wikitable"
|+
! style="width:10%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan=2 | Parameter ID
! style="width:25%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan=2 | Parameter Type
! style="width:10%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan=2 | Default Value
! style="width:5%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" colspan = 2 | Value Range
! style="width:10%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan = 2 | Value
! style="width:15%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" rowspan = 2 | Parameter Name
|-
! style="width:5%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center; |Min
! style="width:5%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" |Max
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 40000
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Uint8
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 1
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 0
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 2
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" |
0 - Disable <br>
1 - OBD <br>
2 - ELD
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | OBD Feature
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 40002
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Uint16
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 10
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 2
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 65535
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Seconds
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ELD data send period
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 40003
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | String
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ""
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 17
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | 17
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Charactes
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ELD VIN
|}
<br>
ELD VIN number has to be exactly 17-character long, contain uppercase letters and do not include letters I(i), O(o) and Q(q) (to avoid confusion with numerals 1 and 0).
===ELD APP workflow===
ELD functionality start to send data periodically via BT right after external BT device has been connected if OBD Feature (parameter ID 40000) is set to ELD (option 2).
ELD data sending is paused if Configurator is connected. ELD data is resumed after configurator disconnects.
ELD data sending resumes automatically when external BT device reconnects after connection loss.
===ELD data packet structure===
ELD data packets have JSON structure as shown below: <br>
{ <br>
"dashboard_mileage": "919483",<br>
"obd_rpm": "0",<br>
"obd_vin": "4V4NC9EH4FN187825",<br>
"ignition": "0",<br>
"loc": "-10310092,3517679",<br>
"obd_speed": "4",<br>
"engine_hours": "0",<br>
"time": "1518588000",<br>
“can_data”:”0”.<br>
}<br>
Braces “{” and “}” marks packet start and end.
===Parameters definitions===
{| class="wikitable"
|+
! style="width:10%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" | Parameter name
! style="width:25%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: center;" | Parameter definition
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''dashboard_mileage''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Units in km, vehicle Total Distance PGN 65217 SPN 917
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''obd_rpm''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Vehicle RPM PGN 61444 SPN 19065217 SPN 917
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" |''obd_vin''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Vehicle VIN PGN 65260 SPN 237
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''ignition''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Ignition state according to RPM, possible values: 0 – RPM=0 or 1– RPM>0
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''loc''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Current coordinates (longitude and latitude), example value "-10310092,3517679”, actual position is lon=-103.10092, lat=35.17679
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''obd_speed''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Units in km/h, wheel based speed PGN 65265 SPN 84
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''engine_hours''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Total Engine hours PGN 65253 SPN 247
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''time''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | A point in time, defined as the number of seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970. Current timestamp used in FM3001 record saving.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | ''Can_data''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; background: white; text-align: center;" | Shows whether CAN data is being read. 0 – CAN data is not being read; 1 – CAN data is being read.
|}
<br>
{| class="wikitable" style="border-style: solid; border-width: 0px"
|+
|-
| style="text-align: left; background: #F6F6FB;" | [[Image:Bw_nb.png|50px]]
| style="text-align: left; background: #F6F6FB;" | Can_data parameter has been added from firmware version 03.18.00.
|}
<br>
Ignition is set depending on RPM value received from TLT chip:
*ignition is set to 1 if RPM is more than 0 and is set to 0 if RPM is equal to 0. <br>
<br>
RPM and Speed are also saved to Engine RPM and Vehicle Speed OBD IO elements.