Skip to main content

Big Ass Fans i6/Haiku protocol asynchronous Python library

Project description


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 hashes)

Uploaded source

Built Distribution

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

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page