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).

The API takes an already-connected ModbusUnit. You own the connection: open it, hand a unit to the API, and close it when done. Each register block is a component exposed on the API, and values are read as typed attributes (None when the register is unavailable).

    import asyncio
    from modbus_connection.pymodbus import connect_tcp
    from pystiebeleltron.wpm import WpmStiebelEltronAPI

    async def main():
      connection = await connect_tcp('IP_ADDRESS_ISG', port=502)
      api = WpmStiebelEltronAPI(connection.for_unit(1))

      await api.async_update()

      print(f"outside temperature: {api.system_values.outside_temperature}")
      print(f"water comfort target temperature: {api.system_parameters.comfort_temperature}")

      # Writing a register:
      await api.system_parameters.write("comfort_temperature", 50)

      await connection.close()

    asyncio.run(main())

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.5.1.tar.gz (10.3 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.5.1-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pystiebeleltron-0.5.1.tar.gz
Algorithm Hash digest
SHA256 9095558fee895f2c034bad4ba70dc88c641ea925bf6eee9035ea34ed217739da
MD5 3f0e7c86bef135cdf5afac903ea91825
BLAKE2b-256 28b00261b7bd5e52b32134a0f22f8e7c21b0759008d7fae706a4dca9a19b4151

See more details on using hashes here.

Provenance

The following attestation bundles were made for pystiebeleltron-0.5.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.5.1-py3-none-any.whl.

File metadata

  • Download URL: pystiebeleltron-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 11.7 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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aaf0caf0b50a2c72fe489035cbe4d197e6821d2821da856a7399abb9bdd47343
MD5 19e2ee5a386260c221a8b3a63df83256
BLAKE2b-256 a03fdb3b3067794555fabe349c7547ba27cc1fb624c916271688fa0b94f34e14

See more details on using hashes here.

Provenance

The following attestation bundles were made for pystiebeleltron-0.5.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