topflytech

The protocol for Topflytech GPS tracking devices.

Note: Settings are currently implemented for 3G trackers only (TLD1-A, TLD1-DA, TLW1-4A, TLW1-8A, TLW1-10A).

Below is the list of parameters that can appear in the messages received by the channel via topflytech 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.event boolean Accident event detected
ain number volts Voltage on the analog input
alarm.event boolean Alarm event triggered
alarm.mode.status boolean Device alarm mode status
antitheft.event boolean Antitheft event triggered
average.fuel.consumption number liters/100km Average fuel consumption
battery.level number percentage Internal battery level
battery.low.alarm boolean Battery low alarm event
battery.low.status boolean Battery low status
battery.voltage number volts Internal battery voltage
ble.asset.rssi number BLE (Bluetooth Low Energy) asset signal strength
ble.asset.tag.code string BLE (Bluetooth Low Energy) asset tag ID
ble.sensor.battery.level number percentage BLE (Bluetooth Low Energy) sensor battery level
ble.sensor.battery.voltage number volts BLE (Bluetooth Low Energy) sensor battery voltage
ble.sensor.humidity number percentage BLE (Bluetooth Low Energy) sensor Humidity value
ble.sensor.illuminance number lux BLE (Bluetooth Low Energy) sensor illuminance
ble.sensor.state number BLE (Bluetooth Low Energy) sensor state
ble.sensor.temperature number celsius BLE (Bluetooth Low Energy) sensor Temperature value
can.a.sensor.fuel.level number percentage CAN A digital sensor fuel level
can.dtc string Diagnostic trouble code read from CAN
can.engine.coolant.temperature number celsius Engine coolant temperature read from CAN
can.engine.load.level number percentage Calculated engine load level read from CAN
can.engine.rpm number rpm Engine RPM read from CAN
can.intake.air.temperature number celsius Intake air temperature
can.intake.map number kPa Intake manifold absilute pressure
can.maf.air.flow.rate number g/sec MAF air flow rate read from CAN
can.throttle.pedal.level number percentage Throttle pedal push level read from CAN
case.status boolean Case opened status
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.temperature number celsius Temperature of device
device.type.id number ID of device type of device that received a message
din number Digital inputs bitmask
driver.id string Driver identification card id
engine.ignition.status boolean Engine ignition status
event.code string Unique event identifier string
event.enum number Event code, full list of codes available at separate table
external.powersource.status boolean External power source connection status
external.powersource.voltage number volts External power voltage
fuel.consumed number liters Fuel volume totally consumed by vehicle
geofence.status boolean Geofence entered status
gnss.status boolean GNSS receiver on/off status
gsm.cellid number GSM base station ID
gsm.earfcn number E-UTRA absolute radio-frequency channel number of LTE network
gsm.jamming.event boolean GSM signal jamming detected
gsm.lac number GSM location area code
gsm.mcc string GSM mobile country code
gsm.mnc string GSM mobile network code
gsm.network.name string GSM operator name
gsm.signal.level number percentage GSM signal strength level
gsm.sim.iccid string Integrated Circuit Card Id of SIM card
gsm.sim.imsi string IMSI of SIM card
harsh.acceleration.event boolean Harsh acceleration detected
harsh.braking.event boolean Harsh braking detected
ident string Device unique identificator and optional password
idle.status boolean Vehicle is in idling state
light.sensor.voltage number volts Front light sensor voltage
message.buffered.status boolean Black box message
message.type string Message type
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.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.valid boolean Is position information accurate and valid for given timestamp
power.on.status boolean Power-on device status
protocol.id number ID of protocol
server.timestamp number seconds Timestamp when server received a message
solar.panel.charging.status boolean Solar panel charging device
solar.panel.voltage number volts Solar panel voltage
timestamp number seconds Message timestamp
towing.alarm.status boolean Towing alarm state
tyre.pressure number bar Tyre pressure
tyre.temperature number celsius Tyre temperature
vehicle.mileage number km Total calculated mileage
vehicle.vin string VIN of vehicle
vibration.alarm boolean Vibration alarm event
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
Custom command custom Send custom command to device name: Command name in capital letters

payload: Command data ending with #
Get device IP2 setting
{"name":"IP2","payload":",2#"}
Setup communication mode to UDP
{"name":"DMODE","payload":",2#"}
Set APN with username and password
{"name":"APN","payload":",APN_name,APN_username,APN_password#"}