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.4.3.tar.gz (19.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.4.3-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: inkbird_ble-1.4.3.tar.gz
  • Upload date:
  • Size: 19.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.4.3.tar.gz
Algorithm Hash digest
SHA256 03540fc8b8d1a8bb4eb88de86b637b6679152ac7c000d9550d256a357909cfb7
MD5 b3a6e15af5e61b8960a74b77f2f3f89d
BLAKE2b-256 3a16cadf3f437b7b7a676af3a233c281cb35a5a5aac0178bd840a382fc97e75d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: inkbird_ble-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 16.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.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d77e5a06ab44b978f69afb0287158f12b6d959133ba15d6bea5130fb3cd18579
MD5 4bc3fad2e27e91fdef81fbab52c7ccbb
BLAKE2b-256 e4533cd5ef0208014293f909f4c92aff80b293ba96263c0f4b64806ecd4eb044

See more details on using hashes here.

Provenance

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