A pure Python library for Bluetooth SIG standards interpretation, providing comprehensive GATT characteristic, service, and advertisement parsing with automatic UUID resolution.
📚 Full Documentation | 🚀 Quick Start | 📖 API Reference
- ✅ Standards-Based: Official Bluetooth SIG YAML registry with automatic UUID resolution
- ✅ Type-Safe: Characteristic classes provide compile-time type checking; UUID strings return dynamic types
- ✅ Modern Python: msgspec-based design with Python 3.9+ compatibility
- ✅ Comprehensive: Support for 200+ GATT characteristics across multiple service categories
- ✅ Flexible Validation: Enable/disable validation per-characteristic for testing or debugging
- ✅ Framework Agnostic: Works with any BLE library (bleak, simplepyble, etc.)
pip install bluetooth-sigType-Safe Parsing (recommended for known devices):
from bluetooth_sig.gatt.characteristics import (
BatteryLevelCharacteristic,
HeartRateMeasurementCharacteristic,
)
# Simple: IDE infers return type as int
battery = BatteryLevelCharacteristic()
level = battery.parse_value(bytearray([85]))
print(f"Battery: {level}%") # Battery: 85%
# Encode value back to bytes
encoded = battery.build_value(85)
# Complex: IDE infers HeartRateData with full autocomplete
heart_rate = HeartRateMeasurementCharacteristic()
hr_data = heart_rate.parse_value(bytearray([0x00, 72]))
print(f"{hr_data.heart_rate} bpm") # 72 bpm
print(f"Sensor contact: {hr_data.sensor_contact}")Dynamic Parsing (for scanning unknown devices):
from bluetooth_sig import BluetoothSIGTranslator
translator = BluetoothSIGTranslator()
# Parse by UUID - returns the parsed value directly
result = translator.parse_characteristic("2A19", bytearray([85]))
print(f"Battery Level: {result}%") # Battery Level: 85%
# Identify unknown UUIDs from device discovery
discovered_uuids = ["2A19", "2A6E", "2A37"] # Example UUIDs
for uuid in discovered_uuids:
if translator.supports(uuid):
info = translator.get_characteristic_info_by_uuid(uuid)
print(f"Found: {info.name}")| Feature | Description |
|---|---|
| Characteristic Parsing | Decode/encode 200+ GATT characteristics with type safety |
| Service Validation | Check device compliance against SIG service specifications |
| Advertising Parsing | Extract device name, service UUIDs, manufacturer data from PDUs |
| Device Abstraction | High-level API combining connection management, parsing, and caching |
See API Overview for detailed guidance.
For applications, use the Device class for connection management and type-safe reads:
# SKIP: Requires actual BLE device connection
from bluetooth_sig import BluetoothSIGTranslator, Device
from bluetooth_sig.gatt.characteristics import BatteryLevelCharacteristic
# Connection manager from examples - use for your BLE backend
from examples.connection_managers.bleak_retry import BleakRetryConnectionManager
async def main():
translator = BluetoothSIGTranslator()
device = Device(BleakRetryConnectionManager("AA:BB:CC:DD:EE:FF"), translator)
await device.connect()
# Type-safe: IDE knows battery is int
battery = await device.read(BatteryLevelCharacteristic)
print(f"Battery: {battery}%")
await device.disconnect()When you know the characteristic type, use the class directly for full type inference:
from bluetooth_sig.gatt.characteristics import HeartRateMeasurementCharacteristic
# Complex: structured dataclass with autocompletion
heart_rate = HeartRateMeasurementCharacteristic()
hr_data = heart_rate.parse_value(bytearray([0x00, 72])) # IDE infers HeartRateData
print(f"{hr_data.heart_rate} bpm")
encoded = heart_rate.build_value(hr_data)For scanning unknown devices or working with UUID strings:
from bluetooth_sig import BluetoothSIGTranslator
translator = BluetoothSIGTranslator()
# Discover and parse any characteristic by UUID
for char in client.services.characteristics:
uuid_str = str(char.uuid)
if translator.supports(uuid_str):
raw_data = await client.read_gatt_char(uuid_str) # SKIP: async
result = translator.parse_characteristic(uuid_str, raw_data)
print(f"{result.info.name}: {result.value}") # Returns Any
else:
print(f"Unknown characteristic UUID: {uuid_str}")You can also pass a characteristic class to the translator for type-safe parsing:
from bluetooth_sig import BluetoothSIGTranslator
from bluetooth_sig.gatt.characteristics import TemperatureMeasurementCharacteristic
translator = BluetoothSIGTranslator()
raw_data = bytearray([0x00, 0xE4, 0x00, 0x00, 0x00])
# Type-safe via translator: IDE infers TemperatureMeasurementData
temp = translator.parse_characteristic(TemperatureMeasurementCharacteristic, raw_data)
print(f"{temp.temperature}°C")Combines connection management with type-safe operations:
# SKIP: Requires connection manager implementation
from bluetooth_sig.device import Device
from bluetooth_sig.gatt.characteristics import HumidityCharacteristic
device = Device(connection_manager, translator)
await device.connect()
# Type-safe: IDE infers float from characteristic class
humidity = await device.read(HumidityCharacteristic)
print(f"Humidity: {humidity}%")
# Dynamic: returns Any when using enum/string
from bluetooth_sig.types.gatt_enums import CharacteristicName
result = await device.read(CharacteristicName.TEMPERATURE)→ See comprehensive usage guide for real-world patterns, batch parsing, and validation control.
Enables high-level Bluetooth applications without low-level expertise:
- ✅ UUID abstraction - Resolves unknown UUIDs to characteristic types; provides enum/class access for known characteristics
- ✅ Automatic encoding/decoding - Converts between raw bytes and typed Python objects using standards-compliant parsing
- ✅ Type-safe data structures - Returns structured data objects instead of raw byte arrays (e.g.,
VectorData,TemperatureMeasurement) - ✅ Framework-agnostic design - Works with any BLE library (bleak, simplepyble, etc.) using a common connection manager interface
- ✅ Standards-based parsing - 200+ GATT characteristics according to official Bluetooth SIG specifications
- ✅ Extensible - Supports custom characteristics and services with the same type-safe patterns
- ❌ BLE transport layer - Requires a BLE library (bleak, simplepyble, etc.); but this lib provides Device class abstraction over these libraries
- ❌ Firmware implementation - Client-side parsing and encoding only
Learn more about what problems this solves →
Quick integration with any BLE library using the translator directly:
# SKIP: Requires BLE hardware and connection setup
from bleak import BleakClient
from bluetooth_sig import BluetoothSIGTranslator
from bluetooth_sig.types.gatt_enums import CharacteristicName
translator = BluetoothSIGTranslator()
# Get UUID from characteristic name (do once, reuse)
battery_uuid = translator.get_characteristic_uuid_by_name(CharacteristicName.BATTERY_LEVEL)
async with BleakClient(address) as client:
# Read: bleak handles connection, bluetooth-sig handles parsing
raw_data = await client.read_gatt_char(str(battery_uuid))
result = translator.parse_characteristic(str(battery_uuid), raw_data)
print(f"Battery: {result.value}%")
# Write: bluetooth-sig handles encoding, bleak handles transmission
data = translator.encode_characteristic(str(battery_uuid), 85)
await client.write_gatt_char(str(battery_uuid), data)Recommended: Implement the connection manager interface to use the Device class for BLE-library-agnostic design.
→ See BLE integration guide for connection manager implementation examples with bleak, bleak-retry-connector, and simplepyble.
200+ GATT characteristics across multiple categories:
- Battery Service: Level, Power State
- Environmental Sensing: Temperature, Humidity, Pressure, Air Quality
- Health Monitoring: Heart Rate, Blood Pressure, Glucose
- Fitness Tracking: Running/Cycling Speed, Cadence, Power
- Device Information: Manufacturer, Model, Firmware Version
- And many more...
View full list of supported services →
- Full Documentation - Complete guides and API reference
- Quick Start Guide - Get started in 5 minutes
- API Reference - Detailed API documentation
- Examples - Integration examples with various BLE libraries
Contributions are welcome! Please see the Contributing Guide for details.
This project is licensed under the MIT License - see the LICENSE file for details.
- PyPI: https://pypi.org/project/bluetooth-sig/
- Documentation: https://ronanb96.github.io/bluetooth-sig-python/
- Source Code: https://github.com/ronanb96/bluetooth-sig-python
- Issue Tracker: https://github.com/ronanb96/bluetooth-sig-python/issues