Skip to main content
Documentation Status Build Status Test Code Coverage https://static.pepy.tech/personalized-badge/circuitpython-homie?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20Downloads

Homie v4 specifications for MQTT implemented in CircuitPython

Works with MQTT Homie

Dependencies

This driver depends on:

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.

Metadata

Release files for circuitpython-homie 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for circuitpython-homie 0.1.4
File Size Uploaded Provenance Actions
circuitpython-homie-0.1.4.tar.gz 261.9 kB Without provenance Details for circuitpython-homie-0.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for circuitpython-homie 0.1.4
File Interpreter ABI Platform Actions
circuitpython_homie-0.1.4-py3-none-any.whl Python 3 none any Details for circuitpython_homie-0.1.4-py3-none-any.whl

Total release size: 274.5 kB

Release files / circuitpython-homie-0.1.4.tar.gz

Download URL circuitpython-homie-0.1.4.tar.gz
Size 261.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3f93436652ffc24bb21bcef69f21f7a5eda7e5f42931b9365b219711a50f17dc
BLAKE2b-256 checksum
How to use checksums
ee08bbb425e1c8f5228d4a36b067e21c200a661f565c74d17b9f0c55e97cc2d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.8

Release files / circuitpython_homie-0.1.4-py3-none-any.whl

Download URL circuitpython_homie-0.1.4-py3-none-any.whl
Size 12.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4935ee4c861adfcd632e2b901d66f629292365e36c1d64b91a0f61d794d529b7
BLAKE2b-256 checksum
How to use checksums
487adc3e03b47aa1a27e75635e8c4f1bdaf6a71e4275d52133857439ae2f2b76
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.8

Security for circuitpython-homie 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page