Webfleet-connect protocol
Protocol used to fetch vehicle data from the Webfleet fleet management solution via WEBFLEET.connect API.
flespi parses the Webfleet-connect protocol messages into a JSON object with the
fields listed below in the Parameters tab.
Create and configure the "webfleet-connect" channel to retrieve messages from Webfleet using WEBFLEET.connect API. In the channel configuration specify the Account name, User name, Password, and API key from WEBFLEET.connect:
can.engine.coolant.temperature
number
celsius
Engine coolant temperature read from CAN
FMS_ENGINE_COOLANT_TEMPERATURE
can.engine.rpm
number
rpm
Engine RPM read from CAN
rpm
can.fuel.consumption
number
liters/h
Engine fuel rate read from CAN
FUEL_CONSUMPTION
can.fuel.level
number
percentage
Fuel level in tank read from CAN
FMS_FUEL_LEVEL_PERCENTAGE
can.fuel.volume
number
liters
CAN fuel volume
fuel_level
can.gear
number
Current gear read from CAN
gear
can.gross.combination.vehicle.weight
number
kg
Gross combination vehicle weight read from CAN
FMS_GROSS_COMBINATION_VEHICLE_WEIGHT
can.mil.status
boolean
Malfunction indicator lamp status read from CAN
FMS_ENGINE_MIL_INDICATOR
can.recharge.mileage
number
km
Vehicle mileage recharge read from CAN
ELECTRIC_RANGE
can.vehicle.battery.charging.status
boolean
Vehicle battery charging status get from CAN Bus
CHARGING
can.vehicle.battery.level
number
percentage
CAN-bus reported vehicle battery level for EV or HEV
STATE_OF_CHARGE
can.vehicle.battery.voltage
number
volts
Vehicle battery voltage, read from CAN
BATTERY_VOLTAGE
channel.id
number
ID of channel that received a message
charger.plug.status
boolean
Charger plug status
CHARGER_CONNECTED
crash.event
boolean
Crash event detected
msg_type
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
engine.ignition.status
boolean
Engine ignition or ACC status
msg_type
event.timestamp
number
seconds
Timestamp of the event
event_time
ident
string
Device unique identifier like serial number, IMEI, etc
objectuid
message.detail
string
Message detail
msg_text
message.type
string
Message type
msg_type
payload.source.id
string
ID of peripheral device that sent payoad
device_id
payload.text
string
Text Payload received from device
aux_data
peer
string
IP:port from which device connecting to the channel
position.address
string
Location Address
pos_text
position.direction
number
degrees
Heading angle at position detection moment
course
position.latitude
number
degrees
Latitude coordinate value
pos_latitude
position.longitude
number
degrees
Longitude coordinate value
pos_longitude
position.speed
number
km/h
Instant speed at position detection moment
speed
position.timestamp
number
seconds
Timestamp when coordinates where calculated
pos_time
power.on.status
boolean
Power-on device status
msg_type
protocol.id
number
ID of protocol
remaining.range
number
km
Current remaining range
FUEL_RANGE
send.timestamp
number
seconds
Message send timestamp
msg_time
server.timestamp
number
seconds
Timestamp when server received a message
tacho.driver.card.action
string
Driver identification card action, protocol specific action name
dt_cardaction
tacho.driver.card.action.enum
number
Driver identification card action, protocol specific numeric value
dt_cardaction
tacho.driver.card.code
string
Driver identification card id for tacho
dt_cardid
tacho.driver.card.slot
number
The number of a slot the driver card is inserted to.
dt_slot
tacho.driver.card.status
boolean
Tacho driver card presence
dt_state
tacho.driver.card.type
string
Driver identification card type, protocol specific type name
dt_cardtype
tacho.driver.card.type.enum
number
Driver identification card type, protocol specific numeric value
dt_cardtype
tacho.driver.work.state
string
Protocol-specific driver work state name
workstate
tacho.driver.work.state.enum
number
Protocol-specific driver work state value
workstate
timestamp
number
seconds
Message timestamp
trip.mileage
number
km
Distance driven since engine start
distance
trip.start.latitude
number
degrees
Trip start latitude coordinate value
start_latitude
trip.start.longitude
number
degrees
Trip start longitude coordinate value
start_longitude
trip.start.mileage
number
km
Trip start odometer value
start_odometer
trip.start.timestamp
number
seconds
Timestamp value upon trip start
start_time
trip.stop.latitude
number
degrees
Trip stop latitude coordinate value
end_latitude
trip.stop.longitude
number
degrees
Trip stop longitude coordinate value
end_longitude
trip.stop.mileage
number
km
Trip end odometer value
end_odometer
trip.stop.timestamp
number
seconds
Timestamp value upon trip end
end_time
vehicle.mileage
number
km
Total calculated mileage
odometer_long
vehicle.odometer
number
Vehicle mileage in base units configured in device (km, miles, 100m etc)
odometer
vehicle.plate.number
string
Vehicle plate number
objectuid