Skip to main content

Configuration

Less than 1 minute

Configuration

Rfxcom2MQTT is configured using YAMLopen in new window based config.yaml file. The file have to be located in the data directory within your installation. The data directory and the config.yaml has to be writeable.

# Minimal configuration.yml example
mqtt:
  server: mqtt://localhost:1883
rfxcom:
  # Could be either USB port (/dev/ttyUSB0)
  usbport: /dev/ttyUSB0

CONVENTION

The dot-notation of a config-key like mqtt.server means server property within the mqtt section. All dot-notation references are absolute.

Environment variables

It is possible to override the values in config.yaml via environment variables. The name of the environment

In case you want to for example override:

rfxcom:
  usbport: zigbee2mqtt

set RFXCOM_USB_DEVICE to the desired value.

Environment variables available

Env varproperties
MQTT_PASSWORDmqtt.password
MQTT_USERNAMEmqtt.username
MQTT_SERVERmqtt.server
RFXCOM_USB_DEVICErfxcom.usbport