ERM Protocol

Below is the list of parameters that can appear in the messages received by the channel via erm protocol. In most parameters, the name consists of tags split by dots: tag1.tag2.tag3.tag4... Each tag defines a certain area of an application, e.g. any parameter that contains mileage data has the 'mileage' tag in the name and any parameter related to fuel control contains the 'fuel' tag. By default JSON fields of the message received by a channel via this protocol can only contain the below-specified parameters. Any additional parameter will be prefixed by the "custom" tag, e.g. "custom.unspecified-name".

Name	Type	Unit	Description
accident.direction	number		Direction of accident
accident.direction.description	string		Description of accident direction
accident.event	boolean		Accident event detected
ain	number	volts	Voltage on the analog input
alarm.event	boolean		Alarm event triggered
battery.voltage	number	volts	Internal battery voltage
channel_id	number		ID of channel that received message
din	number		Digital inputs bitmask
door.open.status	boolean		Door open status
dout	number		Digital outputs bitmask
engine.ignition.on.duration	number	seconds	Duration when engine is on
engine.ignition.status	boolean		Engine ignition status
error.level	number		Error level number
error.level.description	string		Error level description string
error.type	number		Error type identification number
error.type.description	string		Error description string
external.powersource.voltage	number	volts	External power voltage
gsm.signal.level	number	percentage	GSM signal strength level
hood.open.status	boolean		Hood open status
ibutton.code	string		Hexadecimal code of connected iButton
ident	string		Device unique identificator and optional password
lca.alarm.armed.status	boolean		Armed state
lca.alarm.connection.status	boolean		Communication state
lca.alarm.serial.number	number		Alarm serial number
lca.alarm.siren.status	boolean		Sirene activate state
lca.alarm.timestamp	number		Lca alarm timestamp
lca.alarm.version	number		Alarm version
max.position.speed	number	km/h	Maximum speed on segment
movement.event	boolean		Movement detected
movement.status	boolean		Current movement state
overspeeding.event	boolean		Overspeeding detected
peer	string		IP:port from which device connecting to the channel
position.altitude	number	meters	Altitude value for position
position.direction	number	degrees	Heading angle at position detection moment
position.hdop	number		Horizontal dilution of precision
position.latitude	number	degrees	Latitude coordinate value
position.longitude	number	degrees	Longitude coordinate value
position.satellites	number		Quantity of satellites used to calculate coordinates for given position information
position.speed	number	km/h	Instant speed at position detection moment
position.timestamp	number	seconds	Timestamp when coordinates where calculated
protocol.version	string		Protocol version string
sensor.temperature	number	celsius	Temperature sensor value
server.timestamp	number	seconds	Timestamp when server received message
software.version	string		Software version string
timestamp	number	seconds	Message timestamp
vehicle.mileage	number	km	Total calculated mileage
x.acceleration	number	g	Accelerometer value X
y.acceleration	number	g	Accelerometer value Y
z.acceleration	number	g	Accelerometer value Z

Below is the list of commands that can be sent to devices to change their configuration or to send signals to various outputs. When sending a command you can specify the transport type defining how the command will be delivered - the address parameter can take values connection (via network connection once the device goes online), sms (via SMS message), push (via PUSH notification). A comprehensive format of each command with all possible parameter values, parameter types, default values, etc. can be found in the REST API documentation in your flespi.io account.

Title	Name	Description	Properties
Get location	generic.get_location	Get location
Get param	generic.getparam	Get configuration param value	param: Param number
Output off	generic.output_off	Output off	outnum: Number/id of output
Output on	generic.output_on	Output on	outnum: Number/id of output
Set param	generic.setparam	Set configuration param value	param: Param number value: Param value