homebridge-econet-rheem/README.md

Homebridge plugin based on pyeconet for control of Rheem water heaters

<p align="center">
<img src="https://github.com/mpatfield/homebridge-econet-rheem/blob/latest/icon.png" width="100">
</p>

# Homebridge EcoNet Rheem Plugin

This Homebridge plugin integrates Rheem EcoNet devices into Apple HomeKit.

> [!NOTE]
> This plugin uses an unofficial EcoNet API and could stop working at any time without warning.

## Limitations

* Only water heaters in ºF have been fully tested
* Celcius should work but is untested
  * *Let me know if you have successfully used ºC so I can remove this*
* Thermostat implementation is incomplete since I don't have access to the necessary hardware
  * *Running in debug mode will generate the json output I need*
* Due to limitations in HomeKit, it is not possible to switch water heater modes, only enable/disable and adjust the desired temperature.

## Installation

1. Ensure you have [Homebridge](https://homebridge.io) installed and running.
2. Install this plugin via npm:

   ```bash
   npm install -g homebridge-econet-rheem
   ```

## Configuration

Add the following to your Homebridge `config.json`:

   ```json
   {
     "platforms": [
       {
         "platform": "HomebridgeEconetRheem",
         "email": "your_econet_email",
         "password": "your_econet_password",
         "debug": false
       }
     ]
   }
   ```

- `platform`: (Required) Must be "HomebridgeEconetRheem".
- `email`: (Required) Your Econet account email.
- `password`: (Required) Your Econet account password.
- `debug`: (Optional) Set to `true` to enable debug logging. Default is `false`.

## Contributing

Contributions to support Thermostat operation are welcome. To assist:

1. Set `"debug": true` in the plugin configuration.
2. Run Homebridge in debug mode:

   ```bash
   homebridge -D
   ```

3. Capture the JSON responses for HTTP and MQTT state changes.
4. Submit the captured data via a GitHub issue or pull request.

Your contributions will help enhance the plugin's functionality and device support.

## Disclaimer

This plugin is independently developed and is not in any way affiliated with or endorsed by Rheem.

## Credits

Econet API leans heavily on earlier work done by [@w1ll1am23](https://github.com/sponsors/w1ll1am23) in [pyeconet](https://github.com/w1ll1am23/pyeconet), a Python 3 interface to the EcoNet API.