Skip to main content

Tools for converting bluetooth data and packets

Project description

Bluetooth Data Tools

CI Status Documentation Status Test coverage percentage CodSpeed Badge

Poetry black pre-commit

PyPI Version Supported Python versions License

Tools for converting bluetooth data and packets

Installation

Install this via pip (or your favourite package manager):

pip install bluetooth-data-tools

Usage

Parsing BLE GAP Advertisement Data

Parse raw BLE advertisement bytes into structured data:

from bluetooth_data_tools import parse_advertisement_data_bytes

# Parse raw GAP advertisement bytes
parsed = parse_advertisement_data_bytes(raw_bytes)
local_name = parsed[0]        # str | None
service_uuids = parsed[1]     # list[str]
service_data = parsed[2]      # dict[str, bytes]
manufacturer_data = parsed[3] # dict[int, bytes]
tx_power = parsed[4]          # int | None

Or use the object-oriented interface:

from bluetooth_data_tools import BLEGAPAdvertisement, parse_advertisement_data

adv = parse_advertisement_data([raw_bytes1, raw_bytes2])
print(adv.local_name)
print(adv.service_uuids)
print(adv.service_data)
print(adv.manufacturer_data)
print(adv.tx_power)

Bluetooth Address Utilities

from bluetooth_data_tools import (
    int_to_bluetooth_address,
    mac_to_int,
    short_address,
    human_readable_name,
)

# Convert integer to MAC address
int_to_bluetooth_address(0x123456789ABC)
# "12:34:56:78:9A:BC"

# Convert MAC address to integer
mac_to_int("FF:FF:FF:FF:FF:FF")
# 281474976710655

# Get short address (last 2 octets)
short_address("AA:BB:CC:DD:EE:FF")
# "EEFF"

# Format a human-readable device name
human_readable_name("My Sensor", "", "AA:BB:CC:DD:EE:FF")
# "My Sensor (EEFF)"

Distance Estimation

Estimate distance from TX power and RSSI:

from bluetooth_data_tools import calculate_distance_meters

distance = calculate_distance_meters(power=-59, rssi=-60)
# ~1.135 meters

Monotonic Time

A fast monotonic clock optimized for Bluetooth event timing. On Linux, uses CLOCK_MONOTONIC_COARSE via Cython for lower overhead:

from bluetooth_data_tools import monotonic_time_coarse

now = monotonic_time_coarse()

Private Address Resolution (RPA)

Resolve Bluetooth Low Energy random private addresses using an Identity Resolving Key:

from bluetooth_data_tools import get_cipher_for_irk, resolve_private_address

cipher = get_cipher_for_irk(irk_bytes)  # 16-byte Identity Resolving Key
is_match = resolve_private_address(cipher, "40:01:02:0A:C4:A6")

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

This package was created with Cookiecutter and the browniebroke/cookiecutter-pypackage project template.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bluetooth_data_tools-1.29.10.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bluetooth_data_tools-1.29.10-cp314-cp314-manylinux_2_41_x86_64.whl (145.7 kB view details)

Uploaded CPython 3.14manylinux: glibc 2.41+ x86-64

File details

Details for the file bluetooth_data_tools-1.29.10.tar.gz.

File metadata

  • Download URL: bluetooth_data_tools-1.29.10.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for bluetooth_data_tools-1.29.10.tar.gz
Algorithm Hash digest
SHA256 9d8e3eef17a04ab251a7b8d8975db87d9209272c6c1d6c27a742b224aeef58cc
MD5 48570fa01dd30b0643369c8cc2433419
BLAKE2b-256 dd76463c8ca6effb0df6b67a3283101dda2c69f01bd5e89e755775693e720f3b

See more details on using hashes here.

Provenance

The following attestation bundles were made for bluetooth_data_tools-1.29.10.tar.gz:

Publisher: ci.yml on Bluetooth-Devices/bluetooth-data-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bluetooth_data_tools-1.29.10-cp314-cp314-manylinux_2_41_x86_64.whl.

File metadata

File hashes

Hashes for bluetooth_data_tools-1.29.10-cp314-cp314-manylinux_2_41_x86_64.whl
Algorithm Hash digest
SHA256 80fd07ccc1735ef3f6e2daff273a596978dea93204833dad81e497b8e32a322e
MD5 a75461873f99cd513fba0cce93895d6c
BLAKE2b-256 bf023cd0074755a7edb2626173e32bc7ceb841c6ae25774f675f1c758b9db9bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for bluetooth_data_tools-1.29.10-cp314-cp314-manylinux_2_41_x86_64.whl:

Publisher: ci.yml on Bluetooth-Devices/bluetooth-data-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page