config.example.yaml

---
# One of 'fatal', 'error', 'warn', 'info', 'debug', 'trace'
loglevel: info

outgoingMqttMessage:

  # The message type to publish over MQTT when receiving events from KNX
  # One of:
  #   value - the value with preserved type or as string representation if emitValueAsString is true
  #   value-with-unit - a string representation of the value including the unit (if any)
  #   bytes - the raw bytes as received from KNX
  #   json  - a json object containing the fields specified in includedJsonFields.
  type: json

  # Emit values using group address
  emitUsingAddress: true
  # Emit values using human readable group address names
  emitUsingName: true
  # Emit the value payload as string, if false, the type will be preserved.
  emitValueAsString: false

  # If true, do not pass on read commands from KNX to MQTT
  ignoreReadCommands: false

  # When sending MQTT messages as JSON, these values determines what should be included.
  includedJsonFields:
    # Include the field `address`, with Group Address
    address: true
    # Include the field `name`, containing the human readable name of the address
    name: true
    # Include the field `bytes`, with a base64 representation of the raw bytes
    bytes: true
    # Include the field `dpt`, with datapoint name
    dpt: true
    # Include the field `value`, containing the raw value or as string representation if emitValueAsString is true
    value: true
    # Include the field `unit`, containing the unit of the datatype (if any)
    unit: true

knx:
  # ETS exported group addresses
  etsExport: knx.xml

  # Address to the KNX gateway
  endpoint: 224.0.23.12:3671

  # When using router/multicast, to avoid setsock error address not available, you can specify on which interface enable multicast
  # Allows to specify which interface to use for multicast. Can be useful to overcome e.g. setsock error: address not available
  # interface: en1

  # If true, connect over tunnel/unicast, if false use router/multicast.
  tunnelMode: false

  # Ignore unknown group addresses
  ignoreUnknownGroupAddresses: false

  # Enables logging from the KNX library
  enableLogs: false

mqtt:
  # URL to MQTT broker
  #url: 'ssl://localhost:8883'
  url: 'tcp://localhost:1883'
  
  # Set a custom ID to use for the MQTT client
  # clientId: knx-mqtt
  
  #username: your username
  #password: your password

  # Set TLS configuration
  #tlsKey: /path/to/keyfile.key
  #tlsCert: /path/to/certificate.crt
  #tlsCa: /path/to/certificate-authority.crt

  # Prefix to MQTT topic
  topicPrefix: knx/
  # Set the QoS for published messages
  # 0 = at most once, 1 = at least once, 2 = exactly once
  qos: 0
  # Set retain flag on messages
  retain: false