{"id":15142074,"url":"https://github.com/ensmartening/circuitpython_minihass","last_synced_at":"2026-01-06T02:39:43.892Z","repository":{"id":215185965,"uuid":"738324036","full_name":"ensmartening/CircuitPython_minihass","owner":"ensmartening","description":"A CircuitPython library for interacting with Home Assistant over MQTT","archived":false,"fork":false,"pushed_at":"2024-07-30T06:00:35.000Z","size":751,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-25T23:18:31.140Z","etag":null,"topics":["circuitpython","home-assistant","home-automation","iot","mqtt"],"latest_commit_sha":null,"homepage":"https://circuitpython-minihass.ensmarten.ing/","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/ensmartening.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"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":"2024-01-03T01:02:12.000Z","updated_at":"2024-09-14T16:12:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"32d1f585-4aaa-44e0-96e4-0f1cc3b3eaaa","html_url":"https://github.com/ensmartening/CircuitPython_minihass","commit_stats":null,"previous_names":["ensmartening/circuitpython_minihass"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensmartening%2FCircuitPython_minihass","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensmartening%2FCircuitPython_minihass/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensmartening%2FCircuitPython_minihass/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ensmartening%2FCircuitPython_minihass/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ensmartening","download_url":"https://codeload.github.com/ensmartening/CircuitPython_minihass/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245556980,"owners_count":20634896,"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","home-assistant","home-automation","iot","mqtt"],"created_at":"2024-09-26T09:22:24.157Z","updated_at":"2026-01-06T02:39:43.832Z","avatar_url":"https://github.com/ensmartening.png","language":"Python","readme":"|banner|\n\n|build status| |codecov status| |docs status| |black|\n\nIntroduction\n============\n\nminihass is a lightweight Python package to interact with Home Assistant over MQTT,\nintended for use with CircuitPython and the Adafruit MiniMQTT library. It provides\nclasses to describe Home Assistant devices and entities, and handles configuration,\nstate, command, and availability messages to and from your Home Assistant MQTT broker.\n\nSupported components\n====================\n\n* `Binary sensor \u003chttps://www.home-assistant.io/integrations/binary_sensor/\u003e`_\n* *not implemented* `Sensor \u003chttps://www.home-assistant.io/integrations/sensor/\u003e`_\n* *not implemented* `Switch \u003chttps://www.home-assistant.io/integrations/switch/\u003e`_\n\n\nDependencies\n============\nThis driver depends on:\n\n* `Adafruit CircuitPython \u003chttps://github.com/adafruit/circuitpython\u003e`_\n* `Adafruit CircuitPython Logging \u003chttps://github.com/adafruit/Adafruit_CircuitPython_Logging\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\n`circup \u003chttps://github.com/adafruit/circup\u003e`_.\n\n..\n    Installing from PyPI\n    =====================\n    .. note:: This library is not available on PyPI yet. Install documentation is included\n    as a standard element. Stay tuned for PyPI availability!\n\n    Todo: Remove the above note if PyPI version is/will be available at time of release.\n\n    On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\n    PyPI \u003chttps://pypi.org/project/cybershoe-circuitpython-minihass/\u003e`_.\n    To install for current user:\n\n    .. code-block:: shell\n\n        pip3 install cybershoe-circuitpython-minihass\n\n    To install system-wide (this may be required in some cases):\n\n    .. code-block:: shell\n\n        sudo pip3 install cybershoe-circuitpython-minihass\n\n    To 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 .venv\n        source .env/bin/activate\n        pip3 install cybershoe-circuitpython-minihass\n\n    Installing to a Connected CircuitPython Device with Circup\n    ==========================================================\n\n    Make sure that you have ``circup`` installed in your Python environment.\n    Install it with the following command if necessary:\n\n    .. code-block:: shell\n\n        pip3 install circup\n\n    With ``circup`` installed and your CircuitPython device connected use the\n    following command to install:\n\n    .. code-block:: shell\n\n        circup install cybershoe_minihass\n\n    Or the following command to update an existing version:\n\n    .. code-block:: shell\n\n        circup update\n\n    Usage Example\n    =============\n\n    Todo: Add a quick, simple example. It and other examples should live in the\n    examples folder and be included in docs/examples.rst.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `ensmarten.ing \u003chttps://circuitpython-minihass.ensmarten.ing/\u003e`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n\u003chttps://github.com/ensmartening/CircuitPython_minihass/blob/HEAD/CODE_OF_CONDUCT.md\u003e`_\nbefore contributing to help this project stay welcoming.\n\n.. |banner| image:: https://ensmarten-ing-assets.s3.amazonaws.com/minihass_social.png\n    :alt: Minihass Banner\n\n.. |build status| image:: https://github.com/ensmartening/CircuitPython_minihass/actions/workflows/build.yml/badge.svg\n    :target: https://github.com/ensmartening/CircuitPython_minihass/actions/workflows/build.yml\n    :alt: Build Status\n\n.. |codecov status| image:: https://codecov.io/gh/ensmartening/CircuitPython_minihass/graph/badge.svg?token=9H0KNZC0PO\n    :target: https://codecov.io/gh/ensmartening/CircuitPython_minihass\n    :alt: Codecov Status\n\n.. |docs status| image:: https://github.com/ensmartening/CircuitPython_minihass/actions/workflows/sphinx.yml/badge.svg\n    :target: https://CircuitPython_minihass.ensmarten.ing\n    :alt: Docs Status\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fensmartening%2Fcircuitpython_minihass","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fensmartening%2Fcircuitpython_minihass","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fensmartening%2Fcircuitpython_minihass/lists"}