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.7.2.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

aiobafi6-0.7.2-py3-none-any.whl (26.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiobafi6-0.7.2.tar.gz
  • Upload date:
  • Size: 23.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.9.13 Darwin/22.0.0

File hashes

Hashes for aiobafi6-0.7.2.tar.gz
Algorithm Hash digest
SHA256 f31086273fa2c7a26ae2e6dfe29c7ea45071c65bfb0c4e2fdfb5bb3444f49d25
MD5 891804448573e01c9edc474c30eb2767
BLAKE2b-256 62598e13165f29c494c17836a21a3dac178414e72cc668059d2d821363c5f916

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiobafi6-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 26.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.9.13 Darwin/22.0.0

File hashes

Hashes for aiobafi6-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 17767b560c928373520399dda2e7e2b9d13575362fc03a715e22eb5e679f00bd
MD5 32e32e1bbc637c4ebf18bb2f10c699a7
BLAKE2b-256 bacd0b2c874198f486dfc60ba6cb8570a0e4c30e228068f1038f7cef3d7ca778

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page