| Name | mqtt-entity JSON |
| Version |
1.0.16
JSON |
| download |
| home_page | None |
| Summary | MQTT client supporting Home Assistant MQTT entity auto-discovery |
| upload_time | 2025-07-16 11:41:05 |
| maintainer | None |
| docs_url | None |
| author | Johann Kellerman |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2021-2025 Johann Kellerman Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
home-assistant
mqtt
library
discovery
asyncio
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MQTT Entity helper library for Home Assistant
[](https://github.com/kellerza/mqtt_entity/actions)
[](https://codecov.io/gh/kellerza/mqtt_entity)
A Python helper library to manage Home Assistant entities over MQTT.
Updated for device based MQTT discovery.
Features:
- MQTT client based on paho-mqtt
- Retrieve MQTT service info from the Home Assistant Supervisor
- Manage MQTT discovery info (adding/removing entities)
- MQTTDevice class to manage devices
- Availability management
- Manage entities per device
- Home Assistant Entities modelled as attrs classes:
- Read-only: Sensor, BinarySensor
- Read & write: Select, Switch, Number, Text, Light
- MQTT device events
- Asyncio based
- Helpers for Home Assistant add-ons (optional)
- Add-on configuration modeled as attrs classes
- Load from environment variables, HA's options.yaml or options.json
- Load MQTT connection settings from the Supervisor
- Enable add-on logging (incl colors & debug by config)
## Why?
This MQTT code was included in several of my home Assistant addons (SMA-EM / Sunsynk). It is easier to update a single library & add new features, like discovery removal.
Alternatives options (not based on asyncio)
- <https://pypi.org/project/ha-mqtt-discoverable/>
- <https://pypi.org/project/homeassistant-mqtt-binding/>
## Credits
@Ivan-L contributed some of the writable entities to the Sunsynk addon project
## Release
Semantic versioning is used for release.
To create a new release, include a commit with a :dolphin: emoji as a prefix in the commit message. This will trigger a release on the master branch.
```bash
# Patch
git commit -m ":dolphin: Release 0.0.x"
# Minor
git commit -m ":rocket: Release 0.x.0"
```
### Development
To run the tests, you need to have Python 3.12+ installed.
The `--mqtt` connects to a live Home Assistant instance using the MQTT broker.
```bash
uv run pytest --mqtt
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mqtt-entity",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "home-assistant, mqtt, library, discovery, asyncio",
"author": "Johann Kellerman",
"author_email": "Johann Kellerman <johann.kellerman@nokia.com>",
"download_url": "https://files.pythonhosted.org/packages/17/cf/e3da14173896bd9b7ac7f09665f194cfec70e630b776227cdd215b22cd6f/mqtt_entity-1.0.16.tar.gz",
"platform": null,
"description": "# MQTT Entity helper library for Home Assistant\n\n[](https://github.com/kellerza/mqtt_entity/actions)\n[](https://codecov.io/gh/kellerza/mqtt_entity)\n\nA Python helper library to manage Home Assistant entities over MQTT.\n\nUpdated for device based MQTT discovery.\n\nFeatures:\n\n- MQTT client based on paho-mqtt\n - Retrieve MQTT service info from the Home Assistant Supervisor\n- Manage MQTT discovery info (adding/removing entities)\n- MQTTDevice class to manage devices\n - Availability management\n - Manage entities per device\n- Home Assistant Entities modelled as attrs classes:\n - Read-only: Sensor, BinarySensor\n - Read & write: Select, Switch, Number, Text, Light\n - MQTT device events\n- Asyncio based\n- Helpers for Home Assistant add-ons (optional)\n - Add-on configuration modeled as attrs classes\n - Load from environment variables, HA's options.yaml or options.json\n - Load MQTT connection settings from the Supervisor\n - Enable add-on logging (incl colors & debug by config)\n\n## Why?\n\nThis MQTT code was included in several of my home Assistant addons (SMA-EM / Sunsynk). It is easier to update a single library & add new features, like discovery removal.\n\nAlternatives options (not based on asyncio)\n\n- <https://pypi.org/project/ha-mqtt-discoverable/>\n- <https://pypi.org/project/homeassistant-mqtt-binding/>\n\n## Credits\n\n@Ivan-L contributed some of the writable entities to the Sunsynk addon project\n\n## Release\n\nSemantic versioning is used for release.\n\nTo create a new release, include a commit with a :dolphin: emoji as a prefix in the commit message. This will trigger a release on the master branch.\n\n```bash\n# Patch\ngit commit -m \":dolphin: Release 0.0.x\"\n\n# Minor\ngit commit -m \":rocket: Release 0.x.0\"\n```\n\n### Development\n\nTo run the tests, you need to have Python 3.12+ installed.\n\nThe `--mqtt` connects to a live Home Assistant instance using the MQTT broker.\n\n```bash\nuv run pytest --mqtt\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021-2025 Johann Kellerman Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "MQTT client supporting Home Assistant MQTT entity auto-discovery",
"version": "1.0.16",
"project_urls": null,
"split_keywords": [
"home-assistant",
" mqtt",
" library",
" discovery",
" asyncio"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d015015a420ec8f0d77b245ae29de9b0ed81f6a288ed7e66da190970bc23b2e9",
"md5": "c96c27bc2f21b623a24f5bd6f7a7cc8a",
"sha256": "2cffd0924f0fb29d882addc8f039b1e0f4e66f8f422babcd07c6e21672bbe3d3"
},
"downloads": -1,
"filename": "mqtt_entity-1.0.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c96c27bc2f21b623a24f5bd6f7a7cc8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 18394,
"upload_time": "2025-07-16T11:41:04",
"upload_time_iso_8601": "2025-07-16T11:41:04.361039Z",
"url": "https://files.pythonhosted.org/packages/d0/15/015a420ec8f0d77b245ae29de9b0ed81f6a288ed7e66da190970bc23b2e9/mqtt_entity-1.0.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "17cfe3da14173896bd9b7ac7f09665f194cfec70e630b776227cdd215b22cd6f",
"md5": "33a72c2907317ee6fe0e3603b7162703",
"sha256": "9d4d18ed4a179f1347dec008f54bb4345a89e6b88d18cceb6012e00f68db8ae7"
},
"downloads": -1,
"filename": "mqtt_entity-1.0.16.tar.gz",
"has_sig": false,
"md5_digest": "33a72c2907317ee6fe0e3603b7162703",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 16008,
"upload_time": "2025-07-16T11:41:05",
"upload_time_iso_8601": "2025-07-16T11:41:05.613713Z",
"url": "https://files.pythonhosted.org/packages/17/cf/e3da14173896bd9b7ac7f09665f194cfec70e630b776227cdd215b22cd6f/mqtt_entity-1.0.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 11:41:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mqtt-entity"
}
