Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.knx Namespace Reference

Namespaces

 binary_sensor
 
 button
 
 climate
 
 config_flow
 
 const
 
 cover
 
 date
 
 datetime
 
 device
 
 device_trigger
 
 diagnostics
 
 entity
 
 expose
 
 fan
 
 light
 
 notify
 
 number
 
 project
 
 scene
 
 schema
 
 select
 
 sensor
 
 services
 
 storage
 
 switch
 
 telegrams
 
 text
 
 time
 
 trigger
 
 validation
 
 weather
 
 websocket
 

Classes

class  KNXModule
 

Functions

bool async_remove_config_entry_device (HomeAssistant hass, ConfigEntry config_entry, DeviceEntry device_entry)
 
None async_remove_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None async_update_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA
 
 Final
 

Detailed Description

Support KNX devices.

Function Documentation

◆ async_remove_config_entry_device()

bool homeassistant.components.knx.async_remove_config_entry_device ( HomeAssistant  hass,
ConfigEntry  config_entry,
DeviceEntry   device_entry 
)
Remove a config entry from a device.

Definition at line 241 of file __init__.py.

◆ async_remove_entry()

None homeassistant.components.knx.async_remove_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Remove a config entry.

Definition at line 221 of file __init__.py.

◆ async_setup()

bool homeassistant.components.knx.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Start the KNX integration.

Definition at line 134 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.knx.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Load a config entry.

Definition at line 144 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.knx.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unloading the KNX platforms.

Definition at line 186 of file __init__.py.

◆ async_update_entry()

None homeassistant.components.knx.async_update_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Update a given config entry.

Definition at line 216 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.knx._LOGGER = logging.getLogger(__name__)
private

Definition at line 98 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.knx.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.All(
4  vol.Schema(
5  {
6  **EventSchema.SCHEMA,
7  **ExposeSchema.platform_node(),
8  **BinarySensorSchema.platform_node(),
9  **ButtonSchema.platform_node(),
10  **ClimateSchema.platform_node(),
11  **CoverSchema.platform_node(),
12  **DateSchema.platform_node(),
13  **DateTimeSchema.platform_node(),
14  **FanSchema.platform_node(),
15  **LightSchema.platform_node(),
16  **NotifySchema.platform_node(),
17  **NumberSchema.platform_node(),
18  **SceneSchema.platform_node(),
19  **SelectSchema.platform_node(),
20  **SensorSchema.platform_node(),
21  **SwitchSchema.platform_node(),
22  **TextSchema.platform_node(),
23  **TimeSchema.platform_node(),
24  **WeatherSchema.platform_node(),
25  }
26  ),
27  )
28  },
29  extra=vol.ALLOW_EXTRA,
30 )

Definition at line 102 of file __init__.py.

◆ Final

homeassistant.components.knx.Final

Definition at line 100 of file __init__.py.