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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pystiebeleltron-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1be6d89a87d9df00cbfb5302d8f42124fa3137127371058ad051bad2b69ab217
MD5 576cc49ded0a0513e26822fc2f75db9b
BLAKE2b-256 862ce0e35b93ba338179632599c6a5119fa2d0da77097f9d543b1873b77f9884

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pystiebeleltron-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39e573ed1d69ece21541e0aa39389a5aa12eff00dea28d20a5b0b7bf6573de50
MD5 c4869c2cec730941a6f411d408c4fd84
BLAKE2b-256 2740a967d5e2b1a2f6215483a4e6aaf3fa8851abbcfe5f257a0036610f1afc29

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