With every alarm triggered in the Alarms module, there is information on the triggers that generated the alarm. Currently, there are triggers for dynamic alarms from automations and triggers for fixed alarms.
The following are the potential triggers for alarms with type “dynamic”:
| Trigger name | Description | Response parameter |
|---|---|---|
| speed | Refers to the speed of an asset in km/h. | { "valueType": "number", "unitType": "km/h" } |
| axleLoad | Reefers to the axle load in kg transmitted by the wheels. | { "value": 20000, "valueType": "number", "unitType": "kg" } |
| harshbrake | Harsh brake (sudden deceleration) event is detected in an asset. | { "valueType": "event" } |
| harshacceleration | Harsh acceleration (sudden acceleration) event is detected in an asset. | { "valueType": "event" } |
| drivingwithoutiso | An asset is being driven without ISO cable connected. | { "valueType": "event" } |
| rssactivation | RSS (Roll Over Stability) event is detected in an asset. | { "valueType": "event" } |
| absactivation | ABS (Anti-lock Braking System) event is detected in an asset. | { "valueType": "event" } |
| ignition-on | Refers to ignition of an asset used to power up the accessories (engine off generally). • ignitionOn • ignitionOff | { "value": "ignitionOff", "valueType": "string" } |
| comunit.connected | Refers to the event when a device is connected. | { "valueType": "event" } |
| comunit.disconnected | Refers to the event when a device is disconnected. | { "valueType": "event" } |
| fuelLevel | Refers to the fuel level percentage of an asset. | { "value": 0, "valueType": "number", "unitType": "%" } |
| batteryLevel | Refers to the battery level of an asset. • low • medium • high | { "value": "high", "valueType": "string" } |
| compartment-*- returnAir (* 1 to 3) | Refers to the return air temperature of a reefer zone in °C. | { "value": -5, "valueType": "number", "unitType": "°C" } |
| compartment-*- supplyAir (* 1 to 3) | Refers to the supply air temperature of a reefer zone in °C. | { "value": -5, "valueType": "number", "unitType": "°C" } |
| compartment-*-setPoint (* 1 to 3) | Refers to the set point temperature of a reefer zone in °C. | { "value": -5, "valueType": "number", "unitType": "°C" } |
| logger-*-temperature (* 1 to 6) | Refers to the logger temperature in °C. | { "value": -5, "valueType": "number", "unitType": "°C" } |
| lin-*-temperature (* 1 to 10) | Refers to the LIN temperature in °C. | { "value": -5, "valueType": "number", "unitType": "°C" } |
| lin-*-contact (* 1 to 10) | Refers to LIN contact on/off. | { "value": true, "valueType": "boolean" } |
| digitalInput- ( 1 to 6) | Refers to the digital input on/off. | { "value": false, "valueType": "boolean" } |
| brakeLiningOk | Indicates if the braking system of an asset is OK. | { "value": true, "valueType": "boolean" } |
| amberLight | Refers to the braking system of an asset. | { "value": true, "valueType": "boolean" } |
| redLight | Refers to the braking system of an asset. | { "value": true, "valueType": "boolean" } |
| tire-*-pressure (* 1 to 255) | Refers to the tire pressure of an asset in bar. More info about wheel location logic can be found here: https://developers.zf-scalar.com/reference/supported-sensor-ids#wheel-location-logic | { "value": 17, "valueType": "number", "unitType": "bar" } |
| tire-*-temperature (* 1 to 255) | Refers to the tire temperature of an asset in °C. More info about wheel location logic can be found here: https://developers.zf-scalar.com/reference/supported-sensor-ids#wheel-location-logic | { "value": 41, "valueType": "number", "unitType": "°C" } |
| tire-*-pressureStatus (* 1 to 255) | Refers to the tire pressure status of an asset. • extremeOverPressure • overPressure • normal • underPressure • extremeUnderPressure | { "value": "valueType": "string" } |
| trailer-connection | Refers to whether the trailer is coupled to an asset or decoupled from an asset. • coupled • decoupled | { "value": "coupled", "valueType": "string" } |
| enter | Refers to when an asset enters a place with a geofence. | { "valueType": "event", "placeId": "ddeef7fa-ffde-4bb3-9e68-9c0b94198ab9", "placeName": "HQ parking" } |
| leave | Refers to when an asset leaves a place with a geofence. | { "valueType": "event", "placeId": "ddeef7fa-ffde-4bb3-9e68-9c0b94198ab9", "placeName": "HQ parking" } |
| in-place | Refers to when an asset is inside a place with a geofence. | { "valueType": "event", "placeId": "ddeef7fa-ffde-4bb3-9e68-9c0b94198ab9", "placeName": "HQ parking" } |
| reefer-error-code | Refers to the information on an error received from the reefer. • Code (always present) • Source (always present) • Compartment id • Description • Priority • Operator action • Reefer | { "value": { "code": "13", "source": “iboxThermokingCodes ", "compartmentId": "3", "description": "High discharge pressure", "priority": "medium", "operatorAction": "Reset, "reefer": "primaryReefer" }, "valueType": "object", "unitType": null } |
| pto-can | Indicates if the digital CAN input is on or off. | { "value": true, "valueType": "boolean" } |
| pto- ( 1 to 2) | Indicates if a digital input is on or off. | { "value": true, "valueType": "boolean" } |
| pto-ext1- ( 1 to 3) | Indicates if a digital input of the extension kit V1 is on or off. | { "value": true, "valueType": "boolean" } |
| pto-ext2-1 | Indicates if the digital input of the extension kit V2 is on or off. | { "value": true, "valueType": "boolean" } |
| engineSpeed | Refers to the engine speed in rpm. | { "value": 3000, "valueType": "number", "unitType": "rpm" } |
The following are the potential triggers for alarms that are not of type “dynamic”:
| Trigger name | Description | Response parameter |
|---|---|---|
| speed | Refers to the speed of an asset in km/h. | { "value": 100, "valueType": "number", "unitType": "km/h" } |
| engineSpeed | Refers to the engine speed of an asset in rpm. | { "value": 3000, "valueType": "number", "unitType": "rpm" } |
| ignitionOn | Refers to the ignition of an asset when it is on that is used to power up the accessories (engine off generally). | { "valueType": "event" } |
| ignitionOff | Refers to the ignition of an asset when it is off. | { "valueType": "event" } |
| fuelLevelIncrease | Refers to the percentage increase in fuel level of an asset. | { "value": 50, "valueType": "number", "unitType": "%" } |
| fuelLevelDrop | Refers to the percentage decrease in fuel level of an asset. | { "value": 50, "valueType": "number", "unitType": "%" } |
| rssactivation | RSS (Roll Over Stability) event is detected in an asset. | { "valueType": "event" } |
| harshBrake | Harsh brake (sudden deceleration) event is detected in an asset. | { "valueType": "event" } |
| harshAcceleration | Harsh acceleration (sudden acceleration) event is detected in an asset. | { "valueType": "event" } |
| engineOn | Engine of an asset is powered on (with ignition on). | { "valueType": "event" } |
| engineOff | Engine of an asset is powered off (not necessarily ignition off). | { "valueType": "event" } |
| drivingWithoutTacho | An asset is being driven without a tachocard. | { "valueType": "event" } |
| drivingWithoutIsoCable | An asset is being driven without ISO cable connected. | { "valueType": "event" } |
| idling | An asset engine is running without driving for a certain duration in ISO-8601. | { "value": "PT23H59M59S", "valueType": "string", "unitType": "duration" } |
| continuousDriving | A driver is in a continuous driving state for a certain duration in ISO-8601. | { "value": "PT23H59M59S", "valueType": "string", "unitType": "duration" } |
| continuousResting | A driver is in a continuous resting state for a certain duration in ISO-8601. | { "value": "PT23H59M59S", "valueType": "string", "unitType": "duration" } |
| continuousWork | A driver’s working time reaches the set duration limit in ISO-8601. | { "value": "PT23H59M59S", "valueType": "string", "unitType": "duration" } |
| continuousAvailability | A driver is in a continuous availability state for a certain duration in ISO-8601. | { "value": "PT23H59M59S", "valueType": "string", "unitType": "duration" } |
| dailyDriving | The driver’s daily driving time reaches the set duration limit in ISO-8601. | { "value": "PT23H59M59S", "valueType": "string", "unitType": "duration" } |
| drivingAfterResting | The driver starts to drive after a rest of the set duration in ISO-8601. | { "value": "PT23H59M59S", "valueType": "string", "unitType": "duration" } |
| servicetime6h | The driver’s service time reaches the set limit without having taken the required minimum break time. Set to 6 hours in ISO-8601. | { "value": "PT6H", "valueType": "string", "unitType": "duration" } |
| servicetime9h | The driver’s service time reaches the set limit without having taken the required minimum break time. Set to 9 hours in ISO-8601. | { "value": "PT9H", "valueType": "string", "unitType": "duration" } |
| enter | Refers to when an asset enters a place with a geofence. | { "valueType": "event", "placeId": "ddeef7fa-ffde-4bb3-9e68-9c0b94198ab9", "placeName": "HQ parking" } |
| leave | Refers to when an asset leaves a place with a geofence. | { "valueType": "event", "placeId": "ddeef7fa-ffde-4bb3-9e68-9c0b94198ab9", "placeName": "HQ parking" } |
Durations in ISO-8601
- P is the duration designator (for period) placed at the start of the duration representation.
- Y is the year designator that follows the value for the number of years.
- M is the month designator that follows the value for the number of months.
- W is the week designator that follows the value for the number of weeks.
- D is the day designator that follows the value for the number of days.
- T is the time designator that precedes the time components of the representation.
- H is the hour designator that follows the value for the number of hours.
- M is the minute designator that follows the value for the number of minutes.
- S is the second designator that follows the value for the number of seconds.
Example:
PT1H30H0S: A duration of 1 hour 30 minutes.