GET
/machines/{id}/deviceStateReports
Device State Reports
Definitions
Become a beta tester for MachineMonitoring resources.
GET /machines /{id} /deviceStateReports
Device State Reports
A device state report is generated from a terminal at a specified time. The report contains the following information:
  • Engine State
  • Power State
  • Model State
  • RSSI Value (signal strength of the terminal)
  • Local Information
 
This report is specific to, and identified by, the terminal, regardless of which machine it is connected to. Device state report information is collected from the machine terminal. A device state report is created for each machine call-in.
Each requested DSR (one report for a single terminal request, and two or more for a multiple terminal request) links to
  • Machine: Request a Device State Report from the specified machine. If the requested terminal is not linked to a machine, this linkwill not appear.
  • Terminal: Request a Device State Report from the specified terminal.
 
Request URI
GET: https://apicert.soa-proxy.deere.com/platform/machines/{id}/deviceStateReports
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
startDate dateTime 2010-10-04T 14:35:05.000Z Returns DSRs from a specified date onward. N/A No.
endDate dateTime 2010-10-04T 14:38:35.000Z Returns DSRs from before a specified date. N/A No.
 
Response Details
Field Type Example Description
time dateTime 2010-10-04T14: 35:05.000Z UTC Timestamp of the DSR.
gatewayType byte 2 This number identifies the type of gateway the report traveled through.1
valueAsDouble double 12.0 The measured value as a double data type.
location point <lat> 41.178611 </lat> Shows the ID, latitude, longitude, and altitude (contains the valueAsDouble tag) of the terminal at the time of this report.
minRSSI abstract measurement <valueAsDouble> 12.0 </valueAsDouble> The minimum signal strength of the machine at the time of the report. Contains the valueAsDouble tag.
maxRSSI abstract measurement <valueAsDouble> 73.0 </valueAsDouble> The maximum signal strength of the machine at the time of the report. Contains the valueAsDouble tag.
averageRSSI abstract measurement <valueAsDouble> 42.0 </valueAsDouble> The average signal strength of the machine at the time of the report. Contains the valueAsDouble tag.
gpsFixTimestamp dateTime 2010-10-04T14: 35:05.000Z UTC Timestamp. This value shows the date and time at which the GPS position of the machine was current.
engineState byte 1 This number identifies the power state of the engine.
terminalPowerState byte 1 This number identifies the power state of the terminal.
batteryLevel See example below. 1 Battery level of the terminal in percentage.
cellModemState byte 0 This number indicates whether any errors were occurring on the Cell Modem at the time of this report.
cellModem AntennaState byte 1 This number indicates whether any errors were occurring on the Cell Modem Antenna at the time of this report.
gpsModemState byte 1 This number indicates whether any errors were occurring on the GPS Modem at the time of this report.
gpsAntennaState byte 1 This number indicates whether any errors were occurring on the GPS Antenna at the time of this report.
network byte 1 Identifies the sattelite or cellular network through which the report was sent by the terminal.
rssi byte 7 Last reported RSSI (signal strength) of the network.
 
Sample Response [JSON]
GET https://apicert.soa-proxy.deere.com/platform/machines/5432/deviceStateReports
200 OK
Content-Type: application/vnd.deere.axiom.v3+json;charset=UTF-8

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432/deviceStateReports"
      }
   ],
   "total": 1,
   "values": [
      {
         "links": [
            {
               "rel": "machine",
               "uri": "https://apicert.soa-proxy.deere.com/platform/machines/5432"
            },
            {
               "rel": "terminal",
               "uri": "https://apicert.soa-proxy.deere.com/platform/terminals/8765"
            }
         ],
         "time": "2010-10-04T14:35:05.000Z",
         "gatewayType": 2,
         "location": {
            "links": [],
            "id": "163762",
            "lat": 41.597164,
            "lon": -90.54383,
            "altitude": {
               "links": [],
               "unit": "meters",
               "valueAsDouble": 0
            }
         },
         "minRSSI": {
            "links": [],
            "unit": "dbM",
            "valueAsDouble": 0
         },
         "maxRSSI": {
            "links": [],
            "unit": "dbM",
            "valueAsDouble": 0
         },
         "averageRSSI": {
            "links": [],
            "unit": "dbM",
            "valueAsDouble": 0
         },
         "gpsFixTimestamp": "2010-10-04T14:35:05.000Z",
         "engineState": 0,
         "terminalPowerState": 0,
         "batteryLevel": {
            "links": [],
            "unit": "Percent",
            "valueAsInteger": 0
         },
         "cellModemState": 0,
         "cellModemAntennaState": 0,
         "gpsModemState": 0,
         "gpsAntennaState": 0,
         "network": 0,
         "rssi": 0
      }
   ]
}
 
[1] Gateway Types
1 GTT
2 MTG/UTG
3 Iridium
 
DSR Definitions
 
DateTime Timestamp Format
All timestamps are in UTC, and formatted according to ISO 8601 standards.
Example: 2014-01-28T15:59:00.000Z
 
Abstract Measurement Data Type
This data type was created by Deere developers to include strings, doubles and integers that carry an unit of measurement, such as signal strength, or hours.
 
Engine & Terminal Power State
Value Definition
0 The power-on key is ON.
1 The power-on key is OFF.
2 The terminal is SLEEPING.
3 The terminal is HIBERNATING.
 
Cell Modem, Cell Modem Antenna, GPS Modem, & GPS Modem Antenna States
Value Definition
0 No errors were occurring during the time of this report.
1 Errors were occurring during the time of this report.
 
Network
Value Definition
1 Satellite network
2 Cellular network