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

Uploaded Python 3

File details

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

File metadata

  • Download URL: inkbird_ble-1.4.2.tar.gz
  • Upload date:
  • Size: 18.9 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.2.tar.gz
Algorithm Hash digest
SHA256 ef112262007a0e2c98596305ad99c35158a145fb374fdcc281a24086bbd895ed
MD5 c35c93d00a38a435f1905711cbf955a7
BLAKE2b-256 c91ba1c639370ca75243e830e3394c15b0a18674cd9a3161be2e3d6c5d200dee

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: inkbird_ble-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 16.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ab13b06f70f16e280bc4cf15f0e462e52431fad163775bae55afac7db7742db5
MD5 a8771978ff35afec40c46818c17c4e6b
BLAKE2b-256 6fa9ae1a7977a7299c646c8e9f0bf475ec4ca5f5135f2db4985198c02cf24e10

See more details on using hashes here.

Provenance

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