From 63704f28d182aed82fa987191f8a1c8f910a65d8 Mon Sep 17 00:00:00 2001 From: "M.J. Wydra" Date: Wed, 18 Aug 2021 09:56:52 -0500 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 23c2e64..249d010 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # battery2mqtt *Push information about batteries in your system to MQTT* -I thought of this project when I switched to using my old laptop as my Home Assistant server. I wanted to track its battery level in Home Assistant to use in automations. I'm very new to Python, so I'm sure there's room for improvement here. +I thought of this project when I switched to using my old laptop as my Home Assistant server. Hopefully others can find it useful as well. # Summary `battery2mqtt` can monitor current battery percentage, charging status, etc. for any batteries present at `/sys/class/power_supply`. The MQTT topic format is `battery2mqtt/$TOPIC/$NAME` where `$TOPIC` is the topic you define and `$NAME` is the name of each battery. For example, if `/sys/class/power_supply/BAT0` is present in your system and you choose `server` to be the topic, the full topic will be `battery2mqtt/server/BAT0`.