Wialon IPS Protocol

Usage specifics Parameters (54) Commands (2) Devices (11) Changelog

Wialon IPS communication protocol was developed by Gurtam for personal and vehicle GPS/GLONASS trackers that send data to satellite monitoring system server over TCP and UDP.

Wialon IPS protocol is freely distributed under GNU FDL and can be used by manufacturers of GPS and GLONASS equipment as the main protocol for data transmission between GPS/GLONASS trackers and communication server of satellite monitoring system.

The flespi platform can work over both Wialon IPS v1.1 and 2.0.

Note, it is not compatible with Wialon Retranslator and Wialon Combine protocols.

Name

Type

Unit

Description

Sources

absolute.acceleration

number

Module of accelerometer vector

field 'accelerometer'

absolute.deceleration

number

Module of deceleration value from accelerometer

field 'accel_res'

ain

number

volts

Voltage on the analog input

#B,
#D

alarm.event

boolean

Alarm event triggered

field 'SOS'

battery.level

number

percentage

Internal battery level

field 'battery'

battery.voltage

number

volts

Internal battery voltage

field 'pwr_int'

can.axle.weight

number

Weight on the axle read from CAN

field 'axis_weight'

can.engine.coolant.temperature

number

celsius

Engine coolant temperature read from CAN

field 'cool_temp'

can.engine.temperature

number

celsius

Engine temperature read from CAN

field 'engine_temp'

can.fuel.volume

number

liters

CAN fuel volume

field 'fuel_volume'

channel.id

number

ID of channel that received a message

device.id

number

ID of device that received a message

device.name

string

Name of device that received a message

device.type.id

number

ID of device type of device that received a message

din

number

Digital inputs bitmask

#B,
#D

dout

number

Digital outputs bitmask

#B,
#D

driver.message

string

Driver text message content

engine.ignition.status

boolean

Engine ignition or ACC status

field 'engine operation',
field 'ign'

engine.motorhours

number

hours

Total calculated engine motorhours

field 'engine_hours'

engine.oil.pressure

number

Engine oil pressure

field 'oil_pressure'

engine.rpm

number

rpm

Engine RPM read

field 'engine rpm',
field 'engine_rpm'

external.powersource.voltage

number

volts

External power voltage

field 'pwr_ext'

fuel.consumed

number

liters

Fuel volume totally consumed by vehicle

field 'fuel_consumption'

fuel.level

number

percentage

Fuel level percentage

field 'fuel_level'

fuel.volume

number

liters

Fuel volume

field 'fuel level'

gsm.cellid

number

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) base station ID

field 'cell_id',
field 'gsm_cell'

gsm.lac

number

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) location area code

field 'lac'

gsm.mcc

number

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) country code

field 'mcc'

gsm.mnc

number

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) code

field 'mnc'

gsm.network.roaming.status

boolean

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) in roaming mode

field 'hw_cfg_in_roaming'

gsm.signal.level

number

percentage

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) signal strength level

field 'gsm'

ibutton.code

string

Hexadecimal code of connected iButton

#B,
#D,
field 'avl_driver',
field 'ibutton'

ident

string

Device unique identifier like serial number, IMEI, etc

media

boolean

Message contain media file

media.image

object

Image file in media storage

peer

string

IP:port from which device connecting to the channel

position.altitude

number

meters

Altitude value for position

#B,
#D,
#SD

position.direction

number

degrees

Heading angle at position detection moment

#B,
#D,
#SD

position.hdop

number

Horizontal dilution of precision

#B,
#D,
field 'hdop'

position.latitude

number

degrees

Latitude coordinate value

#B,
#D,
#SD

position.longitude

number

degrees

Longitude coordinate value

#B,
#D,
#SD

position.satellites

number

Quantity of satellites used to calculate coordinates for given position information

#B,
#D,
#SD

position.speed

number

km/h

Instant speed at position detection moment

#B,
#D,
#SD

protocol.id

number

ID of protocol

protocol.version

string

Protocol version string

field 'hw_cfg_protocol_version'

server.timestamp

number

seconds

Timestamp when server received a message

software.version

string

Software version string

field 'sf_ver'

tacho.position.speed

number

km/h

Instant speed reported by tacho

field 'taho_speed'

timestamp

number

seconds

Message timestamp

#B,
#D,
#SD

touch.memory.id

number

Touch Memory Key ID

field 'touch_key'

vehicle.mileage

number

Total calculated mileage

field 'mileage'

x.acceleration

number

Accelerometer value X

field 'accel_x'

y.acceleration

number

Accelerometer value Y

field 'accel_y'

z.acceleration

number

Accelerometer value Z

field 'accel_z'

Title

Name

Description

Properties

Custom message command Examples

custom

The command is used to send custom messages to the device. It allows to implement additional features necessary for the controller. is added automatically

message: Text of the message

Send custom message command

{"message":"Text of the message"}

Text message Examples

text_msg

Send text message to device

message: Text message content

Send text message

{"message":"this is message text"}

Device

Manufacturer