From 08b7009e55251a61a4bd7eb6582fe08197084f1a Mon Sep 17 00:00:00 2001 From: "M.J. Wydra" Date: Fri, 6 Aug 2021 00:50:38 -0500 Subject: [PATCH 1/4] Add explanation of monitored conditions --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 9233c15..7007b01 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,20 @@ You can specify only those conditions that you'd like to track. The default is t ``` status,capacity,energy_now,energy_full,energy_full_design,power_now,voltage_now ``` +A summary of these conditions is below. +| Condition | Description | Unit | +|-----------|-------------|------| +| Status | Battery status (charging, discharging, full) | None | +| Capacity | Current battery percentage | % | +| Energy now | Current battery capacity | Wh (watt-hours) | +| Energy full | Battery capacity when full | Wh | +| Energy full design | Original battery capacity when full* | Wh | +| Power now | Current power consumption | W | +| Voltage now | Current battery voltage | V | +| Battery health | (See next section) | % | +| Time remaining | (See next section) | Hr | + +* Batteries lose capacity with each charge cycle. *Energy full* shows the actual current full capacity of the battery due to wear; *Energy full design* shows the capacity the battery was designed to hold when factory fresh. # Battery health and time remaining calculations The default is to also provide a battery health percentage calculation by dividing `energy_full` by `energy_full_design`. This can be disabled by setting `BATTERY_HEALTH` to `0` in your `docker-compose.yaml`. From 6b9fa5b401119f5d4776b2df6ac79067ce670f9a Mon Sep 17 00:00:00 2001 From: "M.J. Wydra" Date: Fri, 6 Aug 2021 00:55:56 -0500 Subject: [PATCH 2/4] Add explanation of monitored conditions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7007b01..a576389 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ A summary of these conditions is below. | Battery health | (See next section) | % | | Time remaining | (See next section) | Hr | -* Batteries lose capacity with each charge cycle. *Energy full* shows the actual current full capacity of the battery due to wear; *Energy full design* shows the capacity the battery was designed to hold when factory fresh. +* Batteries lose capacity with each charge cycle. *Energy full* shows the actual full capacity of the battery due to wear; *Energy full design* shows the capacity the battery was able to hold when factory fresh. # Battery health and time remaining calculations The default is to also provide a battery health percentage calculation by dividing `energy_full` by `energy_full_design`. This can be disabled by setting `BATTERY_HEALTH` to `0` in your `docker-compose.yaml`. From 81aacca48d431ba410d0d65308e2bd02454bca57 Mon Sep 17 00:00:00 2001 From: "M.J. Wydra" Date: Fri, 6 Aug 2021 00:57:02 -0500 Subject: [PATCH 3/4] Add explanation of monitored conditions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a576389..d3ce4ef 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ A summary of these conditions is below. | Battery health | (See next section) | % | | Time remaining | (See next section) | Hr | -* Batteries lose capacity with each charge cycle. *Energy full* shows the actual full capacity of the battery due to wear; *Energy full design* shows the capacity the battery was able to hold when factory fresh. +\* Batteries lose capacity with each charge cycle. *Energy full* shows the actual full capacity of the battery due to wear; *Energy full design* shows the capacity the battery was able to hold when factory fresh. # Battery health and time remaining calculations The default is to also provide a battery health percentage calculation by dividing `energy_full` by `energy_full_design`. This can be disabled by setting `BATTERY_HEALTH` to `0` in your `docker-compose.yaml`. From 4d7624f60be44da74e01a7753bfefc5f407ba3d2 Mon Sep 17 00:00:00 2001 From: "M.J. Wydra" Date: Fri, 6 Aug 2021 01:00:58 -0500 Subject: [PATCH 4/4] Add explanation of monitored conditions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d3ce4ef..0288ef9 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,6 @@ sensor: state_topic: &server_battery_topic "battery2mqtt/server/BAT0" value_template: "{{ value_json.capacity }}" unit_of_measurement: '%' - icon: 'mdi:battery' json_attributes_topic: *server_battery_topic + device_class: battery ```