Skip to content

Commit

Permalink
doc: Add documentation about 'recorder' configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
Xavier Berger committed Nov 4, 2024
1 parent 806cb66 commit b4d2df8
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/ha_configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Home Assistant configuration

**Power meter** is reading energy exchanged with the grid every secondes.
By default, Home Assistant *recorder* is saving this information in its database.
To optimize data storage in Home Assistant, it's essential to configure databases appropriately.

* First **Identify the Target Sensor**
Power meter provides a sensor names `real_power`.
In your Home Assistant it should be prefixed with the name of your device and should then be identified with an id like `sensor.solarrouter_real_power`.
Check you sensor to adapt the configuration.

* Then **Create a `recorder` configuration for Home Assistant**
Add the following lines in your `configuration.yaml` to filter out `real_power` data:

```yaml
recorder:
exclude:
entities:
- sensor.solarrouter_real_power
```
!!! note "About recorder"
Home Assistant `recorder` is constantly saves data in database. Refer to [recorder configuration](https://www.home-assistant.io/integrations/recorder/) for details.


!!! warning "If you are uding InfluxDB"
If you are using InfluxDB, you should pay the same attention about data recording.
Refer to the [integration documentation](https://www.home-assistant.io/integrations/influxdb/) to exclude `real_power` from your database.


1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ nav:
- Triac: regulator_triac.md
- Relay: regulator_relay.md
- Engine: engine.md
- HA configuration: ha_configuration.md
- Contributing: contributing.md
- ChangeLog: changelog.md
- License: license.md
Expand Down

0 comments on commit b4d2df8

Please sign in to comment.