enocean-mqtt-bridge.yaml.sample

# configuration in YAML style!
#
# Take care of quotes '". It makes the difference between number and text.
#
# only available via command line interface are the followings options
# - conf_file
# - log_print
# - systemd


main:
  # "-p" (== --print) makes logging obsolet (espcically if you running a systemd service)
  # log_file:             "./enocean_mqtt_bridge.log"
  log_level:              "debug"  # values: debug, info, warning, error
  # log_max_bytes:        1048576  # default
  # log_max_count:        10       # default

  # check USB port with `lsusb` and `dmesg | grep -i "usb"`
  enocean_port:           "/dev/ttyUSB0"

  # see https://pypi.org/project/paho-mqtt/
  mqtt_client_id:         "(hostname)-enomqtt-bridge"
  mqtt_host:              "<your_server>"
  mqtt_port:              1883  # integer
  # mqtt_keepalive:       60  # integer
  # mqtt_protocol:        4  # 3==MQTTv31, (default:) 4==MQTTv311, 5==default/MQTTv5,
  # mqtt_ssl_ca_certs:    "/etc/mosquitto/certs/ca.crt"
  # mqtt_insecure_ssl:    True
  # mqtt_user_name:       "<your_user_name>"
  # mqtt_user_pwd:        "<your_password>"


# copy device settings template; not interpreted directly! (see YAML features)
device-default: &device-default
  mqtt_last_will:         '{"VALUE": "OFFLINE", "INFO": "last will"}'
  mqtt_retain:            True  # should MQTT broker store message
  mqtt_time_offline:      1200  # integer; time in seconds, after which *this client* sends the last will!


devices:

  # define (unique) device name
  winhandle-office:
    enocean_id:           0x0123456a
    mqtt_channel_state:   "smarthome/enocean/winhandle-office"
    # mqtt_qos:           1  # == default (integer)

    # secific to "Eltako FFG7B-rw" devices; creates JSON
    # tranform states to: OPEN, CLOSED, TILTED, OFFLINE, ERROR
    device_type:          "EltakoFFG7B"
    # device_type:        "Sniffer"  # log out as it is

    storage_file:         ./__work__/storage-winhandle-office.yaml

    # see EnOcean Equipment Profiles (EEP) or https://github.com/kipe/enocean
    # here F6-10-00 windows handle
    enocean_rorg:         0xf6
    enocean_func:         0x10
    enocean_type:         0x00

    # copy default settings here. see YAML features!
    <<: *device-default

  dimmer-fud61:
    enocean_target:       0x0123456a
    enocean_sender:       0x0123456a  # choose yourself: base id + x
    device_type:          "EltakoFud61"
    mqtt_channel_state:   "smarthome/enocean/light1/state"
    mqtt_retain:          False
    mqtt_channel_cmd:     "smarthome/enocean/light1/cmd

  switch-fsr61:
    enocean_target:       0x0123456a
    enocean_sender:       0x0123456a  # choose yourself: base id + x
    device_type:          "EltakoFsr61"
    mqtt_channel_state:   "smarthome/enocean/light2/state"
    mqtt_retain:          False
    mqtt_channel_cmd:     "smarthome/enocean/light2/cmd