Cantrack protocol, API, parser, configurator, commands

All protocols

Usage specifics Parameters (50) Commands (1) Devices (12) Changelog

To connect your tracker using the Cantrack protocol, you need to have a cantrack channel created first.

Point your tracker to the channel's domain name:port via SMS or configuration tool provided by the vendor.

Then create a device instance for your tracker and use a Serial Number without leading zeroes in the ident field.

Use the Logs & Messages tab on the device screen to check if the messages are coming.

Name

Type

Unit

Description

Sources

battery.charging.status

boolean

Battery charging status

Status bitmask

battery.level

number

percentage

Internal battery level

Additional info ID 0x06,
Command *HTBT

battery.low.alarm

boolean

Battery low alarm event

Alarm sign bitmask,
Command *V1,
Command *V2,
Command *V3,
Command *V5

battery.voltage

number

volts

Internal battery voltage

Command *V3,
Command *V5

channel.id

number

ID of channel that received a message

crash.event

boolean

Crash event detected

Alarm sign bitmask

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

displacement.alarm

boolean

Displacement alarm event

Command *V1,
Command *V2,
Command *V3,
Command *V5

engine.ignition.status

boolean

Engine ignition or ACC status

Command *V1,
Command *V2,
Command *V3,
Command *V5,
Status bitmask

event.seqnum

number

Unique event sequence number

Message Sequence Number

gnss.antenna.disconnected.alarm

boolean

GNSS antenna disconnected or cut off alarm event

Alarm sign bitmask

gnss.antenna.short.circuit.alarm

boolean

GNSS antenna short circuit alarm event

Alarm sign bitmask

gnss.failure.alarm

boolean

GNSS receiver failure alarm event

Alarm sign bitmask

gsm.cellid

number

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) base station ID

Command *V3

gsm.lac

number

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) location area code

Command *V3

gsm.mcc

number

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) country code

Command *V3

gsm.mnc

number

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) code

Command *V3

gsm.signal.dbm

number

dbm

Strength of the Mobile network (GSM, 3G, 4G, LTE, 5G, ...) signal

Command *V3

gsm.signal.level

number

percentage

Mobile network (GSM, 3G, 4G, LTE, 5G, ...) signal strength level

Command *V3

gsm.sim.iccid

string

Integrated Circuit Card Id of SIM card of the Mobile network (GSM, 3G, 4G, LTE, 5G, ...)

Command *ICCID

harsh.acceleration.event

boolean

Harsh acceleration detected

Alarm sign bitmask

harsh.braking.event

boolean

Harsh braking detected

Alarm sign bitmask

ident

string

Device unique identifier like serial number, IMEI, etc

message.type

string

Message type

peer

string

IP:port from which device connecting to the channel

position.altitude

number

meters

Altitude value for position

Message ID 0x0200

position.direction

number

degrees

Heading angle at position detection moment

Command *V1,
Command *V2,
Command *V4,
Message ID 0x0200

position.latitude

number

degrees

Latitude coordinate value

Command *V1,
Command *V2,
Command *V4,
Message ID 0x0200

position.longitude

number

degrees

Longitude coordinate value

Command *V1,
Command *V2,
Command *V4,
Message ID 0x0200

position.speed

number

km/h

Instant speed at position detection moment

Command *V1,
Command *V2,
Command *V4,
Message ID 0x0200

position.valid

boolean

Is position information accurate and valid for given timestamp

Command *V1,
Command *V2,
Command *V4,
Status bitmask

power.cut.alarm

boolean

External power cut-off alarm event

Alarm sign bitmask

protocol.id

number

ID of protocol

rear.light.status

boolean

Rear light status

Status bitmask

report.code

string

Report code

server.timestamp

number

seconds

Timestamp when server received a message

timestamp

number

seconds

Message timestamp

Command *V1,
Command *V2,
Command *V3,
Command *V5,
Message ID 0x0200

vehicle.plate.number

string

Vehicle plate number

Message ID 0x0100

vehicle.state

string

Vehicle state, such as moving, idling, parked etc

Command *V1,
Command *V2,
Command *V3,
Command *V5

vehicle.state.bitmask

number

Vehicle state flags bitmask

Command *V1,
Command *V2,
Command *V3,
Command *V5

vehicle.vin

string

VIN of vehicle

Message ID 0x0100

vendor.code

string

Vendor identification string code

vibration.alarm

boolean

Vibration alarm event

Command *V1,
Command *V2,
Command *V3,
Command *V5

wifi.mac.address

string

WiFi MAC address

Command *V5

wifi.signal.strength

number

WiFi signal strength, RSSI

Command *V5

x.acceleration

number

Accelerometer value X

Additional info ID 0x05

y.acceleration

number

Accelerometer value Y

Additional info ID 0x05

z.acceleration

number

Accelerometer value Z

Additional info ID 0x05

Title

Name

Description

Properties

Custom command Examples

custom

Send custom command to device, Scheme: "*,,#". You have to specify payload only

payload: Payload string

Cut fuel for stop car, model G06L

{"payload":"CMD,130305,stop654321"}

Set working mode 1, models GF40, GF50, GF60, GF70L

{"payload":"MD123456 1 3 8 1"}

Set Center number command S2, models TK100, TK100B, G05

{"payload":"S2,130305,13812341234"}

Device

Manufacturer