Standard Metrics Explanation¶

ISO 15143-3 and AEMP Metrics¶

The following chapter describes the keys used for the ISO 15143-3 and AEMP Metrics. For more information, see REST API and AEMP API.

Header Information¶

Header Information can contain the following parts:

Installation date of the telematics unit
Name of the OEM
Name of the model
Equipment ID
Serial Number
PIN or VIN

Signal Keys are not necessary for this information. Use the Proemion DataPortal to maintain the machine data.

Last known Location¶

The information for the Last known Location is part of the GPS dataset. Therefore, latitude, longitude and altitude are received from the device per default configuration. To provide the standardized Unit for these values the received data is pre-processed if it is needed. Date and Time are delivered via a timestamp.

Operating Hours¶

To provide the operating hours of your vehicle use the following key:

value.common.machine.hours.operation.total

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for time duration for the value of operating hours.

Cumulative Fuel Used¶

To provide the cumulative used fuel of your vehicle use the following key:

value.common.engine.fuel.used.total

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for volume for the value of cumulative fuel used.

Fuel Used in the Preceding 24 Hours¶

To provide the fuel used in the preceding 24 hours of your vehicle use the following key:

value.common.engine.fuel.used.last.24hrs

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for volume for the value of fuel used in the preceding 24 hours.

Note

Our AEMP exporter currently does not support this metric. Contact Support in case your application needs it.

Cumulative Distance Travelled¶

To provide the cumulative travelled distance of your vehicle use the following key:

value.common.machine.distance.total

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for length for the value of cumulative distance travelled.

Caution Codes¶

CautionMessages contains a list of CautionDescription items, populated by signals with PDC valueDefinition category StateSignal and attribute machineError=true. Details see PDC Manual → ValueDefinition → StateSignal

Each CautionDescription represents the number of a code that occurred at a specific date and time. Identifier and Description are taken from the aempCautionCode section in the PDC. If <aempCautionCode> is absent, then the <state>.value and <state>.description are used.

Date and time are delivered via a timestamp.

Cumulative Idle Hours¶

To provide the cumulative idle hours of your vehicle use the following key:

value.common.machine.hours.oem.specific.total

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for time duration for the value of cumulative idle operating hours.

Fuel Remaining Ratio¶

To provide the fuel remaining ratio of your vehicle use the following key:

value.common.engine.fuel.level

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for percent for the value of fuel remaining ratio.

DEF Remaining Ratio¶

To provide the DEF remaining ratio of your vehicle use the following key:

value.common.engine.def.level

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for percent for the value of def remaining ratio.

Engine Condition¶

To provide the engine condition of a specific engine of your vehicle use the following keys:

value.common.engine.identification.serialnumber
value.common.engine.state

Date and time are delivered via a timestamp.

Digital Input State¶

To provide the digital inputs state use the corresponding key:

value.common.machine.inputs.digital.[number] ([number] has to be replaced by the input number (0 … 4294967295)

Date and time are delivered via a timestamp.

Cumulative Power Take Off Hours¶

To provide the cumulative power take off hours of your vehicle use the following key:

value.common.machine.hours.pto.total

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for time duration for the value of cumulative power take off hours.

Average Daily Engine Load Factor¶

To provide the average daily engine load factor of your vehicle use the following key:

value.common.engine.loadfactor.current

We can calculate the average daily engine load factor with the data provided by the current engine loadfactor. Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for percent for the value of average daily engine load factor.

Note

Our AEMP exporter currently does not support this metric. Contact Support in case your application needs it.

Peak Daily Speed¶

To provide the peak daily speed of your vehicle use the following key:

value.common.machine.speed

We can filter for the maximum speed per day with the data provided by the machine speed. Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for velocity for the value of peak daily speed.

Cumulative Load Count¶

To provide the cumulative load count of your vehicle use the following key:

value.common.machine.load.count.total

Date and time are delivered via a timestamp.

Cumulative Payload Totals¶

To provide the cumulative total payloads of your vehicle use the following key:

value.common.machine.load.total

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for mass for the value of cumulative payload totals.

Cumulative Nonproductive Regeneration Hours¶

To provide the cumulative nonproductive regeneration hours of your vehicle use the following key:

value.common.engine.hours.regeneration.total

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for time duration for the value of cumulative nonproductive regeneration hours.

Cumulative Idle Nonoperating Hours¶

To provide the cumulative nonoperating idle hours of your vehicle use the following key:

value.common.machine.hours.idle.total

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for time duration for the value of cumulative idle nonoperating hours.

Diagnostic Trouble Codes¶

To provide specific diagnostic trouble codes of your vehicle use the following keys:

value.common.machine.diagnostic.trouble.code
value.common.machine.ambient.temperature

Date and time are delivered via a timestamp. Use the predefined unit (see the columns "Standard Unit" described for the Standard Metrics) for temperature for the value of ambient temperature. Diagnostic trouble codes are based on your specific definitions. If it is defined, we need to know the severity, description and the code source of each code. Therefore, we need to set up our database in an OEM specific project to meet your demands.

AEMP Signals Overview¶

The following section gives an overview on which and how of the Proemion standard metrics are aligned with the AEMP elements. That means, by simply implementing those Proemion standard metrics you get, without additional effort, full AEMP support on the Proemion AEMP API.

In Standard Machine Metrics you can already view which of our signals keys are aligned with the AEMP signals. The following table summarizes all the signals by the AEMP elements together with the Proemion standard signal they use as a source. In other words, what elements of the AEMP API response are fed with which standard signals.

Note

Consider that there is a list of the supported AEMP signals in AEMP API, too (see "Supported Metrics") with descriptions provided by Proemion.

AEMP signal key/element name in the response	Proemion signal key/standard metric	Description (ISO/TS 15143-3)
`AverageDailyEngineLoadFactors`	`value.common.engine.loadfactor.current`, see Average Daily Engine Load Factor	The preferred definition of average daily load factor is a percentage calculated as the actual fuel consumed over the previous 24 h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine's rated output.
`CumulativeOperatingHours` (Operating Hours)	`value.common.machine.hours.operation.total`	The current total lifetime operating hours of the machine is expressed as the cumulative quantity of time during which the machine's engine has been running. This is generally the value of the hourmeter on the machine.
`CumulativePowerTakeOffHours` (Cumulative Power Take-Off Hours)	`value.common.machine.hours.pto.total`, see Operating Hours	The current lifetime total power take-off hours of the machine.
`CumulativeActiveRegenerationHours` (Cumulative Non-Productive Regeneration Hours)	`value.common.engine.hours.regeneration.total`, see Cumulative Nonproductive Regeneration Hours	The current lifetime total non-productive regeneration hours of the machine.
`CumulativeIdleHours` (Cumulative Idle Operating Hours)	`value.common.machine.hours.oem.specific.total`, see Cumulative Idle Hours	The current lifetime total cumulative idle operating hours of the machine-
`CumulativeNonProductiveIdleHours` (Cumulative Idle Non-Operating Hours)	`value.common.machine.hours.idle.total`, Cumulative Idle Nonoperating Hours	Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated.
`Distance` (Cumulative Distance Travelled)	`value.common.machine.distance.total`, see Cumulative Distance Travelled	The distance the machine has travelled (regardless of direction) while operating. Cumulative distance travelled is the total distance travelled by the machine, under its own power, since its manufacture.
`EngineStatus` (Engine Condition)	For EngineNumber `value.common.engine.identification.serialnumber`, see Engine Condition For EngineRunning `value.common.engine.state`, see Engine Condition	This value is an indicator of the current status of the machine's engine running state.

		- both underlying metrics have to be configured and present

		- the Running value drives the datetime
`FuelRemaining`	`value.common.engine.fuel.level`, see Fuel Remaining Ratio	The percentage of fuel remaining in the fuel tank of the machine
`CumulativeFuelUsed` (Cumulative Fuel Used)	`value.common.engine.fuel.used.total`, see Cumulative Fuel Used	The total amount of fuel consumed by the machine is expressed by three separate fields. This data element represents the cumulative amount of fuel used by the machine since its manufacture
`CumulativeLoadCount` (Cumulative Load Count)	`value.common.machine.load.count.total`, see Cumulative Load Count	-
`CumulativePayloadTotals` (Cumulative Payload Total)	`value.common.machine.load.total`, see Cumulative Payload Totals	Cumulative total payload moved by the machine.
`Locations` (Last Known Location)	See Last known Location	The last known equipment location is expressed by the following fields:
		- Latitude - from Geo dataset
		- Longitude - from Geo dataset
		- Altitude - from Geo dataset
`PeakDailySpeed` (Peak Daily Speed)	`value.common.machine.speed`, see Peak Daily Speed	This field indicates the highest achieved travel speed by the machine during a 24 h period as of the specified date and time.
`DEFRemaining` (DEF Remaining Ratio)	`value.common.engine.def.level`, see DEF Remaining Ratio	The percentage of DEF remaining in the DEF tank of the machine.
`DiagnosticTroubleCode` (`DiagnosticTroubleCode/FaultCodes`)	See Diagnostic Trouble Codes	Diagnostic codes that alert the owner to the need for non-scheduled machine supports.
`CautionMessages` (CautionCode)	See Caution Codes	Caution codes arising from machine operation.
`SwitchStatus` (Digital Input State)	`value.common.machine.inputs.digital.[number]`, see Digital Input State	This value is the current status of any digital input on the machine available manufacturer's telematics device. A digital input on a telematics device is a gate or proximity switch. Other forms of switches and logic outputs may be used.