Switches are simple representations of binary actors. They mainly support switching on and off.
xknxis the XKNX object.
nameis the name of the object.
group_addressis the KNX group address of the switch device. Used for sending.
group_address_stateis the KNX group address of the switch state. Used for updating and reading state.
TrueGroupValueRead requests to the
group_addressare answered. Defaults to
sync_statedefines if and how often the value should be actively read from the bus. If
Falseno GroupValueRead telegrams will be sent to its group address. Defaults to
invertinverts the payload so state “on” is represented by 0 on bus and “off” by 1. Defaults to
reset_aftermay be used to reset the switch to
OFFagain after given time in sec. Defaults to
device_updated_cbawaitable callback for each update.
switch = Switch(xknx, 'TestOutlet', group_address='1/2/3') # Accessing switch via xknx.devices await xknx.devices['TestOutlet'].set_on() # Switching switch on await switch.set_on() # Switching switch off await switch.set_off() # Accessing switch via 'do' await switch.do('on') await switch.do('off') # Accessing state print(switch.state) # Requesting state via KNX GroupValueRead await switch.sync(wait_for_result=True)