albatross

This protocol is used by all Albatross GPS tracking devices.

Below is the list of parameters that can appear in the messages received by the channel via albatross 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
backup.battery.voltage number volts Backup battery voltage
battery.status string Battery status
battery.voltage number volts Internal battery voltage
can.adblue.level number percentage Adblue level read from CAN
can.alternative.fuel.level number liters Alternative fuel level read from CAN
can.axle.weight number kg Weight on the axle read from CAN
can.eco.accelerator.range number seconds Range for accelerator parameter for Eco driving, CAN data
can.eco.brake.range number seconds Range of brake parameter for Eco driving, CAN data
can.eco.engine.rpm.range number seconds Range for engine speed parameter for Eco driving, CAN data
can.eco.pedal.range number seconds Range of pedal press for Eco driving, CAN data
can.eco.speed.range number seconds Range for speed parameter for Eco driving, CAN data
can.engine.braking.factor number Engine braking factor value, read from CAN
can.engine.load.level number percentage Calculated engine load level read from CAN
can.engine.motorhours number hours Total engine motorhours read from CAN
can.engine.oil.level number Engine oil level
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.consumed number liters Fuel volume totally consumed by vehicle read from CAN
can.fuel.consumption number liters/h Engine fuel rate read from CAN
can.fuel.idle.consumed number liters Fuel volume totally consumed during idling state of the vehicle read from CAN
can.fuel.level number percentage Fuel level in tank read from CAN
can.fuel.volume number liters CAN fuel volume
can.hydraulic.oil.temperature number celsius Hydraulic oil temperature read form CAN
can.maintenance.before.mileage number km Mileage before next maintenance read from CAN
can.pedal.braking.factor number Pedal braking factor value, read from CAN
can.throttle.pedal.level number percentage Throttle pedal push level read from CAN
can.total.accelerator.kickdowns number Total number accelerator kick-downs, read from CAN
can.total.accelerator.kickdowns.time number hours Total driving time when accelerator kick-down, read from CAN
can.total.brake.applications number Total brake applications count read from CAN
can.total.cruise.control.time number hours Total driving time when cruise control is ON, 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.trunk.status boolean CAN trunk is opened
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
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
engine.ignition.status boolean Engine ignition status
event.enum number Event code, full list of codes available at separate table
external.powersource.voltage number volts External power voltage
gnss.antenna.status boolean GNSS receiver antenna status
gsm.mnc string GSM mobile network code
gsm.signal.level number percentage GSM signal strength level
harsh.acceleration.event boolean Harsh acceleration detected
harsh.braking.event boolean Harsh braking detected
ibutton.code string Hexadecimal code of connected iButton
ident string Device unique identificator and optional password
network.roaming.status boolean Network in roaming mode
onewire.sensor.serial string External 1-Wire sensor serial number in HEX representation
onewire.sensor.temperature number celsius External 1-Wire temperature sensor value
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
protocol.id number ID of protocol
server.timestamp number seconds Timestamp when server received a message
tacho.driver.card.code string Driver identification card id for tacho
timestamp number seconds Message timestamp
total.vehicle.weight number kg Total vehicle weight
towing.event boolean Towing event detected
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
Custom command custom Send custom command to device payload: Command text
Tracking parameters setup
{"payload":"$AL+TRACKING=0000,7,15,500,0,1,3"}
Activate digital output 2 for 50 ms
{"payload":"$AL+OUTS=0000,2,1,50,0"}