homebridge-econet-rheem
Version:
Homebridge plugin based on pyeconet for control of Rheem water heaters
93 lines (62 loc) • 4 kB
Markdown
<p align="center">
<img src="https://github.com/mpatfield/homebridge-econet-rheem/blob/latest/img/banner.png?raw=true" width="600">
</p>
<span align="center">
# homebridge-econet-rheem
Homebridge plugin for HomeKit control of Rheem water heaters and thermostats
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
<!--[](https://plugins.hoobs.org/plugin/homebridge-econet-rheem)-->
[](https://www.npmjs.com/package/homebridge-econet-rheem)
[](https://www.npmjs.com/package/homebridge-econet-rheem)
</span>
## Disclaimer
This plugin is independently developed and is not in any way affiliated with or endorsed by Rheem. Any issues or damage resulting from use of this plugin are not the fault of the developer. Use at your own risk.
> [!NOTE]
> This plugin uses an unofficial EcoNet API and could stop working at any time without warning.
## Limitations
* Water Heaters
* Current temperature is not supported by the API so recovery temperature is simulated
* It is not possible to switch modes, only enable/disable and adjust the desired temperature
* Celcius should work but is untested
* *Let me know if you have successfully used ºC so I can remove this*
## Account Sharing
> [!NOTE]
> It is recommended to use a dedicated account for use with Homebridge.
This is because Rheem only allows one device to be subscribed to real-time updates, so if you open the Rheem app then the Homebridge plugin will silently stop receiving updates.
The plugin will eventually resubscribe after being idle for an extended period, but you could miss updates in the meantime. Using a separate account will avoid this issue.
To get started, visit "Account Sharing" in the Rheem app menu.
## Configuration
Using the Homebridge Config UI is the easiest way to set up this plugin. However, if you wish to do things manually then you will need to add the following to your Homebridge `config.json`:
```json
{
"platforms": [
{
"platform": "HomebridgeEconetRheem",
"email": "your_econet_email",
"password": "your_econet_password",
"wh_sim_disable": false,
"verbose": false
}
]
}
```
- `platform`: (Required) Must be "HomebridgeEconetRheem".
- `email`: (Required) Your Econet account email.
- `password`: (Required) Your Econet account password.
- `wh_sim_disable`: (Optional) Set to `true` to disable and use set_point as the current temperature.
- `verbose`: (Optional) Set to `true` to enable additional debug logging. Default is `false`.
## Contributing
Ideas and bug reports are welcome. To assist:
1. Turn on "Verbose" logging in the plugin config under "Advanced Settings"
2. Run Homebridge in debug mode
```
Homebridge Settings -> Startup & Environment -> Homebridge Debug Mode -D
```
3. Capture the JSON responses in the Logs for HTTP and MQTT state changes
4. Submit the captured data via a GitHub [issue](https://github.com/mpatfield/homebridge-econet-rheem/issues/new/choose) or [pull request](https://github.com/mpatfield/homebridge-econet-rheem/pulls).
Your contributions will help enhance the plugin's functionality and device support.
## Credits
[](https://github.com/sponsors/w1ll1am23) for earlier work done in [pyeconet](https://github.com/w1ll1am23/pyeconet), a Python 3 interface to the EcoNet API
[](https://github.com/r3tr3ad) for helping debug the thermostat implementation.
[Keryan Belahcene](https://www.instagram.com/keryan.me) for creating the [Flume](https://github.com/homebridge-plugins/homebridge-flume) header logo which I adapted for this plugin
And to the amazing creators/contributors of [Homebridge](https://homebridge.io) who made this plugin possible!