Skip to main content

Parser for INKBIRD BLE devices

Project description

INKBIRD BLE

CI Status Documentation Status Test coverage percentage

Poetry Ruff 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.5.1.tar.gz (21.1 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.5.1-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: inkbird_ble-1.5.1.tar.gz
  • Upload date:
  • Size: 21.1 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.5.1.tar.gz
Algorithm Hash digest
SHA256 422c540ac0b3942309a69b1dfd309a654a4c6030b7577955e43b9a8fb81676d7
MD5 ad33a620ceec9da4db003858f09ca9ec
BLAKE2b-256 54c5201274da41ebbb967908b2d9f9c6c8825de5596eee23b92a650ff7e8a2ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for inkbird_ble-1.5.1.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.5.1-py3-none-any.whl.

File metadata

  • Download URL: inkbird_ble-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 18.3 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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ea48964d41cf819b036f66d2b81615232db21bdb561c0b608f35942acc66a795
MD5 8ce9b2e22b038a3d67dbdf69e93aa034
BLAKE2b-256 2559deb996313975d8744a75afe1a71a1baa4cc6162b75c06508a0a5db1ebdb4

See more details on using hashes here.

Provenance

The following attestation bundles were made for inkbird_ble-1.5.1-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