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

Uploaded Source

Built Distribution

aiobafi6-0.8.1-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiobafi6-0.8.1.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.2 Darwin/22.3.0

File hashes

Hashes for aiobafi6-0.8.1.tar.gz
Algorithm Hash digest
SHA256 9a20f591fcbca33e866d18d9ec17ca1d18d18e5fe5e023c362cd7a93d4436d50
MD5 4af7746ebbadd3bc7a74512d26f72fba
BLAKE2b-256 e315c5f7c898b17a52315478bad66f3b972c85125c305aaaa8828a5f7ed7a458

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiobafi6-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 27.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.2 Darwin/22.3.0

File hashes

Hashes for aiobafi6-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 33af373a28076ed597663ad5b52720cce5318417826d0e3bffd6173408ee0376
MD5 0c1852c63d83f7cbcce1cd79d833e80a
BLAKE2b-256 8c459b562c2f7bb882344fcdd6911f105523f92219229928486452eb85b55061

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