{"id":16020323,"url":"https://github.com/2bndy5/circuitpython_homie","last_synced_at":"2026-05-03T16:31:10.649Z","repository":{"id":65473481,"uuid":"540643699","full_name":"2bndy5/CircuitPython_Homie","owner":"2bndy5","description":"Homie implementation for MQTT in CircuiPython","archived":false,"fork":false,"pushed_at":"2024-02-25T07:01:59.000Z","size":376,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-02T02:51:22.577Z","etag":null,"topics":["circuitpython","homie","homie-convention","mqtt","mqttclient","python"],"latest_commit_sha":null,"homepage":"http://circuitpython-homie.rtfd.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/2bndy5.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-23T23:02:50.000Z","updated_at":"2022-09-29T03:56:56.000Z","dependencies_parsed_at":"2024-10-14T01:15:56.335Z","dependency_job_id":null,"html_url":"https://github.com/2bndy5/CircuitPython_Homie","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2bndy5%2FCircuitPython_Homie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2bndy5%2FCircuitPython_Homie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2bndy5%2FCircuitPython_Homie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2bndy5%2FCircuitPython_Homie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/2bndy5","download_url":"https://codeload.github.com/2bndy5/CircuitPython_Homie/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247284914,"owners_count":20913691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circuitpython","homie","homie-convention","mqtt","mqttclient","python"],"created_at":"2024-10-08T17:24:15.198Z","updated_at":"2026-05-03T16:31:10.614Z","avatar_url":"https://github.com/2bndy5.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-homie/badge/?version=latest\n    :target: https://circuitpython-homie.rtfd.io/\n    :alt: Documentation Status\n.. image:: https://github.com/2bndy5/CircuitPython_Homie/workflows/Build%20CI/badge.svg\n    :target: https://github.com/2bndy5/CircuitPython_Homie/actions\n    :alt: Build Status\n.. image:: https://codecov.io/gh/2bndy5/CircuitPython_Homie/branch/main/graph/badge.svg?token=FOEW7PBQG8\n    :target: https://codecov.io/gh/2bndy5/CircuitPython_Homie\n    :alt: Test Code Coverage\n.. image:: https://static.pepy.tech/personalized-badge/circuitpython-homie?period=total\u0026units=international_system\u0026left_color=grey\u0026right_color=blue\u0026left_text=PyPI%20Downloads\n    :target: https://pepy.tech/project/circuitpython-homie\n\nHomie v4 specifications for MQTT implemented in CircuitPython\n\n.. image:: https://homieiot.github.io/img/works-with-homie.svg\n    :alt: Works with MQTT Homie\n    :target: https://homieiot.github.io/\n\nDependencies\n------------\n\nThis driver depends on:\n\n* `Adafruit CircuitPython \u003chttps://github.com/adafruit/circuitpython\u003e`_\n* `Adafruit MiniMQTT Library \u003chttps://docs.circuitpython.org/projects/minimqtt/en/latest/\u003e`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle \u003chttps://circuitpython.org/libraries\u003e`_\nor individual libraries can be installed using `circup \u003chttps://github.com/adafruit/circup\u003e`_.\n\nInstalling from PyPI\n--------------------\n\n.. code-block:: shell\n\n    pip install circuitpython-homie\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI \u003chttps://pypi.org/project/circuitpython-homie/\u003e`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install circuitpython-homie\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install circuitpython-homie\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name \u0026\u0026 cd project-name\n    python3 -m venv .env\n    source .env/bin/activate\n    pip3 install circuitpython-homie\n\nInstalling to a Connected CircuitPython Device with Circup\n**********************************************************\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n    pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n    circup install homie\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n    circup update\n\nUsage Examples\n--------------\n\nUsing the examples requires a secrets.py file that stores your secret information about the MQTT\nbroker and network settings. This is `described with detail in the documentation\n\u003chttps://circuitpython-homie.rtfd.io/en/latest/examples.html\u003e`_.\n\nSee the examples in the\n`examples \u003chttps://github.com/2bndy5/CircuitPython_Homie/tree/main/examples\u003e`_ folder.\nThese will be included with the Circuitpython Community bundle as well.\n\nDocumentation\n-------------\n\n.. _Contributing Guidelines: https://circuitpython-homie.rtfd.io/en/latest/contributing.html\n\nAPI documentation for this library can be found on\n`Read the Docs \u003chttps://circuitpython-homie.rtfd.io/\u003e`_.\n\nInstructions for build the documentation is in our `Contributing Guidelines`_.\n\nContributing\n------------\n\nContributions are welcome! Please read our `Code of Conduct\n\u003chttps://github.com/2bndy5/CircuitPython_Homie/blob/HEAD/CODE_OF_CONDUCT.md\u003e`_\nbefore contributing to help this project stay welcoming.\n\nSee also our `Contributing Guidelines`_ for information about the development workflow.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2bndy5%2Fcircuitpython_homie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F2bndy5%2Fcircuitpython_homie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2bndy5%2Fcircuitpython_homie/lists"}