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

Uploaded Source

Built Distribution

aiobafi6-0.9.0-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiobafi6-0.9.0.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.3 Linux/6.4.6-arch1-1

File hashes

Hashes for aiobafi6-0.9.0.tar.gz
Algorithm Hash digest
SHA256 e7df7137170f3840630acd765590c0e51adce2fa78e7b9b24f97e5080977c3b3
MD5 2612d4274bd8958f51d30476c7e57e73
BLAKE2b-256 b875410d61f4f6476798781f1370b7bdb34fdb31de962ebc8184d75c88f9f0db

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiobafi6-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.3 Linux/6.4.6-arch1-1

File hashes

Hashes for aiobafi6-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ebd88417ab8de1c23b8835d4787435766186a033e8f8014c1b81b87c6887f115
MD5 8f19ab65702e85fbf1cce323477691ca
BLAKE2b-256 81d7b8eb4664e2f3c0fdaeb68afc28d962ed5deaa5741b5b2cdbfd57a36526d0

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