Configuring experimental options

These may change or go away.

The [MQTTSubscribeDriver]/[MQTTSubscribeSection] section

This configures the MQTT connection and any necessary WeeWX options.

archive_interval

The WeeWX archive interval. Only used when the archive_topic is set and MQTTSubscribe is running in ‘hardware generation’ mode. The default is ‘300’.

archive_topic

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.

console

In addition to any WeeWX logging setup, MQTTSubscribe will also log to the console. The default is None.

logging_filename

In addition to any WeeWX logging setup, MQTTSubscribe will also log to the specified filename. The default is None.

logging_level

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.

max_loop_interval

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).

message_callback_provider

Experimental option to specify different message parsers.

The [topics](/bellrichm/WeeWX-MQTTSubscribe/wiki/topics) section

collect_observations = False

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.

collect_wind_across_loops = True

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.

single_queue = False

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.

The [[topic-name](/bellrichm/WeeWX-MQTTSubscribe/wiki/[topic-name)] sections

topic_tail_is_fieldname = False

When true, the last segment of the topic is used as the fieldname. Only used for individual payloads. Default is False.

The [weewx](/bellrichm/WeeWX-MQTTSubscribe/wiki/weewx) section

Used to configure additional observations and units for WeeWX to use. See, http://weewx.com/docs/customizing.htm#Creating_a_new_unit_group This assumes a good knowledge of customizing WeeWX. An example can be found here.

The [[observations](/bellrichm/WeeWX-MQTTSubscribe/wiki/[observations)] section

observation-name

Used to designate the unit_group the observation belongs to. For example, observation-name = unit-group-name

The [[units](/bellrichm/WeeWX-MQTTSubscribe/wiki/[units)] section

For each [[[unit-name](/bellrichm/WeeWX-MQTTSubscribe/wiki/[[unit-name)]] section

format

The formatting for this unit.

group

The unit group this unit belongs to.

label

The label for this unit.

unit_system

The unit system this unit belongs to.

[[[[conversion](/bellrichm/WeeWX-MQTTSubscribe/wiki/[[[conversion)]]] section

to-unit-name

The formula to use to convert to this unit. For example, to-unit-name = function to convert from unit to to-unit