README.md

automate-knx-plugin

The KNX plugin for the automate-home project.

Yaml examples of usage

Trigger and command for a simple presence light model.

- !Performer
  name: "trigger forced on/off"
  for appliance: "an indoor presence light"
  commands: [ ]
  triggers:
    - !knx_plugin.trigger.dpt_switch.On
      addresses: [ 0x0DE1, 0x0F41 ]
      events:
        - !home.appliance.light.event.forced.Event.On
    - !knx_plugin.trigger.dpt_switch.Off
      addresses: [ 0x0DE1, 0x0F41 ]
      events:
        - !home.appliance.light.event.forced.Event.Off

- !Performer
  name: "command on/off"
  for appliance: "an indoor presence light"
  commands:
    - !knx_plugin.command.dpt_switch.OnOff { addresses: [ 0x0DE1, 0x0F41 ] }
  triggers: [ ]

Trigger and command for a more complex indoor dimmerable light model.

- !Performer
  name: "trigger forced on/circadian rhythm/lux balancing/off"
  for appliance: "an indoor dimmerable light"
  commands: []
  triggers:
    - !knx_plugin.trigger.dpt_switch.On # forced on from on/off button 1 & 2
      addresses: [ 0x0F41, 0xF45, ]
      events:
        - !home.appliance.light.indoor.dimmerable.event.forced.Event.CircadianRhythm
    - !knx_plugin.trigger.dpt_switch.On # forced on from on/off button 3
      addresses: [ 0x0DD1, ]
      events:
        - !home.appliance.light.indoor.dimmerable.event.forced.Event.LuxBalance
    - !knx_plugin.trigger.dpt_scene_control.Activate # forced on from a scene button
      addresses: [ 0x0B07 ]
      number: 7
      events:
        - !home.appliance.light.indoor.dimmerable.event.forced.Event.On
    - !knx_plugin.trigger.dpt_switch.Off # forced off from button 1 or 2
      addresses: [ 0x0F41, 0x0F45, 0x0DD1, ]
      events:
        - !home.appliance.light.indoor.dimmerable.event.forced.Event.Off

- !Performer
  name: "command on/off and brightness"
  for appliance: "an indoor dimmerable light"
  commands:
    - !knx_plugin.command.dpt_switch.OnOff { addresses: [ 0x0DD1, ] }
    - !knx_plugin.command.dpt_brightness.Brightness { addresses: [ 0x0DD2, ] }
  triggers: [ ]

Documentation

• automate-home protocol commands/triggers chapter
• automate-knx-plugin documentation

Contributing

Pull requests are welcome!

License

The automate-knx-plugin is licensed under MIT.