Field Hub Data
Most of the Field Hub related API calls will return data that is coming into the Slingshot system from the Field Hub itself. This page will help interpret those values.
| Field Name | Description | Type | Units | Range | Notes |
|---|---|---|---|---|---|
| Active | Indicates whether or not the Field Hub is currently reporting into the Slingshot system. | Boolean | true or false | ||
| Valid | Indicates if the Field Hub is currently reporting a valid GPS position. | Boolean | true or false | ||
| Lat | Latitude. | Decimal | decimal degrees | -90.0 to 90.0 | |
| Lon | Longitude. | Decimal | decimal degrees | -180.0 to 180.0 | |
| Alt | Altitude. | 32 bit Integer | meters relative to sea level | -2147483648 to 2147483647 | Treated as 32 bit integer in API, practical values will come from a much narrower range. |
| Speed | Speed over ground. | Byte | kilometers per hour | 0 to 255 | |
| Direction | Course over ground. | 32 bit Integer | track angle degrees | 0 to 360 | |
| GPSSat | Number of satellites Field Hub is tracking. | Byte | 0 to 255 | The upper limit is determined by number of GPS satellites actually orbiting the planet. | |
| GPSDateTime | Time Stamp as reported by the GPS in the Field Hub. | DateTime | '1000-01-01 00:00:00' UTC to '9999-12-31 23:59:59' UTC | Practical values will be in recent time periods; can be null.This value is in UTC. Formatted as 'YYYY-MM-DDTHH:mm:ssZ'. | |
| ID | Unique id for this record; can be used by the program to determine if this record has already been downloaded / processed. | 64 bit Integer | 0 to 9223372036854775807 | ||
| Event | The event that triggered the Field Hub report. | String | "1", "2", "3", "4", "5", "16", "17", "30", "31" | 1 - Digital Input 1 state change 2 - Digital Input 2 state change 3 - Digital Input 3 state change 4 - Digital Input 4 state change 5 - 5 second update 16 - Ignition Power On 17 - Ignition Power Off 30 - 30 second update 31 - 30 second update | |
| DeviceId | This is the actual Device ID. | String | N/A | ||
| GPSFix | Indicates if the GPS antenna is 'fixed' onto a group of satellites. | Boolean | true or false | ||
| RSSI | Receive Signal Strength Indicator in dBm. | Signed Byte | dBm | -103.0 to -85.0 | 5 bar(s) is RSSI >= -85.0 4 bar(s) is -85.0 > RSSI >= -90.0 3 bar(s) is -90.0 > RSSI >= -95.0 2 bar(s) is -95.0 > RSSI >= -100.0 1 bar(s) is -100.0 > RSSI >= -103.0 0 bar(s) is -103.0 > RSSI |
| Ignition | Ignition State. | Boolean | true or false | ||
| DigitalInput1 | State of Digital Input 1 on the back of the Field Hub. | Boolean | true or false | Interpretation is application specific. | |
| DigitalInput2 | State of Digital Input 2 on the back of the Field Hub. | Boolean | true or false | Interpretation is application specific. | |
| DigitalInput3 | State of Digital Input 3 on the back of the Field Hub. | Boolean | true or false | Interpretation is application specific. | |
| DigitalInput4 | State of Digital Input 4 on the back of the Field Hub. | Boolean | true or false | Interpretation is application specific. | |
| AnalogInput1 | Value received on Analog Input 1 on the back of the Field Hub. | Double | 0.0 to 15.0 | Interpretation is application specific. | |
| AnalogInput2 | Value received on Analog Input 2 on the back of the Field Hub. | Double | 0.0 to 15.0 | Interpretation is application specific. | |
| AnalogInput3 | Value received on Analog Input 3 on the back of the Field Hub. | Double | 0.0 to 15.0 | Interpretation is application specific. | |
| AnalogInput4 | Value received on Analog Input 4 on the back of the Field Hub. | Double | 0.0 to 15.0 | Interpretation is application specific. | |
| BatteryVoltage | Value of the voltage as measured on the Field Hub power input connection. | Double | volts | 0.0 to 30.0 | |
| DigitalOutput1 | State of Digital Output 1 on the back of the Field Hub. | Boolean | true or false | Interpretation is application specific. | |
| DigitalOutput2 | State of Digital Output 2 on the back of the Field Hub. | Boolean | true or false | Interpretation is application specific. | |
| DigitalOutput3 | State of Digital Output 3 on the back of the Field Hub. | Boolean | true or false | Interpretation is application specific. | |
| ServerDateTime | The UTC Date and Time of when the record was written to the Slingshot system. | DateTime | '1970-01-01 00:00:01' UTC to '2038-01-19 03:14:07' UTC | Practical values will be in recent time periods; can be null.This value is in UTC. Formatted as 'YYYY-MM-DDTHH:mm:ssZ'. | |
| Odometer | Distance the Field Hub has traveled in hectometers. | Unsigned 32 bit Integer | hectometers | 0 to 4294967295 | This is calculated from the distance the Field Hub has traveled between fixed GPS locations. |
| Service | The name of the service the Field Hub is currently using. | String | N/A | This value comes directly from the Field Hub. Some values commonly seen are: "", "NONE", "1xRTT", "EVDO", "EVDO.A", "GPRS", "EDGE", "UMTS", and "HSPA". | |
| Carrier | The name of the wireless carrier the Field Hub is currently using. | String | N/A | This value comes directly from the Field Hub. Some values commonly seen are: "AT&T", "Bell", and "Verizon". | |
| Roam | An indicator that the Field Hub is in 'Roaming' mode, as determined by the Field Hub. | String | N/A | "" - Roaming status cannot be determined. "00" - Field Hub is not roaming. Any other value - Field Hub is roaming. |