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.2.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.2-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pystiebeleltron-0.3.2.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.2.tar.gz
Algorithm Hash digest
SHA256 3ddbad8aa7e8b91ba75936918c03cc3ae813da0914fded0f75db6d9d86cecd40
MD5 0ed9bc7e731ac588b7b84f96042b96a7
BLAKE2b-256 cc18c621dd7361314393e7b6ca511c3081b186c0292dcdc78922146d3598accb

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: pystiebeleltron-0.3.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ad3ba8c9a130ea1ff9e7a444ecd92c8a0e11cb5cbd034ef69fac1b3fd9db2c31
MD5 14f040910a4edf8ff305f666f8632c6f
BLAKE2b-256 1436ab48a0e46ec88bc24e0da93d37d63c2986fbaf294957ea742c87d5dde891

See more details on using hashes here.

Provenance

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