Skip to content

Configuration

Jump to bottom
anotherjulien edited this page Feb 17, 2023 · 6 revisions

Once your gateway is integrated in Home-Assistant, you can start adding your different devices.
This configuration needs to take place in the /config/myhome.yaml file. (This means the file is in the same folder as your main Home-Assistant configuration.yaml)

General structure

The overall file is structured as follows:

f454:
  mac: '00:03:50:xx:xx:xx'
  light:
    [...]
  switch:
    [...]
  cover:
    [...]
  climate:
    [...]
  binary_sensor:
    [...]
  sensor:
    [...]
mh202:
  mac: '00:03:50:xx:xx:xx'
  light:
    [...]
  switch:
    [...]
  cover:
    [...]
  climate:
    [...]
  binary_sensor:
    [...]
  sensor:
    [...]

The topmost item in the hierarchy (f454 and mh202 in the above example) is a string to help you identify the gateways in the configuration, their value has no impact on the functioning of the integration.
It is absolutely mandatory and critical that you supply your gateway's correct MAC address, as this is what is used as an identifier and will link the devices in the config to your gateway in Home-Assistant.

Each platform (light, cover, climate, etc...) then follows a similar structure detailed below.
A somewhat complete sample config can be found here

Devices structure

For each device, under each platform, the structure will be similar. Some of the items in the structure are common amongst (almost) all device types:

    <configuration_identifier>:
      who: <str>
      where: <str>
      interface: <str>
      name: <str>
      manufacturer: <str>
      model: <str>

First, the <configuration_identifier>, is a string representing the device, to help you locate it and make sense of the config file, just as the gateway at the top level, its value is not used in the integration.

  • who is generally optional, since only one value is admissible for most device types, only sensor and binary_sensor will accept different values depending on the sensor type.
  • where is mandatory and is the OpenWebNet address of your device (the 'APL'). By OpenWebNet standard, it needs to be either 2 or 4 digits if you used virtual configuration and went beyond the "usual" numbering. It can never be 3 as the bus could not tell if 010 would be "A=01, PL=0" or "A=0, PL=10" for instance.
  • interface is the optional 2 digits Bus interface ID when you use a F422 BUS-BUS Interface (such as the OpenWebNet message address would be <where>#4#<interface>). It is only available for light, switch and cover (WHO 1 and 2 as per OpenWebNet documentation)
  • name is a required "friendly name", this is what will be used as the name of your device and derived entities in Home-Assistant
  • manufacturer and model are optional and purely cosmetic (as they are reported in the device detail in Home-Assistant's interface).

Platforms

For clarity, the configuration details and examples for each platform have been separated on different pages:

Clone this wiki locally