Преглед на файлове

Describe config file, comment everything

Thomas Dietrich преди 8 години
родител
ревизия
97a5edeaf8
променени са 1 файла, в които са добавени 34 реда и са изтрити 8 реда
  1. 34 8
      config.ini

+ 34 - 8
config.ini

@@ -1,20 +1,46 @@
+# Configuration file for Xiaomi Mi Flora Plant Sensor MQTT Client/Daemon
+# Source: https://github.com/janwh/miflora-mqtt-daemon
+#
+# Uncomment and adapt all settings as needed.
 
 [Daemon]
+
+# Enable or Disable an endless execution loop (Default: true)
 #enabled = false
-period = 120
+
+# The period between two measurements in seconds (Default: 300)
+#period = 300
 
 [MQTT]
-hostname = localhost
-port = 1883
-keepalive = 60
-topic_prefix = miflora
+
+# The hostname or IP address of the MQTT broker to connect to (Default: localhost)
+#hostname = localhost
+
+# The TCP port the MQTT broker is listening on. SSL/TLS currently not implemented (Default: 1883)
+#port = 1883
+
+# Maximum period in seconds between ping messages to the broker. (Default: 60)
+#keepalive = 60
+
+# The MQTT base topic to publish all Mi Flora sensor data topics under (Default: miflora)
+#topic_prefix = miflora
+
+# The MQTT broker authentification credentials (Default: no authentication)
 #username = user
 #password = pwd123
 
 [MiFlora]
-cache_timeout = 600
+
+# DEPRECATED
+#cache_timeout = 600
 
 [Sensors]
-Feinblatt=C4:7C:8D:61:7E:0B
-Drachenbaum=C4:7C:8D:61:9D:8D
 
+# Add your Mi Flora sensors here. Each sensor consists of a name and a Ethernet MAC address.
+# One sensor per line. Scan for sensors from the command line with:
+#    $ sudo hcitool lescan
+#
+# Examples:
+#
+#Schefflera     = C4:7C:8D:11:22:33
+#JapaneseBonsai = C4:7C:8D:44:55:66