Event codes

Event codes

Below is a list of event codes broadcasted by ATS to both the server configured in Setting 1 and other applications using an implicit intent with action com.micronet.dsc.ats.device.event or com.micronet.dsc.ats.vehicle.event.

Code
Event name
Direction
Description
DLEN and DATA variables
1
ACK
Both
Acknowledge a prior message as received

2
NAK
MO
Indicate an invalid command from the server

5
System boot
MO
The android system has booted and started the application
DLEN=5
D_BOOT_INP
D_VERSION_ATS
D_BOOT_RTC
D_BOOT_UPMIN
6
Service restart
MO
The application was stopped and is now restarted (not due to a boot)
DLEN=3
D_VERSION_ATS
D_RESTART
7
Service resume
MO
The application was running but paused (system was sleeping or was resource starved)

8
System shutdown
MO
The android system is being shut down
DLEN=5
D_SHUTDOWN
D_HB_NEXT
10
Heartbeat
MO
A Heartbeat event has been triggered.

11
Ping
MO
A Ping event has been triggered

12
Watchdog Error
MO
The Watchdog has determined there is an error
DLEN=1
D_ERR_WD
13
System time changed
MO
T^he system time was wrong and the application has set it to a new value.

14
Configuration file changed
MO
If multiple settings or mappings are changed at the same time (such as when an entire code map is cleared at once, or when a new configuration file is loaded at ATS startup), then this message is triggered.  Note: if ATS is running at the time of change and a single setting or mapping is changed at a time, then event code 100, 101, or 102 will be triggered instead.
DLEN=1
D_CFG_FILES
20
Ignition Key On
MO
Ignition key input has changed to high/logically active/on.

21
Input 1 on
MO
Input 1 has changed to logically active.

22
Input 2 on
MO
Input 2 has changed to logically active

23
Input 3 on
MO
Input 3 has changed to logically active

24
Input 4 on
MO
Input 4 has changed to logically active

25
Input 5 on
MO
Input 5 has changed to logically active

26
Input 6 on
MO
Input 6 has changed to logically active

30
Ignition Key Off
MO
Ignition key input has changed to not high/logically inactive/off. Note: VBS is not required to trigger the message, but is required for some data fields.
DLEN=10
D_ODOM_ACT
D_FUEL_TOTAL
D_FUEL_AVG
31
Input 1 off
MO
Input 1 has changed to logically inactive

32
Input 2 off
MO
Input 2 has changed to logically inactive

33
Input 3 off
MO
Input 3 has changed to logically inactive

34
Input 4 off
MO
Input 4 has changed to logically inactive

35
Input 5 off
MO
Input 5 has changed to logically inactive

36
Input 6 off
MO
Input 6 has changed to logically inactive

40
Engine Status On
MO
The engine status has turned on/active. Since the D_VIN field can vary in length, the total length of the DATA field can vary as well. There is a 15 second delay before triggering this event to allow time to retrieve info from the engine.  The event will not be triggered if the engine turns off before the delay is completed.  Note: VBS is not required to trigger the message, but is required for some data fields.
 DLEN=(varies)
D_VBUS
D_VIN
D_ODOM_ACT
D_FUEL_TOTAL
D_FUEL_AVG
41
Low Battery Status On
MO
The Low Battery (while Engine Off) status has turned on/active.

42
Bad Alternator Status On
MO
The Bad Alternator (Low Battery while Engine On) status has turned on/active

43
Idling On
MO
Idling status has turned on/active. (Vehicle has been "idling" for longer than the time value in Setting #18 Parameter #1).

50
Engine Status Off
MO
The Engine Status has turned off/inactive. This event will not be triggered if the Engine Status turns off before the Engine Status On event is triggered.

51
Low Battery Status Off
MO
The Low Battery (while Engine Off) status has turned off/inactive.

52
Bad Alternator Status Off
MO
The Bad Alternator (Low Battery while Engine On) Status has been turned off/inactive

53
Idling Off
MO
Idling status has been cleared (Vehicle is no longer idling)

60
Speeding
MO
Speeding has been detected.

61
Rapid acceleration
MO
Rapid acceleration has been detected

62
Harsh braking
MO
Harsh braking has been detected

63
Harsh cornering
MO
Harsh cornering has been detected

70
Reverse gear on
MO
VBS required: Reverse has been turned on. Requires J1939 connection

71
Parking brake on
MO
VBS required: Parking brake has been turned on. Requires J1939 connection.

72
Fault code on
MO
VBS required: A fault code is now present and active on the vehicle when it was not before.  This message is not sent if only the occurrence count has changed.  The D_VBUS field indicates which vehicle bus the fault code was received from.  Requires J1939 or J1587 connection.
DLEN=7
D_VBUS
D_DTC
D_DTC_SOURCE
D_LAMPS
73
Fuel status update
MO
VBS required: A status update has been triggered. Requires J1939 or J1587 connection.
DLEN=6
D_FUEL_TOTAL
D_FUEL_AVG
80
Reverse Gear Off
MO
VBS required: Reverse has been turned off. Requires J1939 connection.

81
Parking Brake Off
MO
VBS required: Parking brake has been turned off. Requires J1939 connection.

82
Fault Code Off
MO
VBS required: A fault code is no longer present or active on the vehicle. A decreasing occurrence count for the code is not enough to trigger this message; the code must no longer be active. Requires J1939 or J1587 connection. The D_VBUS field indicated which vehicle bus the fault code was received from.
DLEN=7
D_VBUS
D_DTC
D_DTC_SOURCE
D_LAMPS
90
Custom Payload
MO
Another application on the device has requested ATS to forward this data to the server. Contains the raw data received from the other application without interpretation.
DLEN=(varies)
D_FWD_ID
D_FWD_DATA
100
Configured Setting
MO
A feature setting was configured or changed. If the change was due to a UDP message, then this is not sent (only the ACK is sent).
DLEN=1
D_CFG_SID
100
Configure Setting
MT
Configure a feature setting.

D_CFG_SVAL contains a new value for the setting identified by D_CFG_SID. If this new value is omitted (DLEN equals 1 and DATA only contains the D_CFG_SID), then the existing setting is removed and the default value for the setting is restored.
DLEN=(varies)
D_CFG_SID
D_CFG_SVAL
101
Configured MO map
MO
An entry in the EventCode map for MO messages was changed. If the change was due to a UDP message, then this is not sent (only the ACK is sent).
DLEN=1
D_EC_INTERN
101
Configured MO map
MT
Configure an entry in the EventCode map for MO messages
DLEN=2
D_EC_INTERN
D_EC_EXTERN
102
Configured MT map
MO
An entry in the EventCode map for MT messages was changed. If the change was due to a UDP message, then this is not snet (only the ACK is sent).
DLEN=1
D_EC_EXTERN
102
Configure MT map
MT
Configure an entry in the EventCode map for MT messages
DLEN=2
D_EC_EXTERN
D_EC_INTERN
125
Reset FOTA updater
both
To Device: Clear the data files associated with the redbend client used for FOTAs, resetting it to a factory installed state. This requires the ResetRB apk to be co-installed on the device.
To server: Redbend data files were cleared by the ResetRB app.



DATA field values

Variable
Length (bytes)
Units
Description
D_BOOT_INP
1
bitfield
A bit value of 1 indicates the corresponding Wakeup Input was physically high when the last kernel boot began. Can be used to determine which Wakeup Input (if any) caused a boot.

A value of 0xFF for the byte is used to indicate that these values are unknown. Otherwise:
bit 0 (least significant bit): ignition key input
bit 1: general purpose wakeup input 1
bit 2: general purpose wakeup input 2
bit 3: general purpose wakeup input 3
bits 5-7: reserved (always 0)
D_BOOT_RTC
1
bitfield
A bit value of 1 indicates the corresponding RTC condition was true at the time when the last kernel boot begtan. A value of 0xFF for the byte is used to indicate that these values are unknown. Otherwise:

bit 0 (least significant bit): RTC woke the device for this boot.
bit 1: RTC lost power between this boot and the prior boot.
D_BOOT_UPMIN
1
minutes
the number of minutes since the last kernel boot. 0xFF means "255 or more minutes".
D_CFG_FILES
1
bitfield
A bit value of 1 indicates the corresponding file was loaded/overwritten. Can be used to indicate if an ATS configuration file was changed.

bit 0 (least significant bit): configuration.xml file
bit 1: moeventcodes.xml file
bit 2: mteventcodes.xml file
bits 3-7: reserved (always 0)
D_CFG_SID
1
id
One byte indicating a configuration setting ID
D_CFG_SVAL
(varies)

A value for a configuration setting corresponding to a D_CFG_SID
D_DTC
4

A fault code reported by the vehicle bus and defined by SAE J1939 or J1587. The exact interpretation of the values in this field depends on the vehicle bus type and, in some cases, the way the manufacturer implemented the SAE standard on the specific vehicle.  The D_DTC field is composed of an array of 4 bytes, present in this order (see appropriate SAE standard for exact definition of byte meaning):
For J1587: SID/PID; MID; DCC (bits 0-5 only); (last value=0x00)
For J1939: SPN; SPN; SPN+FMI; CM(high bit only)
D_DTC_SOURCE
1

VBS required:
J1939: The source address that is indicating the associated fault code
J1587: Reserved, will always be equal to 0xFF
D_EC_INTERN
1
id
One byte indicating an internal Event Code
D_EC_EXTERN
1

One byte indicating an external Event Code
D_ERR_WD
1
id
Watchdog Error Code
D_FUEL_AVG
2
meters per liter
VBS required:
Average fuel economy, as reported by the vehicle bus.
D_FUEL_TOTAL
4
liters
VBS required:
Total fuel, as reported by the vehicle bus
D_FWD_AID
1

An application-defined value that is used for sending custom payload data from other local applications. If IDs are assigned to each application on the device, then the server can distinguish which device application is responsible for the associated data.
D_FWD_ADAT
(varies)
(string)
An application defined string of data. This raw data that is forwarded by ATS froma device application to the server without any added interpretation.
D_HB_NEXT
4
epoch
The next scheduled heartbeat time in minutes since Unix epoch (00:00:00 UTC on January 1, 1970). This is a 4-byte little endian value.
D_LAMPS
1

A bitfield indicating which vehicle lamps are currently on. The bit meanings are dependent on which bus is reporting it (D_VBUS field).

For J1587:
bit 0: protect lamp
bit 1: amber lamp
bit 2: red lamp
bit 3-7: reserved

For J1939:
bit 0: protect lamp
bit 1: amber lamp
bit 2: red lamp
bit 3: malfunction indicator lamp
bits 4-7: reserved
D_ODOM_ACT
4
meters
VBS required:
Latest odometer that was retrieved from the vehicle bus.
D_RESTART
1

The restart reason.
D_SHUTDOWN
1

The shutdown reason.
D_VBUS
1
bitfield
VBS required:
A bit value of 1 indicates that ATS is currently communicating with the corresponding vehicle bus.
bit 0: J1939 250Kb bus
bit 1: J1939 500Kb bus
bit 2: J1587 bus
bits 3-7: reserved (always 0)
D_VERSION_ATS
2
integer
The ATS apk version code. 
D_VIN
(varies)

One byte indicating the length if the VIN, followed by the VIN string itself as reported by the vehicle. This field has a total length of VIN.length+1 bytes.  If the first byte is 0, then this field is only 1 byte long and it means there is no VIN available.




    • Related Articles

    • ATS intents

      ATS communicates with other applications and services using implicit intents.  Implicit intents read by ATS include: Action Extras Description com.micronet.dsc.ats.ping Can be sent periodically to guarantee that ATS is running or to start ATS if it ...
    • Basic ATS information

      ATS is a service that allows Android applications to communicate with vehicle hardware.  Originally, ATS stood for "A-317 Telematics Service," but its functionality was expanded to the SmartHub.  ATS is configured using an xml file and uses implicit ...
    • Micronet Warranty Policy 08-2018

      Warranty Policy This warranty ("Warranty") cover each and any of Micronet Ltd. ("Micronet") hardware and/or software products ("Product/s"). This Warranty contains all the terms and conditions pertaining to Micronet's liability with regard to the ...