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.1.tar.gz (18.5 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.1-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: inkbird_ble-1.4.1.tar.gz
  • Upload date:
  • Size: 18.5 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.1.tar.gz
Algorithm Hash digest
SHA256 13f70b9ab2533ce7934f5418a3d5a9ca423329189b34ae0fa8da10ff23bf5e00
MD5 40dff4129bc709f36f2ef114d0e5a945
BLAKE2b-256 ce7407471f08f0b51fb42d8716507e00468b099418183a74bc6abc1b196b1e33

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: inkbird_ble-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 15.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef42ba17c70a68685d84353b03ee66584c8722537c1919c08dd2c488c967ddef
MD5 dd58dcdfd8ca58a8b136a0e74021ab00
BLAKE2b-256 c36f5b5ccf5089f9315a931377403af38524600af6a3b84cd4ff11dbf052eb90

See more details on using hashes here.

Provenance

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