Skip to main content

Big Ass Fans i6/Haiku protocol asynchronous Python library

Project description

aiobafi6

PyPI version Downloads

aiobafi6 is a python library to discovery, query and control Big Ass Fans products that use the i6 protocol, which includes i6 fans and Haiku fans with the 3.0 firmware.

It supports almost all the features of the previous protocol ("SenseMe"), with the exception of rooms, and sleep mode. Occupancy support was added in the 3.1 firmware.

Command line

The aiobafi6 package comes with a minimal command line (aiobafi6) that uses either the library or direct communication with a target device. It is useful for debugging and interacting with the firmware. Run with --help for usage.

Compiling the aiobafi6 protocol buffer

The BAF i6 protocol uses protocol buffers for message wire serialization. This library maintains a single proto file with all known messages and constants.

The generated Python client for this proto file is checked in the repo to avoid depending on the protocol buffer compiler for installation. Whenever the source proto file is changed, the Python client files must be re-generated.

poe protoc

Special thanks

@bdraco for writing the HASS integration, helping with Python, and suggesting BAF is using protobufs.

@oogje for a reference homebridge implementation.

Big Ass Fans for making great products.

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

aiobafi6-0.10.2.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiobafi6-0.10.2-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

Details for the file aiobafi6-0.10.2.tar.gz.

File metadata

  • Download URL: aiobafi6-0.10.2.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aiobafi6-0.10.2.tar.gz
Algorithm Hash digest
SHA256 1e4334416c5f62dca4155bfdbf5ce97e88e7e036ca2fbe0a7f1dddaf3e0851c0
MD5 03099ccdfaa80f75329d3d54ed895bd1
BLAKE2b-256 cd9324924e1ba0ed647112b1207ca33c1ba6c3dc6ef00a696df2cc21a5a46de9

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiobafi6-0.10.2.tar.gz:

Publisher: publish.yml on jfroy/aiobafi6

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiobafi6-0.10.2-py3-none-any.whl.

File metadata

  • Download URL: aiobafi6-0.10.2-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aiobafi6-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 99365d19cee2f7ff22c84be0c6f0acd81d9af577ae7818494234ca01c8cebeb8
MD5 cdf95d5aa6d89f01269ae100dfc2d63f
BLAKE2b-256 4132f0ff21d8e73979f11ff9003d61dac65a04d085cd1ef9368c69d52019af16

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiobafi6-0.10.2-py3-none-any.whl:

Publisher: publish.yml on jfroy/aiobafi6

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