compact-binary-protocol 0.1.1

A library implementing a compact binary protocol

compact-binary-protocol

A small, self-contained Python library that defines the compact binary protocol used by Tartabit client components.

Features:

• Encoding helpers
• Data model classes for location and sensor data
• Packet classes for telemetry, configuration, power on, motion start/stop
• Decoding helpers for responses and header parsing

All multi-byte values are encoded using big-endian format.

Install (pypi)

To install the package from PyPI, run:

pip install compact-binary-protocol

Install (local)

This repository is part of a monorepo. To use the library from adjacent components, import it directly via the package name compact_binary_protocol (no installation step needed if package path is in PYTHONPATH). For packaging, add a minimal pyproject or install in editable mode:

pip install -e ./compact-binary-protocol

Quick start

from compact_binary_protocol import (
    LocationData, SensorDataBasic, TelemetryPacket,
)

imei = "358419511056392"
loc = LocationData.gnss(52.5200, 13.4050)
sensor = SensorDataBasic(sensor_type=1, temperature=21.5, battery=95, rssi=30)
tele = TelemetryPacket(imei=imei, timestamp=1724900000, transaction_id=1, location_data=loc, sensor_data=sensor)
packet_bytes = tele.to_bytes()
print(packet_bytes.hex())

API Overview

• encoding.encode_var_string(str) -> bytes
• decoder.PacketDecoder.parse_response_data(str)
• decoder.PacketDecoder.decode_packet_header(hex_str)
• decoder.DataReader for reading from bytes
• data.LocationData (gnss/cell)
• data.SensorData, data.SensorMultiData, data.NullSensorData, data.MotionSensorData
• packets.Packet base + TelemetryPacket, ConfigPacket, PowerOnPacket, MotionStartPacket, MotionStopPacket

Building

To build the package, run the following command:

pip install build twine
python -m venv .venv
. venv/bin/activate
python -m build
twine upload dist/*

License

Copyright 2024-2025 Tartabit, LLC.