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.7.0.tar.gz (25.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.7.0-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: inkbird_ble-1.7.0.tar.gz
  • Upload date:
  • Size: 25.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.7.0.tar.gz
Algorithm Hash digest
SHA256 9f31518f65abb1ac44b7f739a03fa322f41849ee0d9ab46c188920d0ca894e3f
MD5 26637196a71c0f84e8052d5205312d64
BLAKE2b-256 02bf5c8c61f1b77e476a72791e10707ecbf484949122e0e154d72cab6bce6d34

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: inkbird_ble-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 22.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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d55c3f2b3720ddfecdf2ba6d404edfd2c6b84152b624530c10f5b26aed2e6869
MD5 7da3da3aa73137e310bcd96a94fb9e3b
BLAKE2b-256 7cb17e19f83815db5180c0880025f8f569dc001f2f5ea0a4edc0de209fa8032a

See more details on using hashes here.

Provenance

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