Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.config.area_registry Namespace Reference

Functions

bool async_setup (HomeAssistant hass)
 
None websocket_create_area (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_delete_area (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_list_areas (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_update_area (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 

Detailed Description

HTTP views to interact with the area registry.

Function Documentation

◆ async_setup()

bool homeassistant.components.config.area_registry.async_setup ( HomeAssistant  hass)
Enable the Area Registry views.

Definition at line 15 of file area_registry.py.

◆ websocket_create_area()

None homeassistant.components.config.area_registry.websocket_create_area ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Create area command.

Definition at line 52 of file area_registry.py.

◆ websocket_delete_area()

None homeassistant.components.config.area_registry.websocket_delete_area ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Delete area command.

Definition at line 88 of file area_registry.py.

◆ websocket_list_areas()

None homeassistant.components.config.area_registry.websocket_list_areas ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Handle list areas command.

Definition at line 26 of file area_registry.py.

◆ websocket_update_area()

None homeassistant.components.config.area_registry.websocket_update_area ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Handle update area websocket command.

Definition at line 118 of file area_registry.py.