Skip to content

Configuration of endpoints

Micha edited this page Apr 30, 2021 · 1 revision

Physical device and attribute configurations

The definition of all physical devices and attributes independent of their appliance type is listed under the attributes section, each physical device or attribute representing one YAML block item. The corresponding appliance ID (e.g. modbusApplID, zigbeeApplID) links the physical device or attribute to the corresponding appliance.

General configuration components

Some components (can be also called YAML block items) are shared across appliance types:

Component Purpose Reference
name (obligatory) String explanation of attribute, mainly for YAML readability as well as logging purpose --
knxAddr (obligatory) KNX address in XXX/YYY/ZZZ representation; for all KNX write actions (e.g. modbus2knx) this defines the target the value shall be written to, for all KNX read actions (e.g. knx2knx) this defines the source the value shall be retrieved from --
knxFormat (obligatory) DPT representation which defines how the KNX bus expects the value to be represented / value from the KNX bus shall be interpreted. The DPT is supposed to defined in the full DPT value definition, e.g. "14.077", "1.002". Carefully check the DPT type expected for the specific scenarios, e.g. some vendor write "1.001" Switch Value with corresponding values "On"/"Off" while actually expecting "1.002" Boolean Value with corresponding values "True"/"False". KNX DPT Definition
updFreq (obligatory for some appliance types) Defines the time interval the value shall be checked for changes; this applies to appliances which are polled only (e.g. ZigBee, ModBus) --
function (optional) Set of transformations that can be performed before the value is written to its destination. Functions implementation docu

Introduction

Model your devices

Credits

Clone this wiki locally