Below is the list of parameters that can appear in the messages received by the channel via maxtrack 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 |
air.pressure | number | bar | Air pressure |
alarm.event | boolean | Alarm event triggered | |
antitheft.event | boolean | Antitheft event triggered | |
battery.charging.status | boolean | Battery charging status | |
battery.status | string | Battery status | |
can.ambient.air.temperature | number | celsius | CAN ambient air temperature |
can.engine.oil.temperature | number | celsius | Engine oil temperature |
can.engine.rpm | number | rpm | Engine RPM read from CAN |
can.engine.temperature | number | celsius | Engine temperature read from CAN |
can.fuel.consumption | number | liters/h | Engine fuel rate read from CAN |
can.intake.air.temperature | number | celsius | Intake air temperature |
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 |
can.vehicle.mileage | number | km | Total vehicle mileage read from CAN |
can.vehicle.speed | number | km/h | Vehicle speed read from CAN |
channel.id | number | ID of channel that received a message | |
crash.accelerometer.status | boolean | Crash accelerometer is calibrated | |
device.id | number | ID of device that received a message | |
device.model | string | Device model ID string | |
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 | |
dout | number | Digital outputs bitmask | |
driver.id | string | Driver identification card id | |
engine.ignition.on.duration | number | seconds | Duration when engine is on |
engine.ignition.state.enum | number | Engine ignition input state | |
engine.ignition.status | boolean | Engine ignition status | |
engine.motorhours | number | hours | Total calculated engine motorhours |
engine.rpm | number | rpm | Engine RPM read from CAN |
event.enum | number | Event code, full list of codes available at separate table | |
event.seqnum | number | Unique event sequence number | |
external.powersource.status | boolean | External power source connection status | |
external.powersource.voltage | number | volts | External power voltage |
extnav.position.speed | number | km/h | External receiver instant speed at position detection moment |
fuel.level | number | percentage | Fuel level percentage |
gnss.antenna.status | boolean | GNSS receiver antenna status | |
gnss.type | string | GNSS type: gps, glonass, etc... | |
gnss.vehicle.mileage | number | km | Vehicle mileage calculated by global navigation system (GNSS) |
gprs.status | boolean | GPRS mobile network status | |
gsm.cellid | number | GSM base station ID | |
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.status | boolean | Registration in GSM network | |
ident | string | Device unique identificator and optional password | |
message.buffered.status | boolean | Black box message | |
movement.status | boolean | Current movement state | |
overspeeding.event | boolean | Overspeeding detected | |
overspeeding.status | 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.hdop | number | Horizontal dilution of precision | |
position.latitude | number | degrees | Latitude coordinate value |
position.longitude | number | degrees | Longitude coordinate value |
position.pdop | number | Position dilution of precision | |
position.speed | number | km/h | Instant speed at position detection moment |
power.on.status | boolean | Power-on device status | |
protocol.id | number | ID of protocol | |
server.timestamp | number | seconds | Timestamp when server received a message |
sleep.mode.status | boolean | Device is in sleep mode | |
timestamp | number | seconds | Message timestamp |
total.idle.seconds | number | seconds | Total time that vehicle was in idling state |
trip.status | boolean | Trip status, true if trip started, false - if stopped | |
vehicle.mileage | number | km | Total calculated mileage |
vehicle.vin | string | VIN of vehicle |
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, message type 0x33. Note! This command is applicable to Maxtrack binary protocol devices, not protobuf! | payload: Parameter value. Variable length. Depends on parameter_id parameter_id: HEX representation of number that defines which parameter to change |
Activate output 2 (see SPC_OUTPUT_MACRO3 command)
{"payload":"02FFFFFFFFFFFF","parameter_id":"57"}
Activate output 1 for 5 seconds in 2 cycles (see SPC_OUTPUT_MACRO3 command)
{"payload":"010005FFFF0002","parameter_id":"57"}
|