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.2.tar.gz (21.8 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.2-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: inkbird_ble-1.5.2.tar.gz
  • Upload date:
  • Size: 21.8 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.2.tar.gz
Algorithm Hash digest
SHA256 2f22749764ac361b4db67e15d6a111b464059756c743b393638c84032c2fc6fd
MD5 c8de4b426549e698b2846b188b601283
BLAKE2b-256 77d781cf1fba0ff0ac71ad58ba52319f7a839624eda5f841a7cfaae596ba2812

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: inkbird_ble-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 19.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8c3baf9653fcffcf87f0307fce902c208f0be6ad816cbb31dab45bfacaa51633
MD5 7c52740213adfe391ba3748e9f2d91d9
BLAKE2b-256 2ca989e216669c3352a236b0dc062425a5f908d864016919095ba83d2b786d00

See more details on using hashes here.

Provenance

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