sierrawireless

The protocol for GenX devices by Sierra Wireless.

Below is the list of parameters that can appear in the messages received by the channel via sierrawireless 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
ain number volts Voltage on the analog input
battery.voltage number volts Internal battery voltage
can.ambient.air.temperature number celsius CAN ambient air temperature
can.bus.status string Shows if J1939 bus is intermittent on a dual bus (J1708/J1939) vehicle
can.derived.fuel.consumed number liters Derived fuel usage, read from CAN
can.derived.gas.fuel.consumed number kg Derived natural gas fuel usage, read from CAN
can.derived.vehicle.mileage number km Derived vehicle mileage read from CAN
can.engine.coolant.temperature number celsius Engine coolant temperature read from CAN
can.engine.load.level number percentage Engine load level read from CAN
can.engine.motorhours number hours Total engine motorhours read from CAN
can.engine.oil.pressure number kPa CAN Engine oil pressure
can.engine.oil.temperature number celsius Engine oil temperature
can.engine.rpm number rpm Engine RPM read from CAN
can.fuel.consumed number liters Fuel volume totally consumed by vehicle read from CAN
can.fuel.economy number km/liters CAN instantaneous fuel economy
can.fuel.level number percentage Fuel level in tank read from CAN
can.gas.fuel.consumed number kg Natural gas fuel amount totally consumed by vehicle read from CAN
can.gas.fuel.economy number km/kg CAN instantaneous natural gas fuel economy
can.idle.fuel.consumed number liters Total idle fuel used, read from CAN
can.idle.gas.fuel.consumed number kg Total natural gas idle fuel used, read from CAN
can.onboard.power.voltage number volts CAN onboard power voltage
can.seatbelt.state string Seat belt status, read from CAN
can.throttle.pedal.level number percentage Throttle pedal push level read from CAN
can.total.engine.idle.time number hours Time of engine running in idling status (vehicle stopped) since vehicle manufacture, read from CAN
can.vehicle.mileage number km Total vehicle mileage read from CAN
can.vehicle.speed number km/h Vehicle speed read from CAN
cargo.temperature number celsius Cargo temperature sensor value
channel_id number ID of channel that received message
device.temperature number celsius Temperature of device
din number Digital inputs bitmask
dout number Digital outputs bitmask
engine.ignition.status boolean Engine ignition status
event.enum number Event code, full list of codes available at separate table
event.seqnum number Unique event sequence number
external.powersource.voltage number volts External power voltage
harsh.acceleration.event boolean Harsh acceleration detected
harsh.braking.event boolean Harsh braking detected
harsh.cornering.event boolean Harsh cornering detected
ibutton.code string Hexadecimal code of connected iButton
ident string Device unique identificator and optional password
network.signal.rssi number dbm Network signal strength
onewire.sensor.humidity number percentage External 1-Wire humidity sensor value
onewire.sensor.temperature number celsius External 1-Wire temperature sensor value
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.pdop number Position dilution of precision
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
segment.can.fuel.consumed number liters Fuel volume consumed by vehicle on the last segment using CAN data
segment.can.gas.fuel.consumed number kg Natural gas fuel amount consumed by vehicle on the last segment using CAN data
segment.vehicle.mileage number km Segment mileage
sensor.temperature number celsius Temperature sensor value
server.timestamp number seconds Timestamp when server received message
timestamp number seconds Message timestamp
trip.mileage number km Distance driven since engine start
vehicle.mileage number km Total calculated mileage
vehicle.state string Vehicle state, such as moving, idling, parked etc