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.2.5.tar.gz (20.1 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.2.5-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pystiebeleltron-0.2.5.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for pystiebeleltron-0.2.5.tar.gz
Algorithm Hash digest
SHA256 9eed14156084590a1279be12c5bd5e909c6c52384173f347c5e766dca64c1997
MD5 b2fa142ff70108dc3068cdc071320836
BLAKE2b-256 9ffb8e2732d3d632cdc7b56faf7972dc8da6344f049f355a93794cd8f39c4139

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pystiebeleltron-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6c172afe17e7dfa7f58c98887388ab75c3e31e1ba32f360ee434b89f0f475c31
MD5 b3f0bdecd5ed66ffec55fd0e7ee9de77
BLAKE2b-256 acb6e2b406af5295b0a264df23a1afd2f39d25bdc5ec25ba76aee8857f337d4e

See more details on using hashes here.

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