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

Uploaded Python 3

File details

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

File metadata

  • Download URL: inkbird_ble-1.4.4.tar.gz
  • Upload date:
  • Size: 19.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.4.4.tar.gz
Algorithm Hash digest
SHA256 7bd7b4f63a651eb7379f4d2b1f0f0c7eac405a627bc4272adc3c669934c78e17
MD5 a8ff2b209b55ba0af87c2af8012ded85
BLAKE2b-256 386db1887b4af41830a0639aeabca307f567f5047653a28f3ce7e1e43b8e591a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: inkbird_ble-1.4.4-py3-none-any.whl
  • Upload date:
  • Size: 17.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4fee164c5c96cc531725aee3b7945c5a1e8a27c67a25cc58239e29709cc92957
MD5 6fb4c2b15acc78dc77efa3c6f87fd0bd
BLAKE2b-256 2dac4e627217eeb42a8678df2af3c642ffbdaa73179eb5cbf11b33f6d1c16dfd

See more details on using hashes here.

Provenance

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