This catalog lists every available UDP event type with an example event.
Accelerometer Event
Accelerometers measure acceleration in meters per second squared
(m/s2) or g-forces (g). 1000mG = 1g = 9.8m/s2.
Accelerometer events are generated using 24Hz accelerometer sampling with
sensitivity up to 2g. The threshold for triggering the event and the minimum
number of samples needed to verify the event are configurable. The number of
milliseconds the threshold must be maintained is static (1000 milliseconds).
The ImpactEvent is generated using 100Hz accelerometer sampling and can provide
readings up to 16g. The threshold for triggering the impact event, the number of
milliseconds the threshold must be maintained, and the minimum number of samples
needed to verify the impact event are all configurable.
{
"header": {...},
"body": {
"footer": 227,
"message": {
"type": "AccelerometerEvent",
"eventType": "ImpactEvent",
"accelerometerAxis": "Impact",
"triggerValue": 2000,
"maxValue": 4000
},
"header": {
"timestamp": "2017-02-05T10:36:31-05:00",
"tripType": "Trip",
"tripNumber": 23,
"messageType": 10,
"messageLength": 6,
"latitude": 42.27866,
"longitude": -83.74376,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 22
}
}
}
- body: (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- eventType: (enum[string]) - The type of accelerometer event.
- Members
- `ImpactEvent` - The configured impact criteria were met.
- `HardAccl` - The configured event criteria were met.
- `HardBraking` - The configured event criteria were met.
- `HardTurn` - The configured event criteria were met.
- `Unknown` - The platform is unable to determine the accelerometer event type.
- accelerometerAxis: (enum[string]) - The axis on which the event took place (normalized to the vehicle).
- Members
- `Impact`
- `X-axis`
- `Y-axis`
- `Z-axis`
- triggerValue: (number) - The value that triggered this event in mG.
- maxValue: (number) - The maximum value reached for this event in mG.
- header: (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: `10` (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Aggregated GPS Messages
These GPS messages contain a subset of the information provided in the standard GPS message to make them more compact and allow them to be delivered more efficiently.
{
"header": {...}
"body": {
"message": {
"aggregateGpsSamples": [
{
"gpsTimestamp": "2019-06-05T14:48:11-04:00",
"latitude": 42.47831,
"longitude": -83.45243,
"numberSatellitesInView": 3,
"courseOverGroundInDeg": -256,
"hdopRange": "OneToTwo",
"speed": 105,
"speedType": "Vehicle"
},
{
"latitude": 42.47832,
"gpsTimestamp": "2019-06-05T14:48:16-04:00",
"longitude": -83.45246,
"numberSatellitesInView": 3,
"courseOverGroundInDeg": -256,
"hdopRange": "OneToTwo",
"speed": 105,
"speedType": "Vehicle"
}
]
},
"header": {
"timestamp": "2019-06-05T14:48:11-04:00",
"tripNumber": 3,
"collectionRateInSeconds": 5,
"messageType": 250,
"messageLength": 36
}
}
- body (object)
- message: (object) - Contains the contents of the event.
- aggregateGpsSamples: (array[objects]) - Contains the GPS messages.
(object)
- gpsTimestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- latitude: (number)
- longitude: (number)
- numberSatellitesInView (number) - How many satellites the device is tracking for GPS.
- courseOverGroundInDeg (number) - Indicates change in course over ground in degrees relative to true north.
- hdopRange: (string) - Horizontal Dilution of Precision expressed as a string.
- speed: (number) - Speed in KPH or MPH.
- speedType: (enum[string]) - Where the speed was obtained.
Members:
- `Vehicle` - Wheel-based speed obtained from the vehicle bus.
- `Gps` - GPS speed.
Battery Metrics Message
Describes battery metrics collected during a trip as well as resting battery voltage recorded during the vehicle-off interval before the current trip began.
{
"header": {...},
"body": {
"footer": 124,
"message": {
"type": "BatteryMetricsMessage",
"engineTimeToStartInMs": 13,
"restingBatteryVoltage": 12.6,
"averageInTripVoltage": 12.1,
"minimumBatteryVoltage": 9.3
},
"header": {
"timestamp": "2018-10-09T16:50:23-04:00",
"tripType": "Trip",
"tripNumber": 1,
"messageType": 33,
"messageLength": 8,
"latitude": 41.34494,
"longitude": 81.30904,
"fixQuality": "StoredFix",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 123456
}
}
}
- body: (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- engineTimeToStartInMs: (number) - The time recorded until engine start after the first crank pulse was detected in milliseconds.
- restingBatteryVoltage: (number) - The resting battery voltage, recorded at a configured time after the previous trip end in volts.
- averageInTripVoltage: (number) - The average battery voltage during the trip in volts.
- minimumBatteryVoltage: (number) - The minimum voltage recorded after the end of the previous trip in volts.
- header: (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: `33` (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Bluetooth External Device Message
This event sends information about specific drivers detected in the vehicle via Bluetooth® beacon cards. Up to four beacons can be detected, and information about the beacons—including their unique MAC addresses and their relative signal strengths (visibilityScore)—are contained in the externalDeviceInfo object.
{
"header": {...},
"body": {
"footer": 27,
"message": {
"type": "BluetoothExternalDeviceMessage",
"externalDeviceInfo": [
{
"type": "BeaconInfo",
"bluetoothAddress": "FC:3B:FB:07:75:52",
"visibilityScore": 200
}
]
},
"header": {
"timestamp": "2019-04-11T16:59:47-04:00",
"tripType": "Trip",
"tripNumber": 26,
"messageType": 30,
"messageLength": 10,
"latitude": 0,
"longitude": 0,
"fixQuality": "FixInvalid",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 177
}
}
}
- body: (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- externalDeviceInfo: (array[object])
- (object)
- type: (string) - Specifies the category of fields in this object.
- bluetoothAddress: (number) - Unique MAC address used to identify the Bluetooth® beacon.
- visibilityScore: (number) - Relative indicator of signal strength. A lower score is a stronger signal.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Connect Event
This event serves as a notification that a device has been plugged in to a vehicle's OBD-II port.
{
"header": {...},
"body": {
"footer": 83,
"message": {
"type": "ConnectDisconnectEvent",
"eventType": "Connect",
"eventTime": "2017-06-01T11:42:13-05:00",
"firmwareVersion": "07.2E",
"cfgVersion": "JHGDL13",
"keyOnOffDisconnect": "KeyOffDisconnect",
"odometer": 28807,
"odometerInfo": "VehicleOdometer"
},
"header": {
"timestamp": "2017-06-01T11:42:14-05:00",
"tripType": "Trip",
"tripNumber": 2,
"messageType": 14,
"messageLength": 32,
"latitude": 42.28911,
"longitude": -83.72973,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 0
}
}
}
- body: (object)
- footer: 83 (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- eventType: (string) - Further specifies the type of event.
- eventTime: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- firmwareVersion: (string) - The name of the firmware file that the device is running.
- cfgVersion: (string) - The name of the configuration file that the device is running.
- keyOnOffDisconnect: (enum[string]) - This field has no meaning when the eventType is Connect.
- odometer: (number) - Vehicle odometer or device-calculated odometer (see odometerInfo for differentiator).
- odometerInfo: (enum[string]) - Indicates whether the odometer value is read from the vehicle or the device.
- Members:
- Calculated - Indicates that the odometer value came from the device.
- VehicleOdometer - Indicates that the odometer value was read from the vehicle.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a contextual type for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Disconnect Event
This event serves as a notification that a device has been unplugged from a vehicle's OBD-II port.
{
"header": {...},
"body": {
"footer": 128,
"message": {
"type": "ConnectDisconnectEvent",
"eventType": "Disconnect",
"eventTime": "2017-08-29T17:46:58-05:00",
"firmwareVersion": "07.2E",
"cfgVersion": "JHGDL13",
"keyOnOffDisconnect": "KeyOffDisconnect",
"odometer": 135857,
"odometerInfo": "VehicleOdometer"
},
"header": {
"timestamp": "2017-08-29T17:46:58-05:00",
"tripType": "Trip",
"tripNumber": 890,
"messageType": 14,
"messageLength": 32,
"latitude": 42.47808,
"longitude": -83.45092,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 5623
}
}
}
body: (object)
- footer: 128 (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: ConnectDisconnectEvent (string) - Indicates a type for this event.
- eventType: Disconnect (string) - Further specifies the type of event.
- eventTime: 22017-08-29T17:46:58-05:00 (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- firmwareVersion: 07.2E (string) - The name of the firmware file that the device is running.
- cfgVersion: JHGDL13 (string) - The name of the configuration file that the device is running.
- keyOnOffDisconnect: KeyOffDisconnect (enum[string])
- Members:
- KeyOnDisconnect
- KeyOffDisconnect
- odometer: 135857 (number) - Vehicle odometer or device-calculated odometer (see odometerInfo for differentiator). Device calcuted odometer is reported in kilometers.
- odometerInfo: VehicleOdometer (enum[string]) - Indicates whether the odometer value is read from the vehicle or the device.
- Members:
- Calculated - Indicates that the odometer value came from the device.
- VehicleOdometer - Indicates that the odometer value was read from the vehicle.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Device Health Event
This event warns of a fault or issue with the device.
{
"header": {...},
"body": {
"footer": 102,
"message": {
"type": "DeviceHealthEvent",
"faultGroup": "Information",
"faultInformation": {
"type": "ConfigFailure",
"primaryAndSecondaryErrorCount": 0,
"temporaryErrorCount": 0
},
"faultId": 29,
"faultRecoveryAction": "SafeMode",
},
"header": {
"timestamp": "2017-11-18T16:14:34-05:00",
"tripType": "IgnitionOff",
"tripNumber": 35,
"messageType": 15,
"messageLength": 6,
"latitude": 0,
"longitude": 0,
"fixQuality": "FixInvalid",
"vehicleProtocolId": "NoProtocol",
"odo": 100
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: `DeviceHealthEvent` (string) - Indicates a type for this event.
- faultGroup: (enum[string]) - Assigns a category for the type of fault the device is encountering.
- Members:
- `Critical`
- `Major`
- `Information`
- `Unknown`
- faultInformation: (object) - Contains information about the fault.
- type: (enum[string]) - Indicates the type of error the device is encountering.
- Members:
- `ExcessiveDataTransmit`
- `MissingSpeedInfo`
- `FOTAErrorCodes`
- `OBDFault`
- `TimeZone`
- `VehicleCrankInfo`
- `BrownoutDetected`
- temporaryErrorCount: (number) - Information based on the `type` of fault.
- primaryAndSecondaryErrorCount: (number) - Information based on the `type` of fault.
- faultId: (number) - Corresponds to the `type` of fault listed in the `faultInformation` object.
- faultRecoveryAction: (enum[string) - One of seven actions that the device took to correct the fault.
- Members:
- `ClearFault`
- `KillDevice`
- `SuspendDevice`
- `ResetDevice`
- `NoAction`
- `SafeMode`
- `Unknown`
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
DTC (Current) Info
This event is generated whenever a MIL status or DTC count changes and a current DTC exists in the vehicle. The device can be configured to check for DTCs once per trip or at periodic intervals.
{
"header": {...},
"body": {
"footer": 67,
"message": {
"type": "VehicleCurrentDTCInfo",
"milStatus": true,
"dtcSpnOrPidRecords": [
"P3412",
"C2745",
"B0888",
"P2222"
]
},
"header": {
"timestamp": "2017-11-16T17:31:28-05:00",
"tripType": "Trip",
"tripNumber": 33,
"messageType": 18,
"messageLength": 15,
"latitude": 0,
"longitude": 0,
"fixQuality": "FixInvalid",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 400
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- milStatus: (boolean) - Whether the Malfunction Indicator Lamp is on or not.
- dtcSpnOrPidRecords: (array[string]) - A list of up to 10 current DTC codes.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
DTC (Pending) Info
This event is generated whenever a pending DTC exists in the vehicle. The device can be configured to check for DTCs once per trip or at periodic intervals.
{
"header": {...},
"body": {
"footer": 229,
"message": {
"type": "VehiclePendingDTCInfo",
"dtcRecords": [
"P3412"
]
},
"header": {
"timestamp": "2017-05-29T14:47:58-05:00",
"tripType": "Trip",
"tripNumber": 38,
"messageType": 51,
"messageLength": 10,
"latitude": 0,
"longitude": 0,
"fixQuality": "FixInvalid",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 101928
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- dtcSpnOrPidRecords: (array[string]) - A list of up to 10 pending DTC codes.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
First Plugin Event
This event is generated when a device is plugged in and powered for the very first time. This event only occurs once in the lifetime of a device, and is not repeated when a device is unplugged and then plugged back in, even into a different vehicle (these events are called Connect Events).
{
"header": {...},
"body": {
"footer": 152,
"message": {
"type": "FirstPluginEvent",
"firmwareVersion": "07.2E",
"configVersion": "072E.1",
"odometerValue": 0,
"additionalInfo": "Calculated",
"vin": "1F1G05GV2B1049415"
},
"header": {
"timestamp": "2017-08-03T15:37:32-04:00",
"tripType": "Trip",
"tripNumber": 0,
"messageType": 40,
"messageLength": 40,
"latitude": 42.27383,
"longitude": -83.72953,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 0
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- firmwareVersion: (string) - The name of the firmware file that the device is running.
- configVersion: (string) - The name of the configuration file that the device is running.
- odometerValue: (number) - Vehicle odometer or device-calculated odometer (see `additionalInfo` for differentiator). Device calcuted odometer is reported in kilometers.
- additionalInfo: (enum[string]) - Indicates whether the `odometerValue` is read from the vehicle or the device.
- Members:
- `Calculated` - Indicates that the `odometer` value came from the device.
- `VehicleOdometer` - Indicates that the `odometer` value was read from the vehicle.
- vin: (string) - Vehicle Identification Number provided by the vehicle. Empty string when VIN is unavailable.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Fuel Consumed
Provides a calculation of the fuel consumed during a trip based on the OBD-II PID used and the type of fuel the vehicle uses. All calculations are provided; the user must determine which calculation applies.
{
"header": {...},
"body": {
"footer": 186,
"message": {
"type": "FuelConsumed",
"obdPidId": 16,
"propaneConsumedInTripInGallons": 0.3003645952,
"dieselConsumedInTripInGallons": 0.33405971456,
"gasolineConsumedInTripInGallons": 1.309016064
},
"header": {
"timestamp": "2019-05-31T18:34:58-07:00",
"tripType": "IgnitionOff",
"tripNumber": 369,
"messageType": 69,
"messageLength": 14,
"latitude": 34.51569,
"longitude": -117.36343,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 12240
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- obdPidId: (number) - The OBD-II PID used by the device to calculate the fuel consumed in decimal format. This number will be either 16 (MAF) or 94 (EFR).
- propaneConsumedInTripInGallons: (number) - The fuel consumptin calculation if the vehicle uses propane.
- dieselConsumedInTripInGallons: (number) - The fuel consumptin calculation if the vehicle uses diesel.
- gasolineConsumedInTripInGallons: (number) - The fuel consumptin calculation if the vehicle uses gasoline.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Fuel Level Change Event
This event message is generated whenever there is a significant change in Fuel Level between the Trip End and Trip Start.
{
"header": {...},
"body": {
"footer": 227,
"message": {
"type": "FuelLevelChangeEvent",
"fuelEventType": "FuelLevelDecrease",
"previousFuelLevel": 54,
"currentFuelLevel": 14,
"cumulativeFuelConsumed": 5.394000053405762
},
"header": {
"timestamp": "2017-03-31T20:12:18-05:00",
"tripType": "IgnitionOff",
"tripNumber": 3,
"messageType": 17,
"messageLength": 37,
"latitude": 42.27993,
"longitude": -83.74799,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 88
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- fuelEventType: (enum[string]) - Indicates whether fuel has increased or decreased
- Members
- `FuelLevelIncrease`
- `FuelLevelDecrease`
- previousFuelLevel: (number) - Percentage
- currentFuelLevel: (number) - Percentage
- cumulativeFuelConsumed: (number) - Resolution of 0.001 gallons
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a contextual type for this event.
- Members
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) -
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The type of protocol the device detected on the vehicle bus.
- Members
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
GPS Message
The device uses GPS and GLONASS to provide its location at configurable periodic intervals and based on triggers.
{
"header": {...},
"body": {
"footer": 186,
"message": {
"type": "GPSMessage",
"messageTriggerReason": "IgnitionOnPeriodic",
"cog": 0,
"obdSpeed": 0,
"height": 276,
"tripDistance": 0,
"vehicleODOStatus": "VehicleODONotSupported",
"obdAverageSpeed": 0,
"hdop": 0.9,
"sv": 7,
"obdMaxSpeed": 0,
"tripIdlingTime": 0,
"sog": 0,
"fixQuality": "GPS3DFix"
},
"header": {
"timestamp": "2017-10-03T15:37:32-04:00",
"tripType": "IgnitionOff",
"tripNumber": 2,
"messageType": 1,
"messageLength": 16,
"latitude": 42.47858,
"longitude": -83.45230,
"fixQuality": "FixOk",
"vehicleProtocolId": "NoProtocol",
"odo": 0
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- messageTriggerReason: (enum[string]) - One of 11 possible triggers for this GPS event.
- Members
- `IgnitionOnPeriodic`
- `COG`
- `Distance`
- `TripStart`
- `TripEnd`
- `KeyOff` - This trigger reason is called a Heartbeat Event.
- `FirstGPSFixInTrip`
- `EMTK`
- `TowingStart`
- `TowingEnd`
- `OnDemandPing`
- `Unknown`
- cog: (number) - Indicates change in course over ground in degrees relative to true north.
- obdSpeed: (number) - Vehicle speed in KPH.
- height: (number) - Height above sea level in meters.
- tripDistance: (number) - Distance traveled thus far in the trip in kilometers (resolution is 0.1km).
- vehicleODOStatus: (enum[string]) - Indicates whether or not the device can read from the vehicle's odometer.
- Members
- `VehicleODONotSupported` - Vehicle odometer readings are not supported.
- `VehicleODOSupported` - Vehicle odometer readings are supported.
- obdAverageSpeed: (number) - Average vehicle speed thus far in the trip in KPH.
- hdop: (number) - Horizontal Dilution of Precision.
- sv: (number) - How many satellites the device is tracking for GPS.
- obdMaxSpeed: (number) - Maximum recorded speed thus far in the trip in KPH.
- tripIdlingTime: (number) - Amount of time spent idling thus far in the trip in seconds.
- sog: (number) - Speed over ground.
- fixQuality: (enum[string]) - Indicates the validity and accuracy of the GPS data.
- Members:
- `GPSNoFix` - Latitude and longitude are invalid.
- `GPS2DFix` - Latitude and longitude are valid.
- `GPS3DFix` - Latitude and longitude are valid.
- `Unknown`
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device is not able to get a GPS fix.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
GPS Outage Event
Notification of the device's inability to obtain a GPS fix. A start of outage and end of outage message are sent.
{
"header": {...},
"body": {
"footer": 68,
"message": {
"type": "GPSOutageEvent",
"eventType": "EndOfOutage",
"lastLatitude": 42.47858,
"lastLongitude": -83.45230,
"startTime": "2019-06-03T16:05:45-04:00",
"startODO": 109235,
"duration": 2,
},
"header": {
"timestamp": "2019-06-03T16:07:45-04:00",
"tripType": "Trip",
"tripNumber": 2,
"messageType": 13,
"messageLength": 18,
"latitude": 42.47858,
"longitude": -83.45230,
"fixQuality": "StoredFix",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 109238
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- eventType: (enum[string]) - One of two subtypes for this event.
- Members:
- `StartOfOutage`
- `EndOfOutage`
- lastLatitude: (number) - The last recorded valid latitude.
- lastLongitude: (number) - The last recorded valid longitude.
- startTime: (string) - ISO 8601-formatted time stamp showing when the outage began.
- startODO: (number) - Vehicle odometer or device-calculated odometer at the beginning of the outage. Device-calcuted odometer is reported in kilometers.
- duration: (number) - The duration of the outage in minutes. This field only applies to the `EndOfOutage` event type.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device is not able to get a GPS fix.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Hard Acceleration Message
An acceleration event is generated if the vehicle's acceleration and speed are greater than or equal to the device's configured thresholds. This event can contain data collected over multiple seconds.
{
"header": {...},
"body": {
"footer": 209,
"message": {
"type": "HardAccelerationMessage",
"initialSpeed": 6,
"finalSpeed": 22,
"maxAcceleration": 16
},
"header": {
"timeStamp": "2017-11-18T16:14:34-05:00",
"tripType": "Trip",
"tripNumber": 304,
"messageType": 5,
"messageLength": 4,
"latitude": 42.47879,
"longitude": -83.45558,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO9141",
"odo": 375
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object ) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- initialSpeed: (number) - Vehicle speed at the beginning of the acceleration event in KPH.
- finalSpeed: (number) - Vehicle speed at the end of the acceleration event in KPH.
- maxAcceleration: (number) - Maximum acceleration reached during the event in KPH/s.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Hard Brake Message
A hard braking event is generated if the vehicle's deceleration and speed are greater than or equal to the device's configured thresholds. This event can contain data collected over multiple seconds.
{
"header": {...},
"body": {
"footer": 195,
"message": {
"type": "HardBrakeMessage",
"initialSpeed": 52,
"finalSpeed": 21,
"maxBraking": 16
},
"header": {
"timestamp": "2017-08-24T19:20:56-04:00",
"tripType": "Trip",
"tripNumber": 43,
"messageType": 4,
"messageLength": 4,
"latitude": 42.33395,
"longitude": -84.98961,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_29_BIT_CAN",
"odo": 565
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- initialSpeed: (number) - Vehicle speed at the beginning of the braking event in KPH.
- finalSpeed: (number) - Vehicle speed at the end of the brakin event in KPH.
- maxBraking: (number) - Maximum braking rate reached during the event in KPH/s.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Heartbeat Event
If no other activity has taken place, the device sends a GPS event 24 hours after its last connection to provide its location.
{
"header": {...},
"body": {
"footer": 186,
"message": {
"type": "GPSMessage",
"messageTriggerReason": "KeyOff",
"cog": 0,
"obdSpeed": 0,
"height": 0,
"tripDistance": 0,
"vehicleODOStatus": "VehicleODONotSupported",
"obdAverageSpeed": 0,
"hdop": 0,
"sv": 0,
"obdMaxSpeed": 0,
"tripIdlingTime": 0,
"sog": 0,
"fixQuality": "GPSNoFix"
},
"header": {
"timestamp": "2016-10-03T15:37:32-04:00",
"tripType": "IgnitionOff",
"tripNumber": 2,
"messageType": 1,
"messageLength": 16,
"latitude": 0,
"longitude": 0,
"fixQuality": "FixInvalid",
"vehicleProtocolId": "NoProtocol",
"odo": 0
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- messageTriggerReason: `KeyOff` (enum[string])
- cog: (number) - Indicates change in course over ground in degrees relative to true north.
- obdSpeed: (number) - Vehicle speed in KPH.
- height: (number) - Height above sea level in meters.
- tripDistance: (number) - Distance travelled thus far in the trip in kilometers.
- vehicleODOStatus: (enum[string]) - Indicates whether or not the device can read from the vehicle's odometer.
- Members:
- `VehicleODONotSupported` - Vehicle odometer readings are not supported.
- `VehicleODOSupported` - Vehicle odometer readings are supported.
- obdAverageSpeed: (number) - Average vehicle speed thus far in the trip in KPH.
- hdop: (number) - Horizontal Dilution of Precision.
- sv: (number) - How many satellites the device is tracking for GPS.
- obdMaxSpeed: (number) - Maximum recorded speed thus far in the trip in KPH.
- tripIdlingTime: (number) - Amount of time spent idling thus far in the trip in seconds.
- sog: (number) - Speed over ground.
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `GPSNoFix` - Latitude and longitude are invalid.
- `GPS2DFix` - Latitude and longitude are valid.
- `GPS3DFix` - Enhanced accuracy for latitude and longitude.
- `Unknown`
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: `(string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a contextual type for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The type of protocol the device detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off or being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Idling Message
An idling event is generated if the vehicle's speed is less than or equal to the configured threshold for a configured amount of time.
{
"header": {...},
"body": {
"footer": 5,
"message": {
"type": "IdlingMessage",
"startTime": "2017-08-20T17:27:50Z",
"duration": 566
},
"header": {
"timestamp": "2017-08-20T13:37:18-04:00",
"tripType": "Trip",
"tripNumber": 21,
"messageType": 6,
"messageLength": 7,
"latitude": 42.29932,
"longitude": -85.19763,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_29_BIT_CAN",
"odo": 190
}
}
}
- body: (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- startTime: (string) - ISO 8601-formatted time stamp showing when the event began.
- duration: (number) - The duration of the idling event in seconds.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a contextual type for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
IO Extender Analog Digital Channel Event
This event provides input data and digital output status data for analog channels if an IO extender module is attached to the device.
{
"header": {...},
"body": {
"footer": 0,
"message": {
"type": "IoExtenderAnalogDigitalChannelEvent",
"analogChannel0": 0.008813186548650265,
"analogChannel1": 0.0,
"analogChannel2": 0.0,
"analogChannel3": 0.0,
"analogChannel4": 0.0,
"analogChannel5": 0.0,
"isDigitalOutputHigh": false
},
"header": {
"timestamp": "2017-03-16T14:29:11-04:00",
"tripType": "Trip",
"tripNumber": 35,
"messageType": 54,
"messageLength": 15,
"latitude": 42.47819,
"longitude": -83.45089,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 537
}
}
}
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a contextual type for this event.
- Members
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
OBD-II PID Event
PID Events are triggered by conditions in the vehicle.
{
"header": {...},
"body": {
"footer": 126,
"message": {
"pidId": 15,
"pidValue": 68
},
"header": {
"timestamp": "2018-06-29T10:12:09+02:00",
"tripType": "Trip",
"tripNumber": 92,
"messageType": 2,
"messageLength": 6,
"latitude": 43.96417,
"longitude": 1.82206,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 17364
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- pidId: (string) - Indicates the OBD-II PID reporting data.
- pidValue: (various) - The data provided by the PID. Could be an int, a map, a string, or an enum[string].
Real Time Disconnect Event
This event serves as a near real-time notification that a device has been unplugged from a vehicle's OBD-II port.
{
"header": {...},
"body": {
"footer": 212,
"message": {
"type": "RealTimeDisconnectEvent",
"isKeyOn": false,
"vin": "JM1BK343551221507",
"vehicleLastKnownLoc": 0,
"vehicleOdoAvailable": false,
"vehicleOdometer": 0,
"calculatedOdometer": 1667,
},
"header": {
"timestamp": "2017-08-22T16:08:10-04:00",
"tripType": "IgnitionOff",
"tripNumber": 92,
"messageType": 53,
"messageLength": 30,
"latitude": 42.27870,
"longitude": -83.74756,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 1667
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- isKeyOn: (boolean) - Indicates whether the vehicle was on at the time the device was disconnected.
- vin: (string) - Vehicle Identification Number provided by the vehicle.
- vehicleLastKnownLoc: (number) - Distance travelled from the most recent GPS fix before being unplugged in kilometers.
- vehicleOdoAvailable: (boolean) - Indicates whether the odometer value is read from the vehicle or the device.
- vehicleOdometer: (number) - Vehicle odometer value.
- calculatedOdometer: (number) - Device-calcuted odometer in kilometers.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a contextual type for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Speeding End Event
This event provides summarization of a high or critical speeding event after the vehicle's speed has dropped below the configured trigger velocity.
{
"header": {...},
"body": {
"footer": 253,
"message": {
"type": "OverSpeedingMessageEnd",
"overSpeedType": "HighSpeed",
"startTime": "2017-06-26T02:20:20Z",
"initialLatitude": 42.04869079589844,
"initialLongitude": -86.49169921875,
"startODO": 6163,
"duration": 158,
"distance": 5.300000190734863,
"peakSpeed": 124,
"averageSpeed": 122
},
"header": {
"timestamp": "2017-06-25T22:22:58-04:00",
"tripType": "Unknown",
"tripNumber": 327,
"messageType": 3,
"messageLength": 24,
"latitude": 42.06966,
"longitude": -86.43349,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 6168
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- overSpeedType: (enum[string]) - A more specific category for this event.
- Members
- `HighSpeed`
- `CriticalSpeed`
- `Unknown`
- startTime: (string) - ISO 8601-formatted time stamp showing when the event began.
- initialLatitude: (number)
- initialLongitude: (number)
- startODO: (number) - Vehicle or device odometer reading at the beginning of the event. Device-calcuted odometer is reported in kilometers.
- duration: (number) - Duration of speeding event in seconds.
- distance: (number) - Distance traveled during speeding event in kilometers.
- peakSpeed: (number) - The maximum speed reached during this event in KPH.
- averageSpeed: (number) - The average speed during this event in KPH.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The type of protocol the device detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off or being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Speeding Start Event
This event provides notification of a high or critical speeding event after the configured trigger criteria have been met, but before the event is over, so some fields are not available.
{
"header": {...},
"body": {
"footer": 253,
"message": {
"type": "OverSpeedingMessageStart",
"startTime": "2017-06-26T02:20:20Z",
"initialLatitude": 42.04869079589844,
"initialLongitude": -86.49169921875,
"startODO": 6163
},
"header": {
"timestamp": "2017-06-25T22:22:58-04:00",
"tripType": "Unknown",
"tripNumber": 327,
"messageType": 22,
"messageLength": 24,
"latitude": 42.04963,
"longitude": -86.49064,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 6163
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- startTime: (string) - ISO 8601-formatted time stamp showing when the event began.
- initialLatitude: (number)
- initialLongitude: (number)
- startODO: (number) - Vehicle or device odometer reading at the beginning of the event. Device-calcuted odometer is reported in kilometers.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: `22` (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The type of protocol the device detected on the vehicle bus.
- Members
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Trip End Event
This event serves as a notification that a trip has ended and provides some summary information about the trip.
{
"header": {...},
"body": {
"footer": 94,
"message": {
"type": "TripEndEvent",
"tripTime": 1158,
"distanceTravelled": 6.0,
"cumulativeRunningTime": 113,
"calculatedFuelConsumed": 0.28800000000000003,
"avgSpeed": 37,
"maxSpeed": 69,
"highSpeedEventCounts": 0,
"highSpeedDuration": 0,
"criticalSpeedEventCounts": 0,
"criticalSpeedDuration": 0,
"tripIdleTime": 586,
"cumulativeIdleTime": 39,
"hardAcclCounts": 0,
"hardBreakingCounts": 0,
"consumedAir": 11868.81
},
"header": {
"timestamp": "2017-01-01T15:21:40-05:00",
"tripType": "IgnitionOff",
"tripNumber": 485,
"messageType": 9,
"messageLength": 35,
"latitude": 41.46466,
"longitude": -81.51720,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 3743
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string ) - Indicates a type for this event.
- tripTime: (number) - Duration of the trip in seconds.
- distanceTravelled: (number) - Distance travelled during the trip in kilometers (resolution of 0.1km).
- cumulativeRunningTime: (number) - Time the engine has run since the device was connected in hours.
- calculatedFuelConsumed: (number) - Amount of fuel consumed during the trip in gallons.
- avgSpeed: (number) - Average vehicle speed during the trip in KPH.
- maxSpeed: (number) - Maximum vehicle speed reached during the trip in KPH.
- highSpeedEventCounts: (number) - Number of high speed events during the trip.
- highSpeedDuration: (number) - Time spent in high speed events during the trip in seconds.
- criticalSpeedEventCounts: (number) - Number of critical speed events during the trip.
- criticalSpeedDuration: (number) - Time spent in critical speed events during the trip in seconds.
- tripIdleTime: (number) - Time the engine spent idling during the trip in seconds.
- cumulativeIdleTime: (number) - Time the engine has been idling since the device was connected in hours.
- hardAcclCounts: (number) - Number of hard acceleration events during the trip.
- hardBreakingCounts: (number) - Number of hard braking events during the trip.
- consumedAir: (number) - Amount of air consumed during the trip in grams (totalled from the Mass Airflow Sensor).
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Trip Start Event
This event serves as a notification that a trip has begun and provides information such as the trip number, VIN, and device IMEI.
{
"header": {...},
"body": {
"footer": 58,
"message": {
"type": "TripStartEvent",
"tripNumber": 46,
"milStatus": 0,
"vin": "1C16G05GV2B104942",
"imei": "354235053108415"
},
"header": {
"timestamp": "2017-02-13T15:04:49-05:00",
"tripType": "Trip",
"tripNumber": 46,
"messageType": 8,
"messageLength": 40,
"latitude": 42.28004,
"longitude": -83.74847,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 97
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- milStatus: (number) - Always zero.
- vin: (string) - Vehicle Identification Number provided by the vehicle.
- imei: (string) - International Mobile Equipment Identity number, unique to every Danlaw Datalogger.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer.Device-calcuted odometer is reported in kilometers.
Vehicle Battery Event
This event provides information about OBD-II PIDs and the vehicle's battery.
{
"body": {
"footer": 90,
"message": {
"type": "OBDPidAndVehicleBatteryEvent",
"value": 11.538384437561035,
"eventCount": 0,
"eventType": {
"type": "BatteryEvent",
"data": "CriticalBatteryWarning"
}
},
"header": {
"timeStamp": "2017-08-19T18:51:19-04:00",
"tripNumber": 3,
"tripType": "IgnitionOff",
"messageType": 7,
"messageLength": 11,
"latitude": 0,
"longitude": 0,
"fixQuality": "FixInvalid",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 0
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- value: (number) - Voltage of the battery in volts.
- eventCount: (number) - The number of times this event occurred during the trip.
- eventType: (object) - Contains the data for the event.
- type: (string) - Indicates a more specific type for this event.
- data: (enum[string]) - Further information about the battery event.
- Members:
- `ReturnToNormalVoltage`
- `LowBatteryInfo`
- `LowBatteryWarning`
- `LowChargingSystemConcernSet`
- `HighChargingSystemConcernSet`
- `LowChargingSystemConcernReset`
- `HighChargingSystemConcernReset`
- `ExcessiveDrainAlertSet`
- `ExcessiveDrainAlertTripStartReset`
- `ExcessiveDrainAlertReset`
- `Unknown`
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a contextual type for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Vehicle MIL Info
This event indicates that the Malfunction Indicator Lamp has been turned on by the vehicle's computer, and provides related information about DTCs.
{
"body": {
"footer": 112,
"message": {
"type": "VehicleMILInfo",
"milStatus": true,
"milDistance": 1000,
"milTime": 1000,
"dtcCount": 11,
"clrTime": 0,
"clrDistance": 0,
"deviceTripTime": 6633,
"deviceTripDistance": 8,
},
"header": {
"timestamp": "2016-11-16T17:31:42-05:00",
"tripType": "Trip",
"tripNumber": 33,
"messageType": 50,
"messageLength": 19,
"latitude": 0,
"longitude": 0,
"fixQuality": "FixInvalid",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 8
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- milStatus: (boolean) - Whether the Malfunction Indicator Lamp is on or not.
- milDistance: (number) - Distance traveled with MIL on in kilometers.
- milTime: (number) - Time traveled with MIL on in minutes.
- dtcCount: (number) - Number of current DTCs.
- clrTime: (number) - Time since a DTC was cleared in minutes.
- clrDistance: (number) - Distance traveled since a DTC was cleared in kilometers.
- deviceTripTime: (number) - Accumulated trip time since the first time device stored this MIL info in seconds.
- deviceTripDistance: (number) - Accumulated distance travelled during this trip since the first time device stored this MIL info in kilometers.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a contextual type for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the `type` field in the body of the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
Vehicle Movement Event
This event reports that a vehicle is in motion without being on, such as when it's being towed.
{
"body": {
"footer": 30,
"message": {
"movementEventType": "Stopped",
"type": "VehicleMovementEvent"
},
"header": {
"timestamp": "2016-02-05T12:56:03-05:00",
"tripType": "Trip",
"tripNumber": 26,
"messageType": 16,
"messageLength": 2,
"latitude": 42.47832,
"longitude": -83.45087,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 46
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- movementEventType: (enum[string]) - Whether the vehicle is still in motion or has stopped when this event was generated.
- Members:
- `Moving`
- `Stopped`
- `Unknown`
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members:
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were off.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.
VIN Change Event
This event is generated when the Datalogger detects a change in VIN, which will occur after the device is powered on by a trip start.
{
"body": {
"footer": 227,
"message": {
"type": "VINChangeEvent",
"oldVin": "1C16G05GV2B104942",
"newVin": "JM1BK343551221507"
},
"header": {
"tripType": "Trip",
"tripNumber": 3,
"messageType": 17,
"messageLength": 37,
"timeStamp": "2017-03-31T20:12:18-05:00",
"latitude": 42.27994,
"longitude": -83.74799,
"fixQuality": "FixOk",
"vehicleProtocolId": "ISO15765_11_BIT_CAN",
"odo": 0
}
}
}
- body (object)
- footer: (number) - Contains a checksum for the message contents.
- message: (object) - Contains the contents of the event.
- type: (string) - Indicates a type for this event.
- oldVin: (string) - Previously stored Vehicle Identification Number.
- newVin: (string) - Current Vehicle Identification Number.
- header (object) - UDP-specifc object containing meta-data about the event.
- timestamp: (string) - ISO 8601-formatted time stamp showing when the event was produced on the device.
- tripType: (enum[string]) - Indicates a context for this event.
- Members
- `IgnitionOff`
- `Trip`
- `Idling`
- `Unknown`
- tripNumber: (number) - A sequential number that increases after each trip. Resets after 65,536 trips.
- messageType: (number) - A unique number that correlates to the string in the `type` field in the message.
- messageLength: (number) - Indicates the total bytes of the message, including the checksum.
- latitude: (number)
- longitude: (number)
- fixQuality: (enum[string]) - The validity and accuracy of the GPS data.
- Members:
- `FixOk` - 2D or 3D fix. Latitude and longitude are valid.
- `StoredFix` - Latitude and longitude are readings from (up to) 5 seconds ago, because the device has not been able to get a GPS fix for 5 seconds.
- `FixInvalid` - Latitude and longitude are invalid.
- `Unknown` - The platform cannot decode the value.
- vehicleProtocolId: (enum[string]) - The protocol detected on the vehicle bus.
- Members:
- `NoProtocol` - Would only appear if a vehicle were being towed.
- `J1850VPW`
- `J1850PWM`
- `ISO9141`
- `ISO14230_FIVE_BAWD`
- `ISO14230_FAST_INIT`
- `ISO15765_11_BIT_CAN`
- `ISO15765_29_BIT_CAN`
- `J1939`
- `J1708`
- `Unknown`
- odo: (number) - Vehicle odometer or device-calculated odometer. Device-calcuted odometer is reported in kilometers.