Skip to main content

Parser for INKBIRD BLE devices

Project description

INKBIRD BLE

CI Status Documentation Status Test coverage percentage

Poetry black pre-commit

PyPI Version Supported Python versions License

Parser for INKBIRD BLE devices

Installation

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

pip install inkbird-ble

Usage

inkbird-ble parses the BLE advertisements (and, for some models, GATT reads/notifications) emitted by INKBIRD devices into structured sensor values.

Most sensors broadcast their readings, so passive parsing needs no connection:

from inkbird_ble import INKBIRDBluetoothDeviceData

# `service_info` is a habluetooth `BluetoothServiceInfoBleak`
data = INKBIRDBluetoothDeviceData()
if data.supported(service_info):
    update = data.update(service_info)
    for device_key, value in update.entity_values.items():
        print(device_key.key, value.native_value)
    # temperature 20.44
    # humidity 48.07
    # battery 86

A few models must be polled (async_poll) or subscribed to (async_start) over a connection. See the usage documentation for the active device flow and for building a service_info outside Home Assistant.

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


Download files

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

Source Distribution

inkbird_ble-1.3.0.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

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

inkbird_ble-1.3.0-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file inkbird_ble-1.3.0.tar.gz.

File metadata

  • Download URL: inkbird_ble-1.3.0.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for inkbird_ble-1.3.0.tar.gz
Algorithm Hash digest
SHA256 8fa55a44b3185f0ee21b3007fcdfbf271ef3404f245a79ea53bad8ac84aa966d
MD5 7780bd32be9c7be112acfa57d37b5d21
BLAKE2b-256 0286e0eae1aed86be883043dda752103ea10d8adc8c468b57d6225bbcd818f8d

See more details on using hashes here.

Provenance

The following attestation bundles were made for inkbird_ble-1.3.0.tar.gz:

Publisher: ci.yml on Bluetooth-Devices/inkbird-ble

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

File details

Details for the file inkbird_ble-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: inkbird_ble-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for inkbird_ble-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8b14339c426934478c765c364b8b2c460266687e7162831626bdfd5742e87836
MD5 400a1e3974943ae34b52eacecde83104
BLAKE2b-256 5be08f3e29b59cea3ad8d5a3936bcb8c8f6b9f84893137d990483fef75489acf

See more details on using hashes here.

Provenance

The following attestation bundles were made for inkbird_ble-1.3.0-py3-none-any.whl:

Publisher: ci.yml on Bluetooth-Devices/inkbird-ble

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