-
Notifications
You must be signed in to change notification settings - Fork 13
Experimental Options
These may change or go away.
This configures the MQTT connection and any necessary WeeWX options.
The WeeWX archive interval. Only used when the archive_topic is set and MQTTSubscribe is running in ‘hardware generation’ mode. The default is ‘300’.
Payload in this topic is processed like an archive record.
This means that MQTTSubscribe is running in ‘hardware generation’ mode. The default is None. This is only used by the driver.
In addition to any WeeWX logging setup, MQTTSubscribe will also log to the console. The default is None.
In addition to any WeeWX logging setup, MQTTSubscribe will also log to the specified filename. The default is None.
Overrides the WeeWX ‘debug’ setting. Valid values are Python’s logging levels, CRITICAL, ERROR, WARNING, INFO, DEBUG, and NOTSET.
An additional value TRACE is also supported. This logs even more detail than DEBUG. The default value is NOTSET.
But in this case NOTSET means to use the WeeWX ‘debug’ setting.
Coming soon.
When no loop packet has been generated in max_loop_interval, MQTTSubscribeDriver will generate an 'empty' packet. This can be useful to ensure that archive processing regulary happens when the MQTT payload arrives very irregularly. Only used by the driver. The default is 0 (off).
Experimental option to specify different message parsers.
With the exception of wind data, by default a packet is created for every MQTT message received. When this is true, MQTTSubscribe attempts to collect observations across messages into a packet. Default is False.
By default wind data is collected together across generation of loop packets. Setting to false results in the data only being collected together within a loop packet. Default is True.
With the exception of wind data, by default a queue is created for every MQTT topic. When this is true, MQTTSubsribe uses a single queue for all non wind data. This is useful when 'collect_observations = True'. Default is False.
When true, the last segment of the topic is used as the fieldname. Only used for individual payloads. Default is False.
Used to configure additional observations and units for WeeWX to use. See, https://weewx.com/docs/5.0/custom/units/#creating-a-new-unit-group This assumes a good knowledge of customizing WeeWX. An example can be found here.
Used to designate the unit_group the observation belongs to.
For example, observation-name = unit-group-name
The formatting for this unit.
The unit group this unit belongs to.
The label for this unit.
The unit system this unit belongs to.
The formula to use to convert to this unit.
For example, to-unit-name = function to convert from unit to to-unit
Getting Help
Feel free to open an issue, start a discussion in github, or post on WeeWX google group. When doing so, see Help! Posting to weewx user for information on capturing the log.
Getting Started
Prerequisites
Required MQTT information
Required WeeWX information
Installing MQTTSubscribe
Configuring MQTTSubscribe
Running MQTTSubscribe with WeeWX
Debugging
Common Options
Main section
The [[topics]] section
The [[[message]]] section
The [[[topic-name]]] section
The [[[[field-name]]]] section
Additional Options
Main section
The [[tls]] section
The [[topics]] section
The [[[topic-name]]] section
The [[[[field-name]]]] section
Example individual Configuration
Example Configuration with multiple types