clarified usage of topic wildcard in examples/doc

hikhvar · Sep 1, 2020 · a9e61fe · a9e61fe
1 parent 0d8d9e3
commit a9e61fe
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/Readme.md b/Readme.md
@@ -86,7 +86,7 @@ The config file can look like this:
 mqtt:
   # The MQTT broker to connect to
   server: tcp://127.0.0.1:1883
-  # The Topic path to subscripe to. Be aware that you have to specify the wildcard. 
+  # The Topic path to subscribe to. Be aware that you have to specify the wildcard. 
   topic_path: v1/devices/me/+
   # Optional: Regular expression to extract the device ID from the topic path. The default regular expression, assumes
   # that the last "element" of the topic_path is the device id.

diff --git a/config.yaml.dist b/config.yaml.dist
@@ -5,7 +5,7 @@ mqtt:
   # Optional: Username and Password for authenticating with the MQTT Server
   # user: bob
   # password: happylittleclouds
-  # The Topic path to subscripe to.
+  # The Topic path to subscribe to. Be aware that you have to specify the wildcard.
   topic_path: v1/devices/me/+
   # Optional: Regular expression to extract the device ID from the topic path. The default regular expression, assumes
   # that the last "element" of the topic_path is the device id.

diff --git a/examples/gosund_sp111.yaml b/examples/gosund_sp111.yaml
@@ -5,7 +5,7 @@ mqtt:
   # Optional: Username and Password for authenticating with the MQTT Server
   # user: bob
   # password: happylittleclouds
-  # The Topic path to subscripe to. Actually this will become `$topic_path/+`
+  # The Topic path to subscribe to. Be aware that you have to specify the wildcard.
   topic_path: tele/+/SENSOR
   # Optional: Regular expression to extract the device ID from the topic path. The default regular expression, assumes
   # that the last "element" of the topic_path is the device id.

diff --git a/hack/mqtt2prometheus.yaml b/hack/mqtt2prometheus.yaml
@@ -5,8 +5,8 @@ mqtt:
   # Optional: Username and Password for authenticating with the MQTT Server
   # user: bob
   # password: happylittleclouds
-  # The Topic path to subscripe to. Actually this will become `$topic_path/+`
-  topic_path: v1/devices/me
+  # The Topic path to subscribe to. Be aware that you have to specify the wildcard.
+  topic_path: v1/devices/me/+
   # The MQTT QoS level
   qos: 0
 cache: