| Name | pystiebeleltron JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | Python API for interacting with the Stiebel Eltron ISG web gateway via Modbus for controlling integral ventilation units and heat pumps. |
| upload_time | 2025-08-09 17:44:29 |
| maintainer | None |
| docs_url | None |
| author | Manuel Stahl, Martin Fuchs |
| requires_python | <4,>=3.10 |
| license | MIT License
Copyright (c) 2018 Martin Fuchs
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 |
modbus
stiebel-eltron
tecalor
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align=center>
<img src="https://www.stiebel-eltron.de/apps/ste/docroot/images/single/logo-stiebel-eltron.png"/>
</p>
<p align=center>
<a href="https://pypi.org/project/pystiebeleltron/"><img src="https://img.shields.io/pypi/v/pystiebeleltron.svg"/></a>
<a href="https://github.com/ThyMYthOS/python-stiebel-eltron/actions/workflows/test-python-package.yml"><img src="https://github.com/ThyMYthOS/python-stiebel-eltron/actions/workflows/test-python-package.yml/badge.svg"/></a>
<!--a href='https://coveralls.io/github/fucm/python-stiebel-eltron?branch=master'><img src='https://coveralls.io/repos/github/fucm/python-stiebel-eltron/badge.svg?branch=master' alt='Coverage Status' /></a>
<img src="https://img.shields.io/github/license/ThyMYthOS/python-stiebel-eltron.svg"/></a Maybe use https://github.com/marketplace/actions/coverage-badge-->
</p>
# python-stiebel-eltron
Python API for interacting with the STIEBEL ELTRON ISG web gateway via modbus for controlling integral ventilation units and heat pumps.
This module is based on the STIEBEL ELTRON [modbus user manual](https://www.stiebel-eltron.ch/content/dam/ste/ch/de/downloads/kundenservice/smart-home/Modbus/Modbus%20Bedienungsanleitung.pdf), but is not official, developed, supported or endorsed by Stiebel Eltron GmbH & Co. KG. For questions and other inquiries, use the issue tracker in this repo please.
## Requirements
You need to have [Python](https://www.python.org) installed.
* STIEBEL ELTRON Internet-Service Gateway [ISG WEB](https://www.stiebel-eltron.com/en/home/products-solutions/renewables/controller_energymanagement/internet_servicegateway/isg_web.html) with enabled [modbus module](https://www.stiebel-eltron.ch/de/home/service/smart-home/modbus.html)
* You can call the STIEBEL ELTRON support, if your ISG does not have the modbus module enabled. They upgraded mine for free.
* STIEBEL ELTRON heatpumpt (compatible). Successfully used devices:
* LWZ504e
* LWZ304
* Network connection to the ISG WEB
## Installation
The package is available in the [Python Package Index](https://pypi.python.org/).
```bash
$ pip install python-stiebel-eltron
```
## Example usage of the module
The sample below shows how to use this Python module (api for wpm heat pumps).
```python
from pystiebeleltron.wpm import WpmStiebelEltronAPI, WpmSystemParametersRegisters
api = WpmStiebelEltronAPI('IP_ADDRESS_ISG')
await api.connect()
await api.async_update()
print("water comfort target temperature: {}".format(api.get_register_value(WpmSystemParametersRegisters.COMFORT_TEMPERATURE)))
await api.close()
```
## Example usage of the module
The sample below shows how to use this Python module (old api for lwz heat pumps).
```python
from pystiebeleltron import pystiebeleltron as pyse
from pymodbus.client.sync import ModbusTcpClient as ModbusClient
client = ModbusClient(host='IP_ADDRESS_ISG', port=502, timeout=2)
client.connect()
unit = pyse.StiebelEltronAPI(client, 1)
unit.update()
print("get_target_temp: {}".format(unit.get_target_temp))
client.close()
```
## License
``python-stiebel-eltron`` is licensed under MIT, for more details check LICENSE.
Raw data
{
"_id": null,
"home_page": null,
"name": "pystiebeleltron",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": null,
"keywords": "modbus, stiebel-eltron, tecalor",
"author": "Manuel Stahl, Martin Fuchs",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/af/b2/20f0cfcd75c2dc1a3fe96687dca951623be5717e45ad680537312883c91d/pystiebeleltron-0.2.3.tar.gz",
"platform": null,
"description": "<p align=center>\n <img src=\"https://www.stiebel-eltron.de/apps/ste/docroot/images/single/logo-stiebel-eltron.png\"/>\n</p>\n<p align=center>\n <a href=\"https://pypi.org/project/pystiebeleltron/\"><img src=\"https://img.shields.io/pypi/v/pystiebeleltron.svg\"/></a>\n <a href=\"https://github.com/ThyMYthOS/python-stiebel-eltron/actions/workflows/test-python-package.yml\"><img src=\"https://github.com/ThyMYthOS/python-stiebel-eltron/actions/workflows/test-python-package.yml/badge.svg\"/></a>\n <!--a href='https://coveralls.io/github/fucm/python-stiebel-eltron?branch=master'><img src='https://coveralls.io/repos/github/fucm/python-stiebel-eltron/badge.svg?branch=master' alt='Coverage Status' /></a>\n <img src=\"https://img.shields.io/github/license/ThyMYthOS/python-stiebel-eltron.svg\"/></a Maybe use https://github.com/marketplace/actions/coverage-badge-->\n</p>\n\n# python-stiebel-eltron\nPython API for interacting with the STIEBEL ELTRON ISG web gateway via modbus for controlling integral ventilation units and heat pumps.\n\nThis module is based on the STIEBEL ELTRON [modbus user manual](https://www.stiebel-eltron.ch/content/dam/ste/ch/de/downloads/kundenservice/smart-home/Modbus/Modbus%20Bedienungsanleitung.pdf), but is not official, developed, supported or endorsed by Stiebel Eltron GmbH & Co. KG. For questions and other inquiries, use the issue tracker in this repo please.\n\n## Requirements\nYou need to have [Python](https://www.python.org) installed.\n\n* STIEBEL ELTRON Internet-Service Gateway [ISG WEB](https://www.stiebel-eltron.com/en/home/products-solutions/renewables/controller_energymanagement/internet_servicegateway/isg_web.html) with enabled [modbus module](https://www.stiebel-eltron.ch/de/home/service/smart-home/modbus.html)\n * You can call the STIEBEL ELTRON support, if your ISG does not have the modbus module enabled. They upgraded mine for free.\n* STIEBEL ELTRON heatpumpt (compatible). Successfully used devices:\n * LWZ504e\n * LWZ304\n* Network connection to the ISG WEB\n\n## Installation\nThe package is available in the [Python Package Index](https://pypi.python.org/).\n\n```bash\n $ pip install python-stiebel-eltron\n```\n\n## Example usage of the module\nThe sample below shows how to use this Python module (api for wpm heat pumps).\n\n```python\n from pystiebeleltron.wpm import WpmStiebelEltronAPI, WpmSystemParametersRegisters\n\n api = WpmStiebelEltronAPI('IP_ADDRESS_ISG')\n await api.connect()\n\n await api.async_update()\n\n print(\"water comfort target temperature: {}\".format(api.get_register_value(WpmSystemParametersRegisters.COMFORT_TEMPERATURE)))\n\n await api.close()\n```\n\n## Example usage of the module\nThe sample below shows how to use this Python module (old api for lwz heat pumps).\n\n```python\n from pystiebeleltron import pystiebeleltron as pyse\n from pymodbus.client.sync import ModbusTcpClient as ModbusClient\n\n client = ModbusClient(host='IP_ADDRESS_ISG', port=502, timeout=2)\n client.connect()\n\n unit = pyse.StiebelEltronAPI(client, 1)\n unit.update()\n\n print(\"get_target_temp: {}\".format(unit.get_target_temp))\n\n client.close()\n```\n\n## License\n\n``python-stiebel-eltron`` is licensed under MIT, for more details check LICENSE.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2018 Martin Fuchs\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Python API for interacting with the Stiebel Eltron ISG web gateway via Modbus for controlling integral ventilation units and heat pumps.",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/ThyMYthOS/python-stiebel-eltron",
"Issues": "https://github.com/ThyMYthOS/python-stiebel-eltron/issues"
},
"split_keywords": [
"modbus",
" stiebel-eltron",
" tecalor"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "49d4f0cc640585285cb91a87b9d3b389a35a1159b50f24c150b7eed0541ad038",
"md5": "f24595dee248200a36fd4bcbca812a76",
"sha256": "f56205b7830fbf10435221b989140f3675d22de69c914afa628b75eb88243370"
},
"downloads": -1,
"filename": "pystiebeleltron-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f24595dee248200a36fd4bcbca812a76",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 21714,
"upload_time": "2025-08-09T17:44:28",
"upload_time_iso_8601": "2025-08-09T17:44:28.774658Z",
"url": "https://files.pythonhosted.org/packages/49/d4/f0cc640585285cb91a87b9d3b389a35a1159b50f24c150b7eed0541ad038/pystiebeleltron-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "afb220f0cfcd75c2dc1a3fe96687dca951623be5717e45ad680537312883c91d",
"md5": "c9796d99558005ef99ac7b994322cdff",
"sha256": "6310379b39d17212ca6d2b307d410a3aceb12d5172ab07c58e60e7615eb3dad6"
},
"downloads": -1,
"filename": "pystiebeleltron-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "c9796d99558005ef99ac7b994322cdff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 19851,
"upload_time": "2025-08-09T17:44:29",
"upload_time_iso_8601": "2025-08-09T17:44:29.844758Z",
"url": "https://files.pythonhosted.org/packages/af/b2/20f0cfcd75c2dc1a3fe96687dca951623be5717e45ad680537312883c91d/pystiebeleltron-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-09 17:44:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ThyMYthOS",
"github_project": "python-stiebel-eltron",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pystiebeleltron"
}
