Huabao GPS protocol. Huabao parser. Huabao API.

Usage specifics Parameters (56) Commands (1) Devices (1)

To connect your tracker using the Huabao protocol, you need to have a huabao 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 15-character IMEI (usually specified on the tracker casing) 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

ain

number

volts

Voltage on the analog input

Extension ID 0x2B of Message ID 0x0200,
Extension ID 0xA7 of Message ID 0x0200

alarm.flags.bitmask

number

Alarm flags bitmask

Message ID 0x0200,
Message ID 0x0900

antitheft.event

boolean

Antitheft event triggered

Message ID 0x0200,
Message ID 0x0900

beidou.satellites.status

boolean

BeiDou positioning system status

Message ID 0x0200,
Message ID 0x0900

channel.id

number

ID of channel that received a message

custom

any

Any custom parameter

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

Extension ID 0x2A of Message ID 0x0200

displacement.alarm

boolean

Displacement alarm event

Message ID 0x0200,
Message ID 0x0900

engine.ignition.status

boolean

Engine ignition or ACC status

Message ID 0x0200,
Message ID 0x0900

event.enum

number

Protocol-specific event code

Message ID

event.seqnum

number

Unique event sequence number

fatigue.driving.alarm

boolean

Fatigue driving alarm event

Message ID 0x0200,
Message ID 0x0900

fuel.volume

number

liters

Fuel volume

Extension ID 0x02 of Message ID 0x0200

galileo.satellites.status

boolean

Galileo positioning system status

Message ID 0x0200,
Message ID 0x0900

geofence.alarm

boolean

Geofence alarm event

Message ID 0x0200,
Message ID 0x0900

geofence.driving.status

boolean

Geofence driving status

Extension ID 0x13 of Message ID 0x0200

geofence.driving.time

number

seconds

Geofence driving time

Extension ID 0x13 of Message ID 0x0200

geofence.id

number

Geofence ID

Extension ID 0x11 of Message ID 0x0200,
Extension ID 0x12 of Message ID 0x0200,
Extension ID 0x13 of Message ID 0x0200

geofence.shape

string

Geofence shape

Extension ID 0x11 of Message ID 0x0200,
Extension ID 0x12 of Message ID 0x0200

geofence.status

boolean

Geofence entered status

Extension ID 0x12 of Message ID 0x0200

glonass.satellites.status

boolean

Glonass positioning system status

Message ID 0x0200,
Message ID 0x0900

gnss.antenna.disconnected.alarm

boolean

GNSS antenna disconnected or cut off alarm event

Message ID 0x0200,
Message ID 0x0900

gnss.failure.alarm

boolean

GNSS receiver failure alarm event

Message ID 0x0200,
Message ID 0x0900

gps.satellites.status

boolean

GPS positioning system status

Message ID 0x0200,
Message ID 0x0900

gsm.signal.dbm

number

dbm

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

Extension ID 0x30 of Message ID 0x0200

harsh.acceleration.event

boolean

Harsh acceleration detected

Extension ID 0xF3 of Message ID 0x0200

harsh.braking.event

boolean

Harsh braking detected

Extension ID 0xF3 of Message ID 0x0200

harsh.cornering.event

boolean

Harsh cornering detected

Extension ID 0xF3 of Message ID 0x0200

ident

string

Device unique identifier like serial number, IMEI, etc

lock.battery.level

number

percentage

Lock battery charge

Extension ID 0xD5 of Message ID 0x0200

lock.device.code

string

Lock device code

Extension ID 0xD5 of Message ID 0x0200

lock.status.bitmask

number

Lock status and alarm information

Extension ID 0xD5 of Message ID 0x0200

magnetic.card.code

string

Magnetic Card ID code

Extension ID 0xD5 of Message ID 0x0200

overspeeding.event

boolean

Overspeeding detected

Message ID 0x0200,
Message ID 0x0900

peer

string

IP:port from which device connecting to the channel

position.altitude

number

meters

Altitude value for position

Message ID 0x0200,
Message ID 0x0900

position.direction

number

degrees

Heading angle at position detection moment

Message ID 0x0200,
Message ID 0x0900

position.latitude

number

degrees

Latitude coordinate value

Message ID 0x0200,
Message ID 0x0900

position.longitude

number

degrees

Longitude coordinate value

Message ID 0x0200,
Message ID 0x0900

position.satellites

number

Quantity of satellites used to calculate coordinates for given position information

Extension ID 0x31 of Message ID 0x0200

position.speed

number

km/h

Instant speed at position detection moment

Message ID 0x0200,
Message ID 0x0900

position.valid

boolean

Is position information accurate and valid for given timestamp

Message ID 0x0200,
Message ID 0x0900

power.cut.alarm

boolean

External power cut-off alarm event

Message ID 0x0200,
Message ID 0x0900

protocol.id

number

ID of protocol

route.alarm

boolean

Route alarm event

Message ID 0x0200,
Message ID 0x0900

server.timestamp

number

seconds

Timestamp when server received a message

sos.alarm

boolean

SOS alarm triggerred

Message ID 0x0200,
Message ID 0x0900

timestamp

number

seconds

Message timestamp

Message ID 0x0200,
Message ID 0x0900

vehicle.mileage

number

Total calculated mileage

Extension ID 0x01 of Message ID 0x0200

vehicle.state.bitmask

number

Vehicle state flags bitmask

Extension ID 0x25 of Message ID 0x0200,
Message ID 0x0200,
Message ID 0x0900

x.acceleration

number

Accelerometer value X

Message ID 0x0900

y.acceleration

number

Accelerometer value Y

Message ID 0x0900

z.acceleration

number

Accelerometer value Z

Message ID 0x0900

Title

Name

Description

Properties

Custom command Examples

custom

Send custom command with binary payload

report_id: Report ID in HEX format

report_body: Report body in HEX format

Query terminal parameters

{"report_id":"8104"}

Restart device with Device Control command

{"report_id":"8105","report_body":"04"}

Device

Manufacturer