Просмотр исходного кода

Add mqtt-smarthome to readme, add authors, add config comment for base_topic (#9)

* reporting_method = mqtt-smarthome

* changes as discussed

* add mqtt-smarthome to readme, add authors, add config comment for base_topic
Sebastian Raff 8 лет назад
Родитель
Сommit
7c117ef447
3 измененных файлов с 7 добавлено и 3 удалено
  1. 2 1
      AUTHORS
  2. 4 1
      README.md
  3. 1 1
      config.ini.dist

+ 2 - 1
AUTHORS

@@ -1,3 +1,4 @@
 Jan Willhaus <mail@janwillhaus.de>
 Thomas Dietrich <thomas.dietrich@tu-ilmenau.de>
-
+Wolfgang Gaar
+Sebastian Raff <hq@ccu.io>

+ 4 - 1
README.md

@@ -15,7 +15,10 @@ The program can be executed in **daemon mode** to run continuously in the backgr
 * Build on top of [open-homeautomation/miflora](https://github.com/open-homeautomation/miflora)
 * Highly configurable
 * Data publication via MQTT
-* JSON encoded or following the [Homie Convention v2.0.5](https://github.com/marvinroger/homie)
+* Configurable topic and payload:
+    * JSON encoded
+    * following the [Homie Convention v2.0.5](https://github.com/marvinroger/homie)
+    * following the [mqtt-smarthome architecture proposal](https://github.com/mqtt-smarthome/mqtt-smarthome)
 * Announcement messages to support auto-discovery services
 * MQTT authentication support
 * No special/root privileges needed

+ 1 - 1
config.ini.dist

@@ -37,7 +37,7 @@
 #keepalive = 60
 
 # The MQTT base topic to publish all Mi Flora sensor data topics under.
-# Default depends on the configured reporting_mode (mqtt-json: miflora, mqtt-homie: homie)
+# Default depends on the configured reporting_mode (mqtt-json, mqtt-smarthome: miflora, mqtt-homie: homie)
 #base_topic = miflora
 #base_topic = homie