Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.knx.KNXModule Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigType config, ConfigEntry entry)
 
ConnectionConfig connection_config (self)
 
None connection_state_changed_cb (self, XknxConnectionState state)
 
TelegramQueue.Callback register_event_callback (self)
 
None start (self)
 
None stop (self, Event|None event=None)
 
None telegram_received_cb (self, Telegram telegram)
 

Public Attributes

 config_store
 
 config_yaml
 
 connected
 
 entry
 
 hass
 
 interface_device
 
 project
 
 telegrams
 
 xknx
 

Detailed Description

Representation of KNX Object.

Definition at line 257 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.knx.KNXModule.__init__ (   self,
HomeAssistant  hass,
ConfigType  config,
ConfigEntry   entry 
)
Initialize KNX module.

Definition at line 260 of file __init__.py.

Member Function Documentation

◆ connection_config()

ConnectionConfig homeassistant.components.knx.KNXModule.connection_config (   self)
Return the connection_config.

Definition at line 314 of file __init__.py.

◆ connection_state_changed_cb()

None homeassistant.components.knx.KNXModule.connection_state_changed_cb (   self,
XknxConnectionState  state 
)
Call invoked after a KNX connection state change was received.

Definition at line 411 of file __init__.py.

◆ register_event_callback()

TelegramQueue.Callback homeassistant.components.knx.KNXModule.register_event_callback (   self)
Register callback for knx_event within XKNX TelegramQueue.

Definition at line 466 of file __init__.py.

◆ start()

None homeassistant.components.knx.KNXModule.start (   self)
Start XKNX object. Connect to tunneling or Routing device.

Definition at line 302 of file __init__.py.

◆ stop()

None homeassistant.components.knx.KNXModule.stop (   self,
Event | None   event = None 
)
Stop XKNX object. Disconnect from tunneling or Routing device.

Definition at line 309 of file __init__.py.

◆ telegram_received_cb()

None homeassistant.components.knx.KNXModule.telegram_received_cb (   self,
Telegram  telegram 
)
Call invoked after a KNX telegram was received.

Definition at line 417 of file __init__.py.

Member Data Documentation

◆ config_store

homeassistant.components.knx.KNXModule.config_store

Definition at line 272 of file __init__.py.

◆ config_yaml

homeassistant.components.knx.KNXModule.config_yaml

Definition at line 265 of file __init__.py.

◆ connected

homeassistant.components.knx.KNXModule.connected

Definition at line 266 of file __init__.py.

◆ entry

homeassistant.components.knx.KNXModule.entry

Definition at line 269 of file __init__.py.

◆ hass

homeassistant.components.knx.KNXModule.hass

Definition at line 264 of file __init__.py.

◆ interface_device

homeassistant.components.knx.KNXModule.interface_device

Definition at line 289 of file __init__.py.

◆ project

homeassistant.components.knx.KNXModule.project

Definition at line 271 of file __init__.py.

◆ telegrams

homeassistant.components.knx.KNXModule.telegrams

Definition at line 283 of file __init__.py.

◆ xknx

homeassistant.components.knx.KNXModule.xknx

Definition at line 274 of file __init__.py.


The documentation for this class was generated from the following file: