keyword example - bellrichm/WeeWX-MQTTSubscribe GitHub Wiki
keyword examples
In this example there are 2 topics, first/topic
and second/topic
.
-
On
first/topic
the message consists of two keyword/value pairs,id
andtemp1
. Theid
value should be ignored. Thetemp1
value should be converted from Celsius to Farenheit and stored in WeeWX field,extraTemp1
. The message would look something like this.id=1,temp1=26.7
-
On
second/topic
the message consists of a single keyword/value,outTemp
. TheoutTemp
value does not need to be converted and should be stored in WeeWX field,outTemp
. The message would look something like this.{ outTemp=80 }
The configuration below accomplishes this. This example leverages MQTTSubscribe's default values. To see a more complete template see, https://github.com/bellrichm/WeeWX-MQTTSubscribe/blob/master/mqttsubscribe.example.conf.
Common options is a reference of the most common options.
[MQTTSubscribeService or MQTTSubscribeDriver]
# The driver to use.
# Only used by the driver.
driver = user.MQTTSubscribe
# Turn the service on and off.
# Default is true.
# Only used by the service.
enable = true
# The MQTT server.
# Default is: localhost
host = localhost
# The port to connect to.
# Default is: 1883
port = 1883
[topics](/bellrichm/WeeWX-MQTTSubscribe/wiki/topics)
# Configuration for the message callback.
[[message](/bellrichm/WeeWX-MQTTSubscribe/wiki/[message)]
# The format of the MQTT payload.
# Currently support: individual, json, keyword
# Must be specified.
type = keyword
# The first topic to subscribe to.
[[first/topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/[first/topic)]
# The incoming field name from MQTT.
[[[temp1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[[temp1)]]
# The WeeWX name.
# Default is the name from MQTT.
name = extraTemp1
# The units of the incoming data.
# Useful if this field's units differ from the topic's unit_system's units.
# Valid values: see, http://www.weewx.com/docs/customizing.htm#units
# Default is not set
units = degree_C
[[[id](/bellrichm/WeeWX-MQTTSubscribe/wiki/[[id)]]
# True if the incoming data should not be processed into WeeWX.
# Valid values: True, False
# Default is False
ignore = True
# The second topic to subscribe to
[[second/topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/[second/topic)]