Spireon protocol
Protocol used to fetch vehicle telematics data via Spireon Data Services API.
flespi parses the Spireon protocol messages into a JSON object with the
fields listed below in the Parameters tab.
Spireon HTTPS accepting server. Once the channel is created, provide your Spireon contact with the channel's URI:port so they can set up data delivery through the HTTP webhook.
account.id
string
Account ID the device belongs to
accountId
asset.id
string
Asset unique identifier
assetId
asset.name
string
The user-assigned Name of the Asset
assetName
battery.voltage
number
volts
Internal battery voltage
event.batteryVoltage
can.dtc
array
Diagnostic trouble code array read from CAN
May content list of OBDII codes or list of objects with codes.
Standard object parameter names used:
*standard* - Protocol standard (J1939, J1708(J1587), OBDII)
*mid* - Message Identifier (J1708)
*sid* - Subsystem Identifier (J1708)
*fmi* - Failure Mode Identifier (J1939, J1708)
*spn* - Suspect Parameter Number (J1939)
*sa* - Source Address (J1939, OBDII)
*oc* - Occurrence Count (J1939)
*cm* - Conversion Method (J1939)
*status* - Status of error code (active, pending, historical, permanent)
event.eventData.troubleCodes
cargo.load.status
boolean
Cargo loaded status
event.eventData.cargoLoaded
cargo.sensor.distance
number
Distance measured by the cargo sensor to the cargo
event.eventData.distance
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.serial.number
string
Device serial number
deviceSerialNumber
device.type.id
number
ID of device type of device that received a message
din.high.event
boolean
DIN high event
event.eventData.inputSignal.HIGH
din.low.event
boolean
DIN low event
event.eventData.inputSignal.LOW
distance.driven
number
The miles driven recorded by the device
event.distanceDriven
engine.ignition.status
boolean
Engine ignition or ACC status
event.type.IGN_ON,IGN_OFF
event.code
string
Protocol-specific event code string
event.type
event.id
number
ID of event that caused record generation
event.id
event.trigger.input
number
Triggered IO input number, starting from 1
event.eventData.inputIndex
external.powersource.status
boolean
External power source connection status
event.type.EXT_PWR_OFF,EXT_PWR_ON
geofence.code
string
Geofence code
event.eventData.geofenceId
geofence.name
string
Geofence name
event.eventData.geozone.name
geofence.status
boolean
Geofence entered status
event.type.GEO_ENTER,GEO_EXIT
geofence.type
string
Geofence type
event.eventData.geozone.type
ident
string
Device unique identifier like serial number, IMEI, etc
internal.battery.level
number
percentage
Internal battery percentage
event.internalBatteryPercentage
internal.battery.voltage
number
volts
Internal battery voltage
event.internalBatteryVoltage
mileage.adjastment
number
The miles to manually adjust the odometer reading by, as set by a user.
event.odometerAdjustment
mileage.initial
number
The odometer reading just prior to device installation
event.initialOdometer
overspeeding.event
boolean
Overspeeding detected
event.type.SPEED
peer
string
IP:port from which device connecting to the channel
position.address
string
Location Address
event.location.address.line1
position.city
string
Location City
event.location.address.city
position.direction
number
degrees
Heading angle at position detection moment
event.heading
position.latitude
number
degrees
Latitude coordinate value
event.location.lat
position.longitude
number
degrees
Longitude coordinate value
event.location.lng
position.speed
number
km/h
Instant speed at position detection moment
event.speed
position.state
string
Location State
event.location.address.stateOrProvince
position.zip
string
Location Zip code
event.location.address.postalCode
power.cut.alarm
boolean
External power cut-off alarm event
event.type.EXT_PWR_LOW
protocol.id
number
ID of protocol
reset.event
boolean
Device reset event
event.type.RESET
server.timestamp
number
seconds
Timestamp when server received a message
timestamp
number
seconds
Message timestamp
event.date
towing.event
boolean
Towing event detected
event.type.TOW_START
vehicle.mileage
number
km
Total calculated mileage
event.odometer