| Name | victron-mqtt JSON |
| Version |
2025.7.8
JSON |
| download |
| home_page | None |
| Summary | Python library for communicating with Victron Venus OS MQTT interface |
| upload_time | 2025-07-12 14:21:58 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
mqtt
venus os
victron
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🌟 Supercharge Your Victron Devices with victron_mqtt!
[](https://pypi.org/project/victron_mqtt)
[](https://pypi.org/project/victron_mqtt)
-----
## 🚀 Welcome to victron_mqtt!
Are you ready to unlock the full potential of your Victron devices? `victron_mqtt` is here to make your Venus OS experience smoother, faster, and way more fun! Whether you're a seasoned developer or just starting your journey, this library is your gateway to seamless communication with Victron's Venus OS devices like the CCGX, Cerbo GX, and Ekrano GX.
This package is the backend for the Home Assistant [Victron Venus MQTT](https://github.com/tomer-w/ha-victron-mqtt) custom integration.
If you just want to browse the Victron MQTT definitions, please go to the [documentation page](https://tomer-w.github.io/victron_mqtt/).
You can consume the Victron MQTT definitions [here](https://raw.githubusercontent.com/tomer-w/victron_mqtt/refs/heads/main/victron_mqtt.json).
> **Disclaimer:** This is a third-party library and is not affiliated with Victron Energy.
## 🌟 Features
- **⚡ Asynchronous Communication:** Built for modern Python applications, ensuring non-blocking operations.
- **🔍 Device Metrics Viewer:** A Tk-based viewer application to inspect metrics and devices.
- **🛠️ Utility Tools:** Includes utilities like `dump_mqtt` for exploring the MQTT structure.
- **📈 Extensibility:** Easily extendable to support additional metrics and configurations.
## 📦 Installation
Getting started is as easy as pie! Just run:
```bash
pip install victron_mqtt
```
## 🧑💻 Usage
### 🎨 Viewer Application
Want to see your Victron devices in action? Fire up the viewer application written in Tk:
```bash
python3 -m victron_mqtt.utils.view_metrics
```
This viewer is not just functional—it's a great example of how to use the library in your own projects.
### 🕵️♂️ Dump MQTT Structure
Curious about the full MQTT structure from your device? Dive deep with the `dump_mqtt` utility:
```bash
# Dumps a full MQTT structure into fullvictrondump.txt
python3 -m victron_mqtt.utils.dump_mqtt > fullvictrondump.txt
# Command-line help for specifying connection details:
python3 -m victron_mqtt.utils.dump_mqtt --help
```
## Help Needed!!
Please help with extending the library with more topics. See instructions [here](extending-victron-support.md) for how to contribute.
## ⚠️ Limitations and Known Issues
- **🧪 Limited Testing:** The library has been tested with a single configuration of a Victron installation. It may not include all metrics relevant to other setups.
- **🔒 Read-Only:** Currently, the library supports data retrieval only. Changing settings is not yet implemented.
## 🐞 Logging Issues
Found a bug or need help? We're here for you! Log issues on [GitHub](https://github.com/tomer-w/victron_mqtt/issues).
To help us support your setup, you can attach the output of the `dump_mqtt` utility to your issue.
## 📜 License
`victron_mqtt` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
## Acknowledgments
- Thanks to Johan du Plessis <johan@epicwin.co.za> who [started](https://github.com/JohansLab/victronvenusclient) the original library this one is based on. It is not clear if the original library is still maintained, so I forked it and continue to make progress with it.
- Thanks to Victron Energy for their excellent hardware and documentation
Raw data
{
"_id": null,
"home_page": null,
"name": "victron-mqtt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "mqtt, venus os, victron",
"author": null,
"author_email": "Tomer <57483589+tomer-w@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/f2/cb/9302ddba1e084c81200d2634fcde5994265b4cc9e7ba9b1ecc555ce70cf7/victron_mqtt-2025.7.8.tar.gz",
"platform": null,
"description": "# \ud83c\udf1f Supercharge Your Victron Devices with victron_mqtt!\n\n[](https://pypi.org/project/victron_mqtt)\n[](https://pypi.org/project/victron_mqtt)\n\n-----\n\n## \ud83d\ude80 Welcome to victron_mqtt!\n\nAre you ready to unlock the full potential of your Victron devices? `victron_mqtt` is here to make your Venus OS experience smoother, faster, and way more fun! Whether you're a seasoned developer or just starting your journey, this library is your gateway to seamless communication with Victron's Venus OS devices like the CCGX, Cerbo GX, and Ekrano GX.\nThis package is the backend for the Home Assistant [Victron Venus MQTT](https://github.com/tomer-w/ha-victron-mqtt) custom integration.\n\n\nIf you just want to browse the Victron MQTT definitions, please go to the [documentation page](https://tomer-w.github.io/victron_mqtt/). \nYou can consume the Victron MQTT definitions [here](https://raw.githubusercontent.com/tomer-w/victron_mqtt/refs/heads/main/victron_mqtt.json).\n\n> **Disclaimer:** This is a third-party library and is not affiliated with Victron Energy.\n\n## \ud83c\udf1f Features\n\n- **\u26a1 Asynchronous Communication:** Built for modern Python applications, ensuring non-blocking operations.\n- **\ud83d\udd0d Device Metrics Viewer:** A Tk-based viewer application to inspect metrics and devices.\n- **\ud83d\udee0\ufe0f Utility Tools:** Includes utilities like `dump_mqtt` for exploring the MQTT structure.\n- **\ud83d\udcc8 Extensibility:** Easily extendable to support additional metrics and configurations.\n\n## \ud83d\udce6 Installation\n\nGetting started is as easy as pie! Just run:\n\n```bash\npip install victron_mqtt\n```\n\n## \ud83e\uddd1\u200d\ud83d\udcbb Usage\n\n### \ud83c\udfa8 Viewer Application\n\nWant to see your Victron devices in action? Fire up the viewer application written in Tk:\n\n```bash\npython3 -m victron_mqtt.utils.view_metrics\n```\n\nThis viewer is not just functional\u2014it's a great example of how to use the library in your own projects.\n\n### \ud83d\udd75\ufe0f\u200d\u2642\ufe0f Dump MQTT Structure\n\nCurious about the full MQTT structure from your device? Dive deep with the `dump_mqtt` utility:\n\n```bash\n# Dumps a full MQTT structure into fullvictrondump.txt\npython3 -m victron_mqtt.utils.dump_mqtt > fullvictrondump.txt\n\n# Command-line help for specifying connection details:\npython3 -m victron_mqtt.utils.dump_mqtt --help\n```\n\n## Help Needed!!\nPlease help with extending the library with more topics. See instructions [here](extending-victron-support.md) for how to contribute.\n\n## \u26a0\ufe0f Limitations and Known Issues\n\n- **\ud83e\uddea Limited Testing:** The library has been tested with a single configuration of a Victron installation. It may not include all metrics relevant to other setups.\n- **\ud83d\udd12 Read-Only:** Currently, the library supports data retrieval only. Changing settings is not yet implemented.\n\n## \ud83d\udc1e Logging Issues\n\nFound a bug or need help? We're here for you! Log issues on [GitHub](https://github.com/tomer-w/victron_mqtt/issues).\n\nTo help us support your setup, you can attach the output of the `dump_mqtt` utility to your issue.\n\n## \ud83d\udcdc License\n\n`victron_mqtt` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n\n## Acknowledgments\n\n- Thanks to Johan du Plessis <johan@epicwin.co.za> who [started](https://github.com/JohansLab/victronvenusclient) the original library this one is based on. It is not clear if the original library is still maintained, so I forked it and continue to make progress with it.\n- Thanks to Victron Energy for their excellent hardware and documentation\n",
"bugtrack_url": null,
"license": null,
"summary": "Python library for communicating with Victron Venus OS MQTT interface",
"version": "2025.7.8",
"project_urls": {
"Documentation": "https://github.com/tomer-w/victron_mqtt#readme",
"Issues": "https://github.com/tomer-w/victron_mqtt/issues",
"Source": "https://github.com/tomer-w/victron_mqtt"
},
"split_keywords": [
"mqtt",
" venus os",
" victron"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5564b7bf625fe199be7d6dadca52ac91fe35cbd821b41502f8f33007f68a70cf",
"md5": "35379238bd95161dd6478954569d1c63",
"sha256": "d1cdabcb83c8d1533c13b63f601d66cb91b05874a1a7fbe1179d9b296b87f437"
},
"downloads": -1,
"filename": "victron_mqtt-2025.7.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "35379238bd95161dd6478954569d1c63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 28236,
"upload_time": "2025-07-12T14:21:57",
"upload_time_iso_8601": "2025-07-12T14:21:57.691402Z",
"url": "https://files.pythonhosted.org/packages/55/64/b7bf625fe199be7d6dadca52ac91fe35cbd821b41502f8f33007f68a70cf/victron_mqtt-2025.7.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f2cb9302ddba1e084c81200d2634fcde5994265b4cc9e7ba9b1ecc555ce70cf7",
"md5": "b7961e72f0a4a81f3875e34cfe9e35d1",
"sha256": "9da143216f9d7b5c29ff7025b28caf320857a4156836eb05d182cbc0bfceea91"
},
"downloads": -1,
"filename": "victron_mqtt-2025.7.8.tar.gz",
"has_sig": false,
"md5_digest": "b7961e72f0a4a81f3875e34cfe9e35d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 44373,
"upload_time": "2025-07-12T14:21:58",
"upload_time_iso_8601": "2025-07-12T14:21:58.742074Z",
"url": "https://files.pythonhosted.org/packages/f2/cb/9302ddba1e084c81200d2634fcde5994265b4cc9e7ba9b1ecc555ce70cf7/victron_mqtt-2025.7.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-12 14:21:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tomer-w",
"github_project": "victron_mqtt#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "victron-mqtt"
}
