Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: minor fix for how powerline connectivity behaviour #42

Merged
merged 1 commit into from
May 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ While this integration does not allow you to do anything which the app lets you

- Hot water temperature will vary depending on how close/ far the outlet you are using is. Your installer should have tested the temperature at the closest outlet to the heater (but my installer didn't do this).
- There are internal dip switches inside your water heater that offset the read temperature by +/-3C. This means that a setting of 50C may actually be 53C (which is outside the guidelines). The installer manual is available online.
- I strongly recommend setting up an automation to restore your water heater to a default low setting to avoid the risk of inadvertent burns/ scalding. Remember, not everyone in your house knows that you have set the hot water to piping hot (and this may especially be an issue with young children or the elderly).
- I strongly recommend setting up an automation to restore your water heater to a default low setting to avoid the risk of inadvertent burns/scalding. Remember, not everyone in your house knows that you have set the hot water to piping hot (and this may especially be an issue with young children or the elderly).

**This integration will set up the following entities.**

Expand All @@ -32,7 +32,7 @@ While this integration does not allow you to do anything which the app lets you
| entity name prefixes | | All entity names will be prefixed with the heaterName read from your device. This defaults to "Rheem" however you can use the app to change it to any 8 character alphanumeric identifier you want. |
| `water_heater.water_heater` | True | Controls the water heater. It reads the min, current and max temps from your water heater. It also supports setting the target temperature to your desired value. |
| `binary_sensor.heater_error` | True | Will be off for no error and on for an error. The error code will be provided in sensor.error_code (it is not known at this time what the possible codes are) |
| `binary_sensory.connectivity_problem` | True | Because of the wireless connection between the powerline unit and the module in your water heater, connectivity typically drops out multiple times per day. A connectivity problem is only raised in the event 5 successive requests fail. |
| `binary_sensory.connectivity_problem` | True | Because of the noisy nature of powerline comms, connectivity between the unit and powerline adapter can be easily degraded. For best results, ensure that the heater and powerline unit are plugged into the same power circuit. A connectivity problem is only raised in the event 5 successive requests fail. |
| `sensor.flow` | True | The current flow rate of the water heater in L/min as reported by the water heater. |
| `sensor.status` | True | The current status of the water heater. Possible modes are: Idle, Heating, Bath Fill Complete (Off) |
| `sensor.mode` | True | The current mode of the water heater. Possible modes are: Idle, Heating Control Mode, Heating (Conventional Mode), Idle (Bath Fill Mode Waiting for Tap), Heating (Bath Fill Mode), Idle (Bath Fill Mode Complete) |
Expand Down Expand Up @@ -63,7 +63,7 @@ While this integration does not allow you to do anything which the app lets you

## Configuration is done in the UI

By default the sensors update every 5s. You can change this in the options, but be warned, if you perform too many requests per second your device will assume its under a DoS attack and refuse all connections. If your device has a poor connection i.e. heater and powerline unit are too far apart you may need to reduce this number - a symptom of this will be the ability to initially connect but not getting updated data over time.
By default the sensors update every 5s. You can change this in the options, but be warned, if you perform too many requests per second your device will assume its under a DoS attack and refuse all connections. If your device has a poor connection (i.e. heater and powerline unit aren't on the same power circuit) you may need to reduce this number - a symptom of this will be the ability to initially connect but not getting updated data over time.

## Contributions are welcome!

Expand Down