Difference between revisions of "AEMP"
(Created page with "= Overview = This page outlines the details involved with the AEMP interfaces. == AEMP Setup == == AEMP API Response ==") |
(Populated a ton of content regarding the 2.0-ext API) |
||
| Line 1: | Line 1: | ||
= Overview = | = Overview = | ||
| − | This page | + | This page contains details for everything related to AEMP. |
| − | == AEMP | + | == Available AEMP APIs == |
| + | There are three AEMP APIs available to customers. They are: | ||
| + | * AEMP 1.2 | ||
| + | * AEMP 2.0 | ||
| + | * AEMP 2.0-ext | ||
| + | Details of each API are outlined in sections below. | ||
| − | == AEMP API | + | == Enabling AEMP == |
| + | AEMP access is not enabled by default. To enable the API for a specific customer, please follow the below steps. | ||
| + | [TODO] | ||
| + | |||
| + | == API Definitions == | ||
| + | This section presents the data that can be found in each API. Note that there is overlap between the different APIs. | ||
| + | |||
| + | === AEMP 1.2 === | ||
| + | Details regarding AEMP 1.2 will be filled out in the future. | ||
| + | |||
| + | === AEMP 2.0 === | ||
| + | Details regarding AEMP 2.0 will be filled out in the future. Note that the extension (the section below this one) includes all values from the 2.0 API. | ||
| + | |||
| + | === AEMP 2.0-ext === | ||
| + | |||
| + | ==== EquipmentHeader ==== | ||
| + | ===== UnitInstallDateTime ===== | ||
| + | When the hardware module first received power. Generally this is when the module is installed on a machine. | ||
| + | ===== OEMName ===== | ||
| + | Name of the OEM, in this case Dynapac. | ||
| + | ===== Model ===== | ||
| + | The machine model name. For example, Roller CA6500PD. A list of valid values can be requested if it is needed. | ||
| + | ===== EquipmentID ===== | ||
| + | The ID of the equipment, this is the serial number by default. | ||
| + | ===== SerialNumber ===== | ||
| + | 19 digit serial number of the machine. | ||
| + | |||
| + | ==== Location ==== | ||
| + | ===== Latitude ===== | ||
| + | Latitude of the machine when it last communicated with the portal. | ||
| + | ===== Longitude ===== | ||
| + | Longitude of the machine when it last communicated with the portal. | ||
| + | |||
| + | ==== CumulativeIdleHours ==== | ||
| + | ===== Hour ===== | ||
| + | The total number of idle hours. The definition for idle hours is defined for both pavers and rollers [https://manual.dynalink.dynapac.com/usermanual/index.php/Machine_Details_Page here]. | ||
| + | |||
| + | ==== CumulativeOperatingHours ==== | ||
| + | ===== Hour ===== | ||
| + | The total number of operating hours. The definition for operating hours of a paver is [https://manual.dynalink.dynapac.com/usermanual/index.php/Machine_Details_Page#Paving here], and for a roller [https://manual.dynalink.dynapac.com/usermanual/index.php/Machine_Details_Page#Vibrating here]. | ||
| + | |||
| + | ==== Distance ==== | ||
| + | ===== Odometer ===== | ||
| + | Total distance the machine has moved. | ||
| + | ===== OdometerUnits ===== | ||
| + | Units of the total distance traveled. | ||
| + | |||
| + | ==== FuelRemaining ==== | ||
| + | ===== Percent ===== | ||
| + | Percent of fuel remaining, according to the last time the machine reported. | ||
| + | |||
| + | ==== DEFRemaining ==== | ||
| + | ===== Percent ===== | ||
| + | Precentage of DEF liquid remaining, according to the last time the machine reported. | ||
| + | |||
| + | ==== EngineStatus ==== | ||
| + | ===== Running ===== | ||
| + | What state the engine is in. <!-- TODO @Jurian. Please fill in the different states possible. --> | ||
| + | |||
| + | ==== EngineCondition ==== | ||
| + | ===== Running ===== | ||
| + | What condition the engine is in. <!-- TODO @Jurian. Please fill in the different states possible. --> | ||
| + | |||
| + | ==== EngineStatusMessagesExt ==== | ||
| + | ===== EngineStatus ===== | ||
| + | What state the engine is in. <!-- TODO @Jurian. Please fill in the different states possible. --> | ||
| + | |||
| + | ==== TransportStatus ==== | ||
| + | ===== Transport ===== | ||
| + | If the machine is in transport mode or not. The defenition of a machine being in transport can be found [https://manual.dynalink.dynapac.com/usermanual/index.php/Machine_Details_Page#Static.2FTransport_2 here] for rollers and [https://manual.dynalink.dynapac.com/usermanual/index.php/Machine_Details_Page#Static.2FTransport here] for pavers. <!-- TODO @Jurian. Please verify. --> | ||
| + | |||
| + | ==== BatteryStatus ==== | ||
| + | ===== State ===== | ||
| + | State of the battery. <!-- TODO @Jurian. Please fill in the different states possible. --> | ||
| + | ===== Voltage ===== | ||
| + | Voltage of the battery, according to the last time the machine reported. | ||
Revision as of 10:49, 22 September 2020
Contents
- 1 Overview
- 1.1 Available AEMP APIs
- 1.2 Enabling AEMP
- 1.3 API Definitions
- 1.3.1 AEMP 1.2
- 1.3.2 AEMP 2.0
- 1.3.3 AEMP 2.0-ext
Overview
This page contains details for everything related to AEMP.
Available AEMP APIs
There are three AEMP APIs available to customers. They are:
- AEMP 1.2
- AEMP 2.0
- AEMP 2.0-ext
Details of each API are outlined in sections below.
Enabling AEMP
AEMP access is not enabled by default. To enable the API for a specific customer, please follow the below steps. [TODO]
API Definitions
This section presents the data that can be found in each API. Note that there is overlap between the different APIs.
AEMP 1.2
Details regarding AEMP 1.2 will be filled out in the future.
AEMP 2.0
Details regarding AEMP 2.0 will be filled out in the future. Note that the extension (the section below this one) includes all values from the 2.0 API.
AEMP 2.0-ext
EquipmentHeader
UnitInstallDateTime
When the hardware module first received power. Generally this is when the module is installed on a machine.
OEMName
Name of the OEM, in this case Dynapac.
Model
The machine model name. For example, Roller CA6500PD. A list of valid values can be requested if it is needed.
EquipmentID
The ID of the equipment, this is the serial number by default.
SerialNumber
19 digit serial number of the machine.
Location
Latitude
Latitude of the machine when it last communicated with the portal.
Longitude
Longitude of the machine when it last communicated with the portal.
CumulativeIdleHours
Hour
The total number of idle hours. The definition for idle hours is defined for both pavers and rollers here.
CumulativeOperatingHours
Hour
The total number of operating hours. The definition for operating hours of a paver is here, and for a roller here.
Distance
Odometer
Total distance the machine has moved.
OdometerUnits
Units of the total distance traveled.
FuelRemaining
Percent
Percent of fuel remaining, according to the last time the machine reported.
DEFRemaining
Percent
Precentage of DEF liquid remaining, according to the last time the machine reported.
EngineStatus
Running
What state the engine is in.
EngineCondition
Running
What condition the engine is in.
EngineStatusMessagesExt
EngineStatus
What state the engine is in.
TransportStatus
Transport
If the machine is in transport mode or not. The defenition of a machine being in transport can be found here for rollers and here for pavers.
BatteryStatus
State
State of the battery.
Voltage
Voltage of the battery, according to the last time the machine reported.
