The AirLink Mobility Manager Event Reporting application (from here on referred to as AMMER) is an AAF application that allows ALEOS gateways to provide management, status, and telemetry data to the AMM in order to provide reporting capabilities much the same as MG gateways.
AMMER acts as a conduit for data collected from a gateway’s internal state and status information, as well as telemetry information from a vehicle connected via the internal OBDII interface on the MP70 or an external OBDII interface on other gateway models. AMMER then forwards that information to the AMM. Note that AMMER can work without an OBDII interface, but will not provide vehicle telemetry information.
This section lists the aspects of the AMM that AMMER supports.
Note: For the MP70 the internal CAN interface must be enabled to access OBDII telemetry, or the serial port needs to be reserved for AAF applications for other gateways using B&B Streamer. Both of these gateway settings can be configured using ACEManager.
Note:
- AMMER requires port TCP 44900 to be open between ALEOS gateways and the AMM.
- AMMER will write events to Flash if the device is out of coverage, allowing data to persist across a device reboot. By default, the app will store 10,000 events, but is user configurable to store other amounts. Using the default settings, you can expect approximately three to five hours of data collection before the app runs out of space.
In order for an AMMER device to send WAN events to the AMM for an Ethernet connection, the device’s Ethernet connection must be explicitly set to WAN. WAN events will NOT be sent if the connection is set to Auto. To set an Ethernet Connection to WAN, open ACEmanager, navigate to LAN -> Ethernet, and adjust the setting.
The following list of configuration settings allow several system related functions to be altered. These are accessed through the telemetry configuration settings.
Configuration Settings
Parameter | Default Value | Description |
sys_log_level | INFO |
Sets the current ALEOS log verbosity level for the AMMER application. Valid values are defined by AAF, and are, in order if increasing verbosity: “NONE”, “ERROR”, “WARNING”, “INFO”, “DETAIL”, “DEBUG”, “ALL”. Note: AMMER is also subjected to the log level set for the Application (in AceManger Admin/Log/ Configure Logging), so the configured log level there may also need to be increased. Level INFO is recommended. |
sys_tx_persist_rate | 30 (Seconds) | Sets the period at which the M3DA transmission queue is persisted to non-volatile storage. |
sys_tx_persist_threshold | 5 (events) | Sets the minimum number of queued events needed for M3DA transmission queue to be persisted to non-volatile storage. |
sys_tx_latency | 5 (seconds) | Sets the maximum M3DA transmission latency period. |
sys_tx_maxsend | 256 (events) | Sets the maximum number of events sent in one M3DA transmission envelope. |
sys_tx_maxqueue | 10000 (events) | Sets the maximum number of un-sent events which may be queued. 0 means no limit. When the limit has been reached, an informational message will be en-queued indicating this. |
sys_tx_queuetrail | 500 (events)x | Sets the maximum number of (most recent) stale (sent) events to retain for debugging purposes. |
tun_enabled | 1 | Enables (1) or disables (0) the management tunnel. |
rssi_filter_len | 10 | Configurable parameter for WAN Extended Signal Report. Controls the average RSSI value that is used to generate dBm. A simple rolling average is applied to a sampled RSSI (1 second sample rate), with each new sample comprising 1/rssi_filter_len of the value. |
Received telemetry data is filtered based on the configuration setting for each parameter, and consists of the following settings: enable, threshold, min report rate, max report rate. Not all the settings appear for each parameter, as it depends on what the parameter is. i.e. Threshold and min report rate are meaningless when used in context for acceleration incidents. The configuration is saved in the AAF device tree configuration section (non-volatile storage). Telemetry data that meets the filter criteria generates an event with the new value and the event is then sent to AMMER for forwarding to AMM.
For each of the telemetry parameters, the following configuration parameters are specified, in order of appearance, in the configuration:
Configuration Parameters for the Telemetry Parameters
Parameter | Values | Units | Meaning |
Enable | 0 or 1 | Boolean |
1: Enable report 0: Disable report |
Threshold | Number | Units of parameter |
> 0: Report if value changes by at least this amount since last report 0: Disable threshold reporting |
Min Rate | Integer | Seconds |
> 0: Report at least this frequently (Seconds) 0: Min report rate disabled |
Max Rate | Integer | Seconds |
> 0: Report no more frequently than this rate (Seconds) 0: Max report rate disabled |
A configuration setting is available for each supported PID. The configuration data for each of these is in a string, consisting of a collection of comma separated parameter=value pairs to reduce the number of required configuration setting values. Values that are missing are assumed to be default (typically 0 or false). For example, the Engine Speed setting could be represented as “enable=1,threshold=100.0,min=900,max=0”. The string “enable=1,threshold=50” would imply full setting of “enable=1,threshold=50,min=900,max=0” (the missing values filled in from defaults).
A set of default configuration values is provided for each telemetry parameter to provide a basic, defined default operation.
AMMER Configurable-Parameters Interface
The table below contains the configuration settings for AMMER event reporting. Each configuration setting can be enabled and set to specify a threshold for reporting the event, a minimum event frequency, and a maximum event frequency. Setting the enabled flag to 0 disables the setting, while setting it to 1 enables the setting. The min frequency sets the minimum report period (reports will be sent at least every min seconds); the max frequency sets the maximum rate at which reports are sent (reports will not be sent more than once every max seconds).
AMMER Configurable Parameters
Configuration Name | Value/Threshold Units | Default Values | Description |
acceleration_incident_end | Milli g-force | enable=1, max=0 | Configure acceleration threshold required to end an accelerometer event report. |
acceleration_incident_start | Milli g-force | enable=1, max=0 | Configure acceleration required to start an accelerometer event report. |
ambient_air_temperature | Degrees Celsius |
enable=1, threshold=2, min=600, max=5 |
Configure changes in ambient air temperature which trigger an ambient air temperature event. |
battery_voltage | Volts |
enable=0, threshold=0, min=0, max=0 |
Configure changes in battery voltage which trigger a battery voltage event. |
board_temperature | Degrees Celsius | Enable=1, threshold=0.5, min=0, max=5 | Configure reporting of gateway board temperature. |
brake_switch_status | Number | enable=0, min=0, max=0 | Configure change required to trigger a brake switch status event. Defined such that 0 means brake switch is off, non-zero for on. |
cornering_incident_end | Milli g-force | enable=1, max=0 | Configure acceleration threshold required to end a cornering event report. |
cornering_incident_start | Milli g-force | enable=1, max=0 | Configure acceleration threshold required to start a cornering event report. |
cpu_load | Percent | Enable=1, threshold=0, min=0, max=5 | Configure reporting of CPU load. |
deceleration_incident_end | Milli g-force | enable=1, max=0 | Configure deceleration threshold required to end a deceleration event report. |
deceleration_incident_start | Milli g-force | enable=1, max=0 | Configure deceleration threshold required to end a deceleration event report. |
distance_since_dtc_cleared | Miles | enable=1, threshold=1, min=0, max=5 | Configure distance since trouble code changed required to trigger event. |
dreckon_enabled | Number | enable=1, max=0 | Reports the current state of the Dead Reckoning enabled setting. |
dreckon_sensor_calibration | Number | enable=1, max=0 | Configure dead reckoning calibration event reporting. |
dtcs | Text | enable=1 | Configure change in trouble code text required to trigger a dtcs event report. |
engine_coolant_temp | Degrees Fahrenheit | enable=1, threshold=10, min=900, max=5 | Configure change in temperature required to trigger an engine coolant temperature event report. |
engine_run_time | Seconds | enable=1, threshold=60, min=0, max=0 | Configure change in time required to trigger an engine run time event report. |
engine_speed | Number | enable=1, threshold=100, min=60, max=5 | Configure change in RPM required to trigger an engine speed event report. |
fuel_level | Percent | enable=1, threshold=2, min=120, max=5 | Configure change in fuel level percentage required to trigger a fuel level event report. |
fuel_rate | gph | enable=0, threshold=0, min=0, max=0 | Configure reporting of Fuel Rate. |
gpslocation | Meters | enable=1, threshold=20, min=300, max=5 | Configure change in latitude/longitude required to trigger an GPS location event report. |
gpsspeed | Meters per Hour | enable=1, threshold=3200, min=60, max=5 | Configure change in GPS reported speed required to trigger a GPS speed event report. |
heartbeat | Seconds | enable=1, min=60 | Configure change in time required to trigger a heartbeat event report. Uptime of the gateway given in seconds. |
ignition_status | Number | enable=0, min=0, max=0 | Configure change in status required to trigger an event. Defined such that 0 means ignition is off, non-zero for on. |
inputX | Number | enable=0, max=0 | A digital GPInput state for input (X) 1 through 6. |
input_anX | Number | enable=0, threshold=0, min=0, max=0 | An analog GPInput value for input (X) 1 through 8. |
main_supply | Millivolts | enable=1, threshold=150, min=0, max=5 | Configure reporting of gateway supply voltage. |
mil_status | Number | enable=0, min=0, max=0 | Configure change in status required to trigger an event. Defined such that 0 means MIL is off, nonzero for on. |
odometer | Miles | enable=1, threshold=0, min=0, max=5 | Configure changes in the vehicle’s odometer value required to trigger an odometer event report. |
pto_status | Number | enable=0, min=0, max=0 | Configure change in status required to trigger an event. Defined such that 0 means power take off has ended, non-zero for start. |
seatbelt_fastened | Number | enable=0, min=0, max=0 | Configure change in status required to trigger an event. Defined such that 0 means seatbelt is not fastened, non-zero for fastened. |
throttle_position | Percentage as Integer | enable=0, threshold=0, min=0, max=0 | Configure change in throttle position required to trigger a throttle position event report. |
tire_pressures | PSI | enable=0, threshold=0, min=0, max=0 | Configure reporting of tire pressures. All tires reported together; threshold applies to any tire. |
transmission_fluid_temperature |
Degree Fahrenheit |
enable=0, threshold=0, min=0, max=0 | Configure change in temperature required to trigger a transmission fluid temperature event report. |
trip_fuel_consumption | Gallons | enable=0, threshold=0, min=0, max=0 | Configure change in fuel required to trigger a trip fuel consumption event report. |
tun_address | Number | enable=1 | Reports the current client-side management tunnel address. When tunnel is disconnected, reports 0 (0.0.0.0). Statistic name: “ManagementTunnel-IPAddress” (IPv4 address). |
vehicle_speed | Miles per Hour | enable=1, threshold=5, min=60, max=5 | Configure change in speed required to trigger a vehicle speed event report. |
vin | Text | enable=1 | Enable change in Vehicle Identification Number text to trigger an event report. |
wan_sig_ext | Number | enabled=1, threshold=5(dBm), min rate=0, max rate=0 | Configurable parameter for WAN Extended Signal Report. Reporting is controlled by wan_sig_ext. The report threshold is applied against the dBm report value (averaged RSSI) to avoid excessive values being reported. |
wanlinkrxbytes | Number of Bytes | enable=1, threshold=500, min=0, max=30 |
Configure increase in received bytes required to trigger a wanlinkrxbytes event report. |
wanlinktxbytes | Number of Bytes | enable=1, threshold=500, min=0, max=30 | Configure increase in transmitted bytes required to trigger a wanlinktxbytes event report. |
The DELS events are generated and forwarded to AMM independent of the scanner/streamer connected. These events are triggered immediately upon detecting a change. Some events are configurable, while others are sent on an as-generated basis.
1 ALEOS devices only emit this DELS event for cellular links.
The following telemetry events are generated and forwarded to AMM when a scanner/streamer device is connected. If no device is connected, or if the device becomes disconnected, then a disconnect message will be sent.