skypatrol

This protocol is used by all Skypatrol GPS tracking devices.

There are two separate variations of protocol and one should be correctly selected in the channel configuration under 'Protocol version' setting:

  • '5-byte header' — for Skypatrol TT8750+ devices and analogs (more modern version, try it first)
  • '4-byte header' — for Skypatrol TT8750 devices and analogs (older version, enfora types of devices)

For Skypatrol devices to work correctly via skypatrol channel, they should be configured as follows:

'5-byte header' devices:

Keep-alive message mask must be = 7:

  • bits enabled:
    • bit0 — binary format
    • bit1 — add param1 to keep-alive message
    • bit2 — add device ID to the keep-alive message
  • bits disabled:
    • bit27 — do not add a mask to keep-alive message
    • bit28 — do not add sequence number to keep-alive message

Position message mask must have bit27 enabled — add report mask to position messages.

'4-byte header' devices Output Event 52 Parm2 bit field:

  • bits enabled:
    • bit1 — Parm1
    • bit2 — modem ID
    • bit3 — IO data
    • bit7 — event category
    • bit12 — GPS data
    • bit20 — odometer
  • bits disabled:
    • bit0 — ASCII format
    • all other

Below is the list of parameters that can appear in the messages received by the channel via skypatrol 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
battery.level number percentage Internal battery level
battery.voltage number volts Internal battery voltage
channel.id number ID of channel that received a message
counter.limit number Counter limit
counter.type number Counter type
counter.value number Counter current value
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
geofence.group number Last triggered geofence group number
geofence.index number Last triggered geofence index inside group
gps.led.status boolean GPS LED status: truee - on, false - off
gsm.arfcn number Absolute radio-frequency channel number of GSM network
gsm.cellid number GSM base station ID
gsm.lac number GSM location area code
gsm.led.status boolean GSM LED status: truee - on, false - off
gsm.mcc string GSM mobile country code
gsm.mnc string GSM mobile network code
gsm.signal.dbm number dbm Strength of GSM signal
gsm.timing.advance number GSM timing advance
ident string Device unique identificator and optional password
magnetic.variation number degrees Magnetic variation
main.power.status boolean Main power state
message.seqnum number Sequence number of the message
overspeeding.duration number seconds Overspeeding interval duration
overspeeding.max.speed number km/h Maximum speed during overspeeding interval
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.timestamp number seconds Timestamp when coordinates where calculated
position.valid boolean Is position information accurate and valid for given timestamp
protocol.id number ID of protocol
server.timestamp number seconds Timestamp when server received a message
timestamp number seconds Message timestamp
trip.mileage number km Distance driven since engine start
vehicle.mileage number km Total calculated mileage