Vehicle Telemetry
Vehicle telematics data is available for both construction equipment and agriculture machinery. These endpoints are based upon the ISO 15143-3 Specification.
Endpoints
View All
This is a list of featured endpoints. The entries below link to Swagger documentation.
Time Series
Diagnostics
Metrics
Metrics
The Metrics endpoints support several parameters when retrieving data.
The table below contains a list of parameters that can be found in returned data from GET requests.
| Parameter Name | Description |
|---|---|
| AREA | Total area covered or processed by the machinery. |
| AREA_REMAIN | Remaining area that the machine is expected to cover or process. |
| BALE_DROP_DETECTED | Indicates whether a bale has been dropped during baling operations. |
| BALE_LENGTH_SETPOINT | The target length for the bales being produced. |
| BATTERY_VOLTAGE | Voltage of the vehicle’s battery, monitoring electrical system health. |
| CHARGE | Battery charge level, typically for electric or hybrid systems. |
| CROP_TYPE | Type of crop being processed, which influences operation settings. |
| DEF_LEVEL | Diesel Exhaust Fluid (DEF) level for emission control systems. |
| ENG_COOLANT_TEMP | Temperature of the engine's coolant, critical for preventing overheating. |
| ENG_FUEL_RATE | Fuel consumption rate. |
| ENG_HOURS | Total engine run time, used to track usage and maintenance scheduling. |
| ENG_LOAD | Percentage of engine capacity currently in use. |
| ENG_OIL_PRESS | Oil pressure, essential for proper engine lubrication. |
| ENG_OIL_TEMP | Temperature of the engine oil, important for performance and overheating prevention. |
| ENG_SPEED | Engine speed. |
| FLYWHEEL_SHEARBOLT_ACTIVE | Indicates whether the flywheel shear bolt has activated, protecting the machine during blockages. |
| FUEL_LEVEL | Remaining fuel in the tank, used for monitoring refuelling needs. |
| GPS_ALT | GPS-based altitude showing the current elevation of the machine. |
| GPS_DIR | GPS-based direction of movement, used for precision farming. |
| GPS_SPEED | GPS-based speed of the machine. |
| GROUND_SPEED | Speed relative to the ground, used for adjusting operations based on field conditions. |
| GSS_FIELD | Geographic field ID or name for tracking specific field operations. |
| HYDRAULIC_PRESSURE_SLICE | Hydraulic pressure for a specific section of the machine's operation. |
| INCHAMBER_BALE_LENGTH | Current length of the bale in the chamber, tracked in real time. |
| KNOTTER_TOTAL_BALECOUNT | Total number of bales tied by the knotter mechanism. |
| KNOTTER_TOTAL_BALRCOUNT | Alternative metric tracking the total number of bales tied by the knotter system. |
| LAST_BALE_CAPACITY | Capacity or density of the last bale produced, used for quality control. |
| LAST_BALE_DENSITY | Density of the last bale, showing how tightly material is packed. |
| LAST_BALE_MOISTURE | Moisture content of the last bale, important for quality and storage. |
| LAST_BALE_NMB_KNIVES | Number of knives used to cut the last bale, affecting its size and composition. |
| LAST_BALE_SIZE | Size of the last bale produced. |
| LAST_BALE_SLICES | Number of slices or sections within the last bale, tracking the baling process. |
| LAST_BALE_WEIGHT | Weight of the last bale produced, important for tracking yield. |
| LAST_BALE_WEIGHT_DRY | Dry weight of the last bale, accounting for moisture. |
| LIFETIME_BALE_COUNT | Total number of bales produced by the machine over its lifetime. |
| LIFTTIME_BALE_COUNT | Duplicate or alternative metric for lifetime bale count. |
| LOAD_SETPOINT | Target load or pressure set for the machinery’s operations. |
| MOISTURE_SLICE | Moisture content in a specific slice of the bale, used for monitoring distribution. |
| NEEDLE_YOKE_SHEARBOLT_ACTIVE | Indicates if the needle yoke shear bolt has activated, a safety feature in balers. |
| OVERLOAD_DETECTED | Flag indicating that an overload condition has been detected. |
| PICKUP_SLIP_ACTIVE | Indicates that the pickup mechanism is slipping, possibly due to blockage or excessive material. |
| PRESERVATIVE_ACTUAL_APPL_RATE | Actual rate of preservative being applied during baling. |
| PRESERVATIVE_TARGET_APPL_RATE | Target rate for preservative application, based on crop and conditions. |
| RAT_LOAD | Current load on the Rate Application Technology (RAT) system, used for variable-rate applications. |
| ROTOR_CUT_OUT_FLAG | Indicates if the rotor has cut out, possibly due to overload or blockage. |
| STATUS_DUTY | Operational status of the machine, indicating whether it's active, idle, or in maintenance mode. |
| STUFFER_SHEARBOLT_ACTIVE | Indicates if the stuffer shear bolt has activated, another safety feature on baling machinery. |
| THICKNESS_SLICE | Thickness of slices within the bale, important for ensuring uniformity. |
| WORKING_MODE | Current working mode of the machine, such as working, transport, or idle mode. |
Error Tags
This table describes the error tags that can be returned when fetching metrics, alerts and faults.
Error tags will be returned as a comma separated list labelled errorTags in the telemetry object. An empty string indicates no errors were present.
| Error Tag | Description |
|---|---|
| ALARM_NOT_ENRICHED | Internal processing error. This one event might be missing some metadata. |
| COUNTRY_NOT_ENRICHED | Equipment did not have GPS fix at the time. This one metric has unreliable position related metadata. |
| ECU_NOT_ENRICHED | Not applicable. This error tag is not expected to occur. |
| FAULT_NOT_ENRICHED | Internal processing error. This one event might be missing some metadata. |
| GPS_TIMESTAMP_MISSING | Equipment did not report a GPS timestamp at the time. This one metric has unreliable time and position related metadata. |
| METRIC_OUT_OF_BOUND | Equipment reported unrealistic value for this one metric. |
| NONE_VALUE | Equipment reported a missing value or null value for this one metric. |
| POSITION_MISSING | Equipment did not have GPS fix at the time. This one metric has unreliable position related metadata. |
| SV_ECU_NOT_ENRICHED | Not applicable. This error tag is not expected to occur. |
| TIME_ZONE_NOT_ENRICHED | Equipment did not have GPS fix at the time. This one metric has unreliable position related metadata. |
| SOURCESYSTEMDATETIME_UNKNOWN | This Error Tag is expected When Activation TimeStamp is not available from the Alerts or Faults Collocated endpoint responses |