Embedded Files
Description
Description
Message containing GPS breadcrumb data coming from the vehicle.
Broker(s)
Broker(s)
[[SQS]]
M2M Topic
M2M Topic
p.{companyId}.mos.{vehicleNumber}.breadcrumb
Schema
Schema
{
"breadCrumbDateTime": {
"Type": "String",
"Description": "GMT timestamp of the breadcrumb event. In the format 'MM/dd/yyyy HH:mm:ss'. For example '11/14/2014 17:32:30'"
},
"performxFuel": {
"Type": "Integer",
"Description": "Fuel in 8ths of a gallon"
},
"location": {
"Type": "String",
"Description": "Text based reverse geocoded location of the vehicle"
},
"reason": {
"Type": "Integer",
"Description": "0:Unknown, 1:Mandatory Event, 2:Interval, 3:Stop Event, 4:Start Event, 5:Satellite Micro-Breadcrumb"
},
"performxOdometer": {
"Type": "Number",
"Description": "PerformX Odometer with 1 decimal place"
},
"sentDateTime": {
"Type": "String",
"Description": "GMT timestamp the PeopleNet servers processed the event. In the format 'MM/dd/yyyy HH:mm:ss'. For example '11/14/2014 17:32:30'"
},
"ignition": {
"Type": "Integer",
"Description": "Ignition is off('0'). Ignition is on('1')"
},
"type": {
"Type": "String",
"Description": "The type of the event. Always 'GPS Breadcrumb'"
},
"version": {
"Type": "Integer",
"Description": "Version of the event (i.e. 1)"
},
"gpsBcDistance": {
"Type": "Integer",
"Description": "Number of 1/32 mile increments the OBC traveled since the last breadcrumb"
},
"driverLoginId2": {
"Type": "String",
"Description": "Customer facing driver login Id"
},
"driverLoginId1": {
"Type": "String",
"Description": "Customer facing driver login Id"
},
"ambientTemp": {
"Type": "Integer",
"Description": "Fahrenheit degrees"
},
"performxPTO": {
"Type": "Integer",
"Description": "PTO seconds"
},
"locationFormat": {
"Type": "String",
"Description": "Format describing the contents of the location field"
},
"longitude": {
"Type": "Number",
"Description": "Decimal longitude with 7 decimal places (i.e. -93.4490465)"
},
"systemId": {
"Type": "Integer",
"Description": "0 to 99999"
},
"vid": {
"Type": "Integer",
"Description": "Vehicle ID"
},
"trailerId1": {
"Type": "String",
"Description": "Trailer Id"
},
"driverStatus2": {
"Type": "Integer",
"Description": "0:N/A, 1:Driving, 2:On Duty, 3:Off Duty, 4:Sleeper Berth"
},
"signalStrength": {
"Type": "Integer",
"Description": "0 - 7 where 0 indicates none and 7 indicates the strongest"
},
"did1": {
"Type": "Integer",
"Description": "PeopleNet id for driver 1"
},
"did2": {
"Type": "Integer",
"Description": "PeopleNet id for driver 2"
},
"gpsOdometer": {
"Type": "Number",
"Description": "GPS odometer with one decimal place"
},
"speed": {
"Type": "Integer",
"Description": "Speed in MPH from the GPS engine. If speed is null means it is unavailable. If speed is over 126, 126 is returned"
},
"trailerId2": {
"Type": "String",
"Description": "Trailer Id"
},
"pacosTripId": {
"Type": "Integer",
"Description": "Paco's trip. Null means unknown"
},
"performxSpeed": {
"Type": "Integer",
"Description": "Speed in MPH"
},
"vehicleNumber": {
"Type": "String",
"Description": "Company specific vehicle number"
},
"driverStatus1": {
"Type": "Integer",
"Description": "0:N/A, 1:Driving, 2:On Duty, 3:Off Duty, 4:Sleeper Berth"
},
"performxIdle": {
"Type": "Integer",
"Description": "Idle seconds"
},
"fuelLevel1": {
"Type": "Integer",
"Description": "Fuel Tank level percentage converted from what is reported by the device as follows (reported value * 0.4). Null value indicates unknown"
},
"gpsAntenna": {
"Type": "Integer",
"Description": "0:Good, 1:High, 2:Low, 3:Open"
},
"fuelLevel2": {
"Type": "Integer",
"Description": "Fuel Tank level percentage converted from what is reported by the device as follows (reported value * 0.4). Null value indicates unknown"
},
"dsn": {
"Type": "Integer",
"Description": "PeopleNet's device serial number"
},
"gpsQuality": {
"Type": "Integer",
"Description": "0:No fix available, 3:Excellent"
},
"latitude": {
"Type": "Number",
"Description": "Decimal latitude with 7 decimal places (i.e. 44.9217273)"
},
"companyId": {
"Type": "Integer",
"Description": "Identifies the company of the vehicle"
},
"heading": {
"Type": "String",
"Description": "Direction the vehicle is heading"
}
}
JSON Example
JSON Example
{
"breadCrumbDateTime":"07/22/2015 19:42:54",
"performxFuel":-1,
"location":"Minnetonka, MN; 1.0m W of Hopkins, MN; 13103 Brenwood Trl",
"reason":1,
"performxOdometer":0.0,
"sentDateTime":"07/22/2015 19:43:03",
"ignition":1,
"type":"GPS Breadcrumb",
"version":1,
"gpsBcDistance":0,
"driverLoginId2":null,
"driverLoginId1":"robdcvehtest1",
"ambientTemp":null,
"performxPTO":null,
"locationFormat":";C1;D2;AD",
"longitude":-93.449052,
"systemId":0,
"vid":56364,
"trailerId1":null,
"driverStatus2":0,
"signalStrength":0,
"did1":5984,
"did2":0,
"gpsOdometer":0.0,
"speed":0,
"trailerId2":null,
"pacosTripId":null,
"performxSpeed":0,
"vehicleNumber":"6010075",
"driverStatus1":0,
"performxIdle":-1,
"fuelLevel1":null,
"gpsAntenna":0,
"fuelLevel2":null,
"dsn":6010075,
"gpsQuality":3,
"latitude":44.9217243,
"companyId":57,
"heading":"N"
}
locationFormat Details
locationFormat Details
The Reverse Geocode engine supports nine possible formats including:
C1 - Nearest City
AD - Address
D2 - Second Nearest City with Distance
LS - Larger and Smaller City with Distance
IB - In Bounds
HN - House Number
NS - Nearest Street
NH - Nearest Highway
HS - Nearest Highway or Nearest Street
The application also supports the legacy text formats used by PFM2. These formats are mapped to the supported formats as shown below. In practice, these are the only formats exposed to customers and used by the PFM.
Legacy FormatTranslated Format
BS NH
${LS} ${HS}
;C1;AD;D2
;{C1};C1;{AD};${D2}
;AD;C1;D2
;{AD};AD;{C1};${D2}
;C1;D2;AD
;{C1};C1;{D2};${AD}
Report abuse