Introduction

Homie v4 specifications for MQTT implemented in CircuitPython

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Adafruit MiniMQTT Library

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

pip install circuitpython-homie

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-homie

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-homie

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install circuitpython-homie

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install homie

Or the following command to update an existing version:

circup update

Usage Examples

Using the examples requires a secrets.py file that stores your secret information about the MQTT broker and network settings. This is described with detail in the documentation.

See the examples in the examples folder. These will be included with the Circuitpython Community bundle as well.

Documentation

API documentation for this library can be found on Read the Docs.

Instructions for build the documentation is in our Contributing Guidelines.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

See also our Contributing Guidelines for information about the development workflow.