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

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pystiebeleltron-0.6.3.tar.gz
Algorithm Hash digest
SHA256 c537ac7867d03950f5286a850d5873d6281dde5c7f23843a35c308df28273fde
MD5 1d6c8e7edeb7391c7ab3d3a9a977d3fa
BLAKE2b-256 36107881672a79cdc26f87ecb143eaf798835ef3dabdfacab5740970f65e62e8

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: pystiebeleltron-0.6.3-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.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fd970e833fa6dc2dfe47526d23bfcf0c609f1b643c30e788af78fe132731fd44
MD5 565b7a049e4a9baf2cf831add3ec74ff
BLAKE2b-256 fe55c175ff48ebd85ea0d96f63de6534290150a9a4934e59bf20243314a61836

See more details on using hashes here.

Provenance

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

0.7.0

2 files

This release

0.6.3 This release

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