Home Assistant Unofficial Reference 2024.12.1
websocket_api.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.components.zha.websocket_api.ClusterBinding
 

Namespaces

 homeassistant.components.zha.websocket_api
 

Functions

ClusterBinding homeassistant.components.zha.websocket_api._cv_cluster_binding (dict[str, Any] value)
 
GroupMemberReference homeassistant.components.zha.websocket_api._cv_group_member (dict[str, Any] value)
 
zigpy.backups.NetworkBackup homeassistant.components.zha.websocket_api._cv_zigpy_network_backup (dict[str, Any] value)
 
str|None homeassistant.components.zha.websocket_api._get_entity_name (Gateway zha_gateway, EntityReference entity_ref)
 
str|None homeassistant.components.zha.websocket_api._get_entity_original_name (Gateway zha_gateway, EntityReference entity_ref)
 
list[_T]|list[Any]|None homeassistant.components.zha.websocket_api._T (_T|None value)
 
None homeassistant.components.zha.websocket_api.async_binding_operation (Gateway zha_gateway, EUI64 source_ieee, EUI64 target_ieee, zdo_types.ZDOCmd operation)
 
None homeassistant.components.zha.websocket_api.async_load_api (HomeAssistant hass)
 
None homeassistant.components.zha.websocket_api.async_unload_api (HomeAssistant hass)
 
None homeassistant.components.zha.websocket_api.websocket_add_group (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_add_group_members (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_bind_devices (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_bind_group (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_change_channel (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_create_network_backup (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_device_cluster_attributes (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_device_cluster_commands (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_device_clusters (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_get_bindable_devices (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_get_configuration (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_get_device (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_get_devices (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_get_group (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_get_groupable_devices (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_get_groups (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_get_network_settings (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_list_network_backups (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_permit_devices (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_read_zigbee_cluster_attributes (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_reconfigure_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_remove_group_members (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_remove_groups (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_restore_network_backup (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_unbind_devices (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_unbind_group (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_update_topology (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zha.websocket_api.websocket_update_zha_configuration (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 

Variables

 homeassistant.components.zha.websocket_api._LOGGER = logging.getLogger(__name__)
 
string homeassistant.components.zha.websocket_api.ATTR_DURATION = "duration"
 
string homeassistant.components.zha.websocket_api.ATTR_GROUP = "group"
 
string homeassistant.components.zha.websocket_api.ATTR_IEEE_ADDRESS = "ieee_address"
 
string homeassistant.components.zha.websocket_api.ATTR_INSTALL_CODE = "install_code"
 
string homeassistant.components.zha.websocket_api.ATTR_NEW_CHANNEL = "new_channel"
 
string homeassistant.components.zha.websocket_api.ATTR_QR_CODE = "qr_code"
 
string homeassistant.components.zha.websocket_api.ATTR_SOURCE_IEEE = "source_ieee"
 
string homeassistant.components.zha.websocket_api.ATTR_TARGET_IEEE = "target_ieee"
 
string homeassistant.components.zha.websocket_api.BINDINGS = "bindings"
 
string homeassistant.components.zha.websocket_api.CLIENT = "client"
 
 homeassistant.components.zha.websocket_api.CLUSTER_BINDING_SCHEMA
 
string homeassistant.components.zha.websocket_api.DEVICE_INFO = "device_info"
 
 homeassistant.components.zha.websocket_api.GROUP_MEMBER_SCHEMA
 
string homeassistant.components.zha.websocket_api.ID = "id"
 
 homeassistant.components.zha.websocket_api.IEEE_SCHEMA = vol.All(cv.string, EUI64.convert)
 
string homeassistant.components.zha.websocket_api.IEEE_SERVICE = "ieee_based_service"
 
string homeassistant.components.zha.websocket_api.RESPONSE = "response"
 
string homeassistant.components.zha.websocket_api.SERVICE_DIRECT_ZIGBEE_BIND = "issue_direct_zigbee_bind"
 
string homeassistant.components.zha.websocket_api.SERVICE_DIRECT_ZIGBEE_UNBIND = "issue_direct_zigbee_unbind"
 
string homeassistant.components.zha.websocket_api.SERVICE_ISSUE_ZIGBEE_CLUSTER_COMMAND = "issue_zigbee_cluster_command"
 
string homeassistant.components.zha.websocket_api.SERVICE_ISSUE_ZIGBEE_GROUP_COMMAND = "issue_zigbee_group_command"
 
string homeassistant.components.zha.websocket_api.SERVICE_PERMIT = "permit"
 
string homeassistant.components.zha.websocket_api.SERVICE_REMOVE = "remove"
 
string homeassistant.components.zha.websocket_api.SERVICE_SET_ZIGBEE_CLUSTER_ATTRIBUTE = "set_zigbee_cluster_attribute"
 
string homeassistant.components.zha.websocket_api.SERVICE_WARNING_DEVICE_SQUAWK = "warning_device_squawk"
 
string homeassistant.components.zha.websocket_api.SERVICE_WARNING_DEVICE_WARN = "warning_device_warn"
 
string homeassistant.components.zha.websocket_api.SERVICE_ZIGBEE_BIND = "service_zigbee_bind"
 
string homeassistant.components.zha.websocket_api.TYPE = "type"
 
dictionary homeassistant.components.zha.websocket_api.ZHA_CONFIG_SCHEMAS