Skip to main content

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 a ModbusUnit. You own the connection: build it, hand a unit to the API, and close it when done. Building it performs no I/O — the first read establishes the link, and a link that drops later is re-established on the next request, over the same unit handle. 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 import ModbusTcpParams
    from modbus_connection.pymodbus import ModbusConnection
    from pystiebeleltron.wpm import WpmStiebelEltronAPI

    async def main():
      connection = ModbusConnection(ModbusTcpParams(host='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.

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.7.0.tar.gz (15.6 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.7.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pystiebeleltron-0.7.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pystiebeleltron-0.7.0.tar.gz
Algorithm Hash digest
SHA256 b1edb2ebbfcfb2a84062c1e6354b0ade1afa091ed28adee8e173a1c2a712eb9e
MD5 da051917c34ae1d64c6ddfd82f8542fc
BLAKE2b-256 dcb62be1f0cc15652b666f1c18d64fd5c8b2460b27296ab92f0ac06e9f17f8b1

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: pystiebeleltron-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pystiebeleltron-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 97ca2999e19f91c011fffeebb0b40e8c14c2e4ed69aa3c420d2b32a804da8ae3
MD5 dfd465b5962650f43e735c0936eaf1b4
BLAKE2b-256 daa2d4d68aa4f4e2c896ae4a96936bf5fe4ae60cfd02d0b77e4368557e4816ba

See more details on using hashes here.

Provenance

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

Release history Release notifications | RSS feed

0.7.1

2 files

This release

0.7.0 This release

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page