diff options
author | Birte Kristina Friesel <derf@finalrewind.org> | 2024-11-24 19:32:03 +0100 |
---|---|---|
committer | Birte Kristina Friesel <derf@finalrewind.org> | 2024-11-24 19:32:03 +0100 |
commit | d33adf4c11d354f0e7da65a58a12c8aba01fd021 (patch) | |
tree | a9ce2a002e7f8bd85424a918a9a490cc059ce847 /README.md | |
parent | 6496658115a6aa1b9357e7bb48d4a82b1351f067 (diff) |
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 11 |
1 files changed, 6 insertions, 5 deletions
@@ -7,7 +7,7 @@ It can also publish readings to InfluxDB. ## Features * Display for CO₂ and temperature -* Home Assistant integration via MQTT +* Optional Home Assistant integration via MQTT * Optional logging to InfluxDB * Powered via USB @@ -60,8 +60,9 @@ station_cfg = {ssid = "foo", pwd = "bar"} ### MQTT -The only configurable entity is the hostname of the MQTT broker. The ESP8266 -will register itself as `homeassistant/sensor/esp8266_XXXXXX` with the last six +This setting is optional. Specify the hostname of an MQTT broker in order to +enable MQTT publishing and Home Assistant integration. The ESP8266 will +register itself as `homeassistant/sensor/esp8266_XXXXXX` with the last six digits representing its WiFi MAC address. ```lua @@ -73,10 +74,10 @@ mqtt_host = "mqtt.example.org" These settings are optional. Specify a URL and attributes in order to enable InfluxDB publishing. For instance, if measurements should be stored as `mh_z19,location=lounge` in the `sensors` database on -`https://influxdb.example.org`, the configuration is as follows. +`http://influxdb.example.org:8086`, the configuration is as follows. ```lua -influx_url = 'https://influxdb.example.org/write?db=sensors' +influx_url = 'http://influxdb.example.org:8086/write?db=sensors' influx_attr = ',location=lounge' ``` |