Hopeless-Automations/laptop2mqtt
1
0
Fork 0
forked from sthope/battery2mqtt
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add note about MQTT client

Browse Source
This commit is contained in:
M.J. Wydra
2021-08-18 01:00:44 -05:00
committed by GitHub
parent 2eb4e136e2
commit c11b4f064c
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

@@ -30,6 +30,7 @@ services:
- MQTT_PORT=1883 - MQTT_PORT=1883
- MQTT_USER=user - MQTT_USER=user
- MQTT_PASSWORD=password - MQTT_PASSWORD=password
- MQTT_CLIENT=serverbatt
- MQTT_TOPIC=server - MQTT_TOPIC=server
- MQTT_QOS=1 - MQTT_QOS=1
- INTERVAL=60 - INTERVAL=60
@@ -51,6 +52,7 @@ services:
| `MQTT_PORT` | `1883` | The port the MQTT broker is bound to. | | `MQTT_PORT` | `1883` | The port the MQTT broker is bound to. |
| `MQTT_USER` | `None` | The user to send to the MQTT broker. | | `MQTT_USER` | `None` | The user to send to the MQTT broker. |
| `MQTT_PASSWORD` | `None` | The password to send to the MQTT broker. | | `MQTT_PASSWORD` | `None` | The password to send to the MQTT broker. |
| `MQTT_CLIENT` | `battery2mqtt` | The client name for the MQTT connection. IMPORTANT: SEE BELOW |
| `MQTT_TOPIC` | `server` | The topic prefix to send the payload to. | | `MQTT_TOPIC` | `server` | The topic prefix to send the payload to. |
| `MQTT_QOS` | `1` | The MQTT QoS level. | | `MQTT_QOS` | `1` | The MQTT QoS level. |
| `INTERVAL` | `60` | How often (in seconds) battery2mqtt polls for battery info. | | `INTERVAL` | `60` | How often (in seconds) battery2mqtt polls for battery info. |
@@ -61,6 +63,9 @@ services:
| `AC_ADAPTER` | `0` | Enable/disable AC adapter status. Set to 1 to enable. | | `AC_ADAPTER` | `0` | Enable/disable AC adapter status. Set to 1 to enable. |
| `LOG_LEVEL` | `info` | Set minimum log level. Valid options are `debug`, `info`, `warning`, and `error`. | | `LOG_LEVEL` | `info` | Set minimum log level. Valid options are `debug`, `info`, `warning`, and `error`. |
# MQTT client
If you plan on using `battery2mqtt` on more than one machine, it is very important that you use a **different client name for each instance**; otherwise you _will_ experience issues with LWT.
# Monitored conditions # Monitored conditions
You can specify only those conditions that you'd like to track. The default is to track `status, capacity, energy_now, energy_full, energy_full_design, power_now, voltage_now`. You can add more conditions (found at `/sys/class/power_supply/$NAME`) or choose only those you want to track. The variable in your `docker-compose.yaml` must follow this comma-separated format: You can specify only those conditions that you'd like to track. The default is to track `status, capacity, energy_now, energy_full, energy_full_design, power_now, voltage_now`. You can add more conditions (found at `/sys/class/power_supply/$NAME`) or choose only those you want to track. The variable in your `docker-compose.yaml` must follow this comma-separated format: