Metadata-Version: 2.1
Name: aiobafi6
Version: 0.9.0
Summary: Big Ass Fans i6/Haiku protocol asynchronous Python library
Home-page: https://github.com/jfroy/aiobafi6
License: Apache-2.0
Keywords: BigAssFans,i6,Haiku,SenseME
Author: Jean-Francois Roy
Author-email: jf@devklog.net
Requires-Python: >=3.10.0
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Home Automation
Requires-Dist: protobuf (>=3.20)
Requires-Dist: zeroconf (>=0.38)
Project-URL: Repository, https://github.com/jfroy/aiobafi6
Description-Content-Type: text/markdown

# aiobafi6

[![PyPI version](https://badge.fury.io/py/aiobafi6.svg)](https://badge.fury.io/py/aiobafi6)
[![Downloads](https://pepy.tech/badge/aiobafi6)](https://pepy.tech/project/aiobafi6)

aiobafi6 is a python library to discovery, query and control
[Big Ass Fans](https://bigassfans.com) 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](https://developers.google.com/protocol-buffers) for message
wire serialization. This library maintains a
[single proto file](proto/aiobafi6.proto) 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](https://github.com/bdraco) for writing the HASS integration, helping with
Python, and suggesting BAF is using protobufs.

[@oogje](https://github.com/oogje) for a reference homebridge implementation.

[Big Ass Fans](https://www.bigassfans.com) for making great products.