sthope/battery2mqtt
1
0
Fork 1
mirror of https://github.com/Tediore/battery2mqtt.git synced 2025-11-04 04:46:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' of github.com:Tediore/battery2mqtt into main

Browse Source
This commit is contained in:
Tediore
2021-08-16 15:08:15 -05:00
parent 61109f7887 4d7624f60b
commit 3f314a15d8
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -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 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 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 # 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`. 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`.
@@ -76,6 +90,6 @@ sensor:
state_topic: &server_battery_topic "battery2mqtt/server/BAT0" state_topic: &server_battery_topic "battery2mqtt/server/BAT0"
value_template: "{{ value_json.capacity }}" value_template: "{{ value_json.capacity }}"
unit_of_measurement: '%' unit_of_measurement: '%'
icon: 'mdi:battery'
json_attributes_topic: *server_battery_topic json_attributes_topic: *server_battery_topic
device_class: battery
``` ```