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

Functions

dict[str, Any] _entry_dict (FloorEntry entry)
 
bool async_setup (HomeAssistant hass)
 
None websocket_create_floor (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None websocket_delete_floor (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None websocket_list_floors (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None websocket_update_floor (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 

Detailed Description

Websocket API to interact with the floor registry.

Function Documentation

◆ _entry_dict()

dict[str, Any] homeassistant.components.config.floor_registry._entry_dict ( FloorEntry  entry)
private
Convert entry to API format.

Definition at line 131 of file floor_registry.py.

◆ async_setup()

bool homeassistant.components.config.floor_registry.async_setup ( HomeAssistant  hass)
Register the floor registry WS commands.

Definition at line 15 of file floor_registry.py.

◆ websocket_create_floor()

None homeassistant.components.config.floor_registry.websocket_create_floor ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]   msg 
)
Create floor command.

Definition at line 52 of file floor_registry.py.

◆ websocket_delete_floor()

None homeassistant.components.config.floor_registry.websocket_delete_floor ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]   msg 
)
Delete floor command.

Definition at line 82 of file floor_registry.py.

◆ websocket_list_floors()

None homeassistant.components.config.floor_registry.websocket_list_floors ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]   msg 
)
Handle list floors command.

Definition at line 30 of file floor_registry.py.

◆ websocket_update_floor()

None homeassistant.components.config.floor_registry.websocket_update_floor ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]   msg 
)
Handle update floor websocket command.

Definition at line 108 of file floor_registry.py.