Skip to main content

Python interface for Rinnai Control-R API

Project description

rinnaicontrolr - Python interface for the Rinnai Control-R API

PyPi License

Python library for communicating with the Rinnai Control-R Water Heaters and control devices via the Rinnai Control-R cloud API.

Rinnai's API is completely insecure. We recommend that you disconnect your water heater from the Control-R system until Rinnai fixes these basic issues.

This library is community supported. Please submit changes and improvements.

Support For

  • reading and setting the temperature setpoint
  • reading whether heating or recirculation is in progress
  • starting recirculation

Limited Support For

  • reading schedules, vacation state
  • reading flow rates and service parameters
  • reading intake temperature, outlet temperature
  • reading the address of the device as entered into Control-R

No Support For

  • creating schedules
  • setting vacation state

Please submit pull requests to add support for your favorite values.

Installation

pip install rinnaicontrolr

Example

rinnai = RinnaiWaterHeater(username, password)
for device in rinnai.get_devices():
    rinnai.set_temperature_setpoint(device, 90) # make it annoyingly cold
    rinnai.start_recirculation(device, 15) # start recirculation for 15 minutes
    if rinnai.is_heating(device):
        print(f'heater is heating to a setpoint of {rinnai.get_temperature_setpoint(device)} degrees.')

Known Issues

  • Rinnai's API performs no authentication. Sorry, we can't fix this, we don't work for Rinnai.

Future Plans

  • Perform authentication once Rinnai's API requires it.
  • asyncio interface.

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

rinnaicontrolr-0.4.1.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

rinnaicontrolr-0.4.1-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file rinnaicontrolr-0.4.1.tar.gz.

File metadata

  • Download URL: rinnaicontrolr-0.4.1.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for rinnaicontrolr-0.4.1.tar.gz
Algorithm Hash digest
SHA256 31b105fbb543e9bed8bc3c732bfdedf86d702306a541dd3beab088d00eb735dd
MD5 d9e07585647037f724c9ce2d42cc5baf
BLAKE2b-256 38976852a1ffe7a7907bcd4abc189cb23f08c715d4042b742cf75e96eeb7389b

See more details on using hashes here.

File details

Details for the file rinnaicontrolr-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for rinnaicontrolr-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 054a47439619e949749d0b61d16df45bfa32d285f0731202eb7a328fab04cc63
MD5 d41b8ddfd2f2c12d3dc710e6ab39af4e
BLAKE2b-256 f92e601d50d7d83a3de6c5ea97f3724eff5ee1626b75c561713bb799385d6921

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page