Terminal Device State Reports
GET
- Engine State
- Power State
- Model State
- RSSI Value (signal strength of the terminal)
- Local Information
- GPS State/Error
- WIFI Info/Error
- GSM/WIFI Antenna Type
- Machine: Request a Device State Report from the specified machine. If the requested terminal is not linked to a machine, this link will not appear.
- Terminal: Request a Device State Report from the specified terminal.
OAuth Scope Required: eq1
Request URI
GET https://sandboxapi.deere.com/platform/machines/{id}/deviceStateReports
Accept: application/vnd.deere.axiom.v3+json
Parameters
Parameter | Type | Description & Example | Default | In |
---|---|---|---|---|
id Required | string | Machine ID Example: 5432 | N/A | path |
lastKnown | boolean | If true, startDate and endDate won't be used. Send true to fetch lastKnown call History. Example: true | false | query |
startDate1 | datetime | Return DSR from the specified startDate. Example: 2010-10-04T 14:35:05.000Z | 2015-01-01T00:00:00.000Z | query |
endDate1 | datetime | Return DSR till the specified endDate. Example: 2010-10-04T 14:38:35.000Z | Current Time | query |
Response Details
Field | Type | Description & Example |
---|---|---|
time | datetime | UTC Timestamp of the DSR. Example: 2010-10-04T14: 35:05.000Z |
gatewayType1 | byte | This number identifies the type of gateway the report traveled through. Example: 2 |
location | Point | Shows the latitude, longitude, and altitude of the terminal at the time of this report. Example: See sample response below. |
minRSSI | measurementAsDouble | The minimum signal strength of the machine at the time of the report. Example: See sample response below. |
maxRSSI | measurementAsDouble | The maximum signal strength of the machine at the time of the report. Example: See sample response below. |
averageRSSI | measurementAsDouble | The average signal strength of the machine at the time of the report. Example: See sample response below. |
gpsFixTimestamp | datetime | UTC Timestamp. This value shows the date and time at which the GPS position of the machine was current. Example: 2010-10-04T14: 35:05.000Z |
engineState | byte | This number identifies the power state of the engine. Example: 1 |
terminalPowerState | byte | This number identifies the power state of the terminal. Example: 1 |
batteryLevel | measurementAsInteger | Battery level of the terminal. Example: See sample response below. |
cellModemState | byte | This number indicates whether any errors were occurring on the Cell Modem at the time of this report. Example: 0 |
cellModemAntennaState | byte | This number indicates whether any errors were occurring on the Cell Modem Antenna at the time of this report. Example: 1 |
gpsModemState | byte | This number indicates whether any errors were occurring on the GPS Modem at the time of this report. Example: 1 |
gpsAntennaState | byte | This number indicates whether any errors were occurring on the GPS Antenna at the time of this report. Example: 1 |
network | byte | Identifies the sattelite or cellular network through which the report was sent by the terminal. Example: 1 |
rssi | integer | Last reported RSSI (signal strength) of the network. Example: 7 |
gpsError | byte | This number identifies any gps error occured Example: 4 |
gpsFirmwareLevelError | byte | This number identifies any gps firmware error Example: 1 |
tetheringStatus | byte | This number identifies wifi tethering status Example: 0 |
apStatus | byte | This number identifies wifi access point(ap) status Example: 1 |
m2mMode | byte | This number identifies wifi machine to machine(m2m) mode Example: 1 |
tetheringConnected | byte | This number identifies wifi tethering connection Example: 1 |
apConnected | byte | This number identifies wifi access point connection Example: 1 |
m2mConnected | byte | This number identifies wifi machine to machine connection Example: 1 |
gsmAntennaType | byte | This number identifies gsm Antenna type Example: 7 |
wifiAntennaType | byte | This number identifies wifi Antenna type Example: 3 |
WiFiSSID | string | SSID being used for tethering at the time the message is generated Example: vatican |
antennaFailure | byte | This number identifies the antenna failure state Example: 1 |
failedToTether | byte | This number identifies the Tethering failure state Example: 0 |
failedToM2M | byte | This number identifies the machine to machine connection failure state Example: 0 |
Sample Response [JSON]
Content-Type: application/vnd.deere.axiom.v3+json
{ "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/machines/5432/deviceStateReports" } ], "total": 1, "values": [ { "@type": "DeviceStateReport", "time": "2010-10-04T14:35:05.000Z", "gatewayType": 2, "location": { "@type": "Point", "lat": "41.597164", "lon": "-90.54383", "altitude": { "@type": "measurementAsDouble", "unit": "meters", "valueAsDouble": "0.0" } }, "minRSSI": { "@type": "measurementAsDouble", "unit": "dbM", "valueAsDouble": "0.0" }, "maxRSSI": { "@type": "measurementAsDouble", "unit": "dbM", "valueAsDouble": "0.0" }, "averageRSSI": { "@type": "measurementAsDouble", "unit": "dbM", "valueAsDouble": "0.0" }, "gpsFixTimestamp": "2010-10-04T14:35:05.000Z", "engineState": 0, "terminalPowerState": 0, "batteryLevel": { "@type": "measurementAsInteger", "unit": "Percent", "valueAsInteger": "0" }, "cellModemState": 0, "cellModemAntennaState": 0, "gpsModemState": 0, "gpsAntennaState": 0, "network": 0, "rssi": 0, "gpsError": 0, "gpsFirmwareLevelError": 0, "tetheringStatus": 0, "apStatus": 0, "m2mMode": 0, "tetheringConnected": 0, "apConnected": 0, "m2mConnected": 0, "gsmAntennaType": 1, "wifiAntennaType": 3, "wifiSSID": "vatican", "antennaFailure": 0, "failedToTether": 0, "failedToM2M": 0 } ] }