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

Add reference to Docker Hub

Browse Source
This commit is contained in:
M.J. Wydra (Jay)
2020-12-04 21:13:05 -06:00
committed by GitHub
parent 9642f1ad29
commit 5ef84f99b3
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -7,6 +7,11 @@ I thought of this project when I switched to using my old laptop as my Home Assi
`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`. `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`.
# Instructions # Instructions
**Option 1: Pull from Docker Hub**
`docker pull tediore/battery2mqtt:latest`
**Option 2: Manual build**
1. Clone repo: `git clone https://github.com/Tediore/battery2mqtt` 1. Clone repo: `git clone https://github.com/Tediore/battery2mqtt`
2. Enter directory: `cd battery2mqtt` 2. Enter directory: `cd battery2mqtt`
3. Build image: `docker build . -t battery2mqtt` 3. Build image: `docker build . -t battery2mqtt`