Skip to main content

Python API for interacting with the Stiebel Eltron ISG web gateway via Modbus for controlling integral ventilation units and heat pumps.

Project description

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, 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 installed.

  • STIEBEL ELTRON Internet-Service Gateway ISG WEB with enabled modbus module
    • 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.

    $ pip install pystiebeleltron

Example usage of the module

The sample below shows how to use this Python module (api for wpm heat pumps).

    import asyncio
    from pystiebeleltron.wpm import WpmStiebelEltronAPI, WpmSystemParametersRegisters

    async def main():
      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()

    asyncio.run(main())

Example usage of the module

The sample below shows how to use this Python module (old api for lwz heat pumps).

    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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pystiebeleltron-0.3.1.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pystiebeleltron-0.3.1-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file pystiebeleltron-0.3.1.tar.gz.

File metadata

  • Download URL: pystiebeleltron-0.3.1.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pystiebeleltron-0.3.1.tar.gz
Algorithm Hash digest
SHA256 14c21e3b6525b8e58882f4f5e581b567a880ca36bf3273cd55ac618e7352c9ee
MD5 587d4fa64b1c13f6e322460307f2bb8c
BLAKE2b-256 7a0e9506cdaf61e41bca371faf47519d3b9a8b30104cb37bdc81ede91a1896ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for pystiebeleltron-0.3.1.tar.gz:

Publisher: release-to-pypi.yml on ThyMYthOS/python-stiebel-eltron

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pystiebeleltron-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: pystiebeleltron-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pystiebeleltron-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8d07f774fe6df24039669134d456e073e468a58eabc249cda141628c5de82517
MD5 a0dd0f3f1444c3767e0bfcb894df2efb
BLAKE2b-256 30d6154bc14812f33cdee9cd59ae2b1cca7d954fb507d00755adade9d1a6db3e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pystiebeleltron-0.3.1-py3-none-any.whl:

Publisher: release-to-pypi.yml on ThyMYthOS/python-stiebel-eltron

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page