wialon_ips

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. 

Below is the list of parameters that can appear in the messages received by the channel via wialon_ips 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
absolute.deceleration number g Module of deceleration value from accelerometer
ain number volts Voltage on the analog input
alarm.event boolean Alarm event triggered
battery.level number percentage Internal battery level
battery.voltage number volts Internal battery voltage
can.axle.weight number kg Weight on the axle read from CAN
can.engine.coolant.temperature number celsius Engine coolant temperature read from CAN
can.engine.temperature number celsius Engine temperature read from CAN
can.fuel.volume number liters CAN 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
dout number Digital outputs bitmask
driver.message string Driver text message content
engine.ignition.status boolean Engine ignition status
engine.motorhours number hours Total calculated engine motorhours
engine.oil.pressure number Engine oil pressure
engine.rpm number rpm Engine RPM read from CAN
external.powersource.voltage number volts External power voltage
fuel.consumed number liters Fuel volume totally consumed by vehicle
fuel.level number percentage Fuel level percentage
fuel.volume number liters Fuel volume
gsm.cellid number GSM base station ID
gsm.lac number GSM location area code
gsm.mcc string GSM mobile country code
gsm.mnc string GSM mobile network code
gsm.network.roaming.status boolean GSM network in roaming mode
gsm.signal.level number percentage GSM signal strength level
ibutton.code string Hexadecimal code of connected iButton
ident string Device unique identificator and optional password
image.bin.jpeg string Image binary data in JPEG format, base64 encoded
image.name string Name of image file captured by camera
image.timestamp number seconds Timestamp when image was taken
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
protocol.id number ID of protocol
protocol.version string Protocol version string
server.timestamp number seconds Timestamp when server received a message
software.version string Software version string
tacho.position.speed number km/h Instant speed reported by tacho
timestamp number seconds Message timestamp
touch.memory.id number Touch Memory Key ID
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
Text message text_msg Send text message to device message: Text message content
Send text message
{"message":"this is message text"}