Configure MQTTSubscribe

Note, this function was intoduced in MQTTSubscribe version 3.0.

The MQTTSubscribe configure mode provides functions to make it easier to configure MQTTSubscribe. It also provides functions to validate and test the configuration without having to update a running WeeWX instance.

Environment setup

Set the mode that MQTTSubscribe will be running in

If running as a driver,

RUN_MODE=driver

If running as a service,

RUN_MODE=service

For pip and git installs - activate the environment

source ~/weewx-venv/bin/activate

Set the file locations

For pip installs

WEEWX_ROOT=~/weewx-data
export USER_ROOT=$WEEWX_ROOT/bin/user
CONFIG_FILE=$WEEWX_ROOT/weewx.conf
WEECTL=weectl

For package installs

WEEWX_ROOT=/etc/weewx/
export BIN_ROOT=/usr/share/weewx/
export USER_ROOT=$WEEWX_ROOT/bin/user
CONFIG_FILE=$WEEWX_ROOT/weewx.conf
WEECTL=weectl

For git 'installs'

WEEWX_REPO=~/weewx
WEEWX_ROOT=~/weewx-data
export BIN_ROOT=$WEEWX_REPO/src
export USER_ROOT=$WEEWX_ROOT/bin/user
CONFIG_FILE=$WEEWX_ROOT/weewx.conf
WEECTL=$WEEWX_REPO/bin/weectl

Invocation

```
python3 $USER_ROOT/MQTTSubscribe.py configure $RUN_MODE --help 
```

Options

--add-from ADD_FROM

The configuration that will and add to (but not update existing settings) the configuration specified with --conf.

For example, the configuration specified with --conf is:

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1a
    [[field-2](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-2)]

And the configuration in ADD_FRON is

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1b
    [[field-3](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-3)]

The resulting configuration will be

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1a
    [[field-2](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-2)]
    [[field-3](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-3)]

--conf CONF

The WeeWX configuration file. Typically weewx.conf.

--export EXPORT_CONF

Export the configuration in EXPORT_CONF.

--no-backup

When updating the configuration specified with --conf, do not back it up.

--output OUTPUT

Instead of updating the WeeWX configuration the configuration specified with --conf write it to OUTPUT.

--print-configspec PRINT_CONFIGSPEC

Write the configspec to a file.

--replace-with REPLACE_WITH

The configuration that will replace the configuration specified with --conf.

For example, if the configuration specified with --conf is:

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1a
    [[field-2](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-2)]

And the configuration in REPLACE_WITH is

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1b
    [[field-3](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-3)]

The resulting configuration will be

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1b
    [[field-3](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-3)]

--remove

Remove the configuration from the configuration specified with --conf.

--update-from UPDATE_FROM

The configuration that will update and add to the configuration specified with --conf.

For example, if the configuration specified with --conf is:

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1a
    [[field-2](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-2)]

And the configuration in UPDATE_FROM is

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1b
    [[field-3](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-3)]

The resulting configuration will be

[topic](/bellrichm/WeeWX-MQTTSubscribe/wiki/topic)
    [[field-1](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-1)]
        name = rename-1b
    [[field-2](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-2)]
    [[field-3](/bellrichm/WeeWX-MQTTSubscribe/wiki/[field-3)]

--top-level

Use the complete input configuration as the MQTTSubscribeDriver/MQTTSubscribeService configuration section.

--validate

Validate the configuration specified with --conf.