omnicomm

The protocol for Omnicomm GPS tracking devices.

Below is the list of parameters that can appear in the messages received by the channel via omnicomm 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
absolute.acceleration number g Module of accelerometer vector
ain number volts Voltage on the analog input
alarm.event boolean Alarm event triggered
can.engine.rpm number rpm Engine RPM read from CAN
can.onboard.power.voltage number volts CAN onboard power voltage
can.vehicle.speed number km/h Vehicle speed read from CAN
channel_id number ID of channel that received message
dout number Digital outputs bitmask
driver.status.enum number Driver status
engine.ignition.status boolean Engine ignition status
event.enum number Event code, full list of codes available at separate table
external.powersource.level number percentage External battery level
fuel.level number percentage Fuel level percentage
fuel.sensor.state number Fuel sensor state code
gsm.module.status boolean GSM module is ON
gsm.network.roaming.status boolean GSM network in roaming mode
ident string Device unique identificator and optional password
liquid.sensor.fuel.temperature number celsius Fuel temperature reported by LLS
onboard.equipment.id number The ID of the onboard equipment
onewire.sensor.temperature number celsius External 1-Wire temperature sensor value
passengers.in.count number The number of passengers who got in
passengers.out.count number The number of passengers who got out
passengers.sensor.mask number Passengers sensor doors mask
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.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
position.valid boolean Is position information accurate and valid for given timestamp
server.timestamp number seconds Timestamp when server received message
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