Home Assistant Unofficial Reference 2024.12.1
helpers.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.components.zha.helpers.EntityData
 
class  homeassistant.components.zha.helpers.EntityReference
 
class  homeassistant.components.zha.helpers.GroupEntityReference
 
class  homeassistant.components.zha.helpers.HAZHAData
 
class  homeassistant.components.zha.helpers.LogRelayHandler
 
class  homeassistant.components.zha.helpers.ZHADeviceProxy
 
class  homeassistant.components.zha.helpers.ZHAGatewayProxy
 
class  homeassistant.components.zha.helpers.ZHAGroupProxy
 

Namespaces

 homeassistant.components.zha.helpers
 

Functions

str homeassistant.components.zha.helpers._clean_serial_port_path (str path)
 
def homeassistant.components.zha.helpers._EntityT
 
None homeassistant.components.zha.helpers.async_add_entities (AddEntitiesCallback _async_add_entities, type[ZHAEntity] entity_class, list[EntityData] entities, **kwargs)
 
dict[str, int] homeassistant.components.zha.helpers.async_capture_log_levels ()
 
def homeassistant.components.zha.helpers.async_cluster_exists (HomeAssistant hass, cluster_id, skip_coordinator=True)
 
ZHADeviceProxy homeassistant.components.zha.helpers.async_get_zha_device_proxy (HomeAssistant hass, str device_id)
 
None homeassistant.components.zha.helpers.async_set_logger_levels (dict[str, int] levels)
 
vol.Schema homeassistant.components.zha.helpers.cluster_command_schema_to_vol_schema (CommandSchema schema)
 
dict[str, Any] homeassistant.components.zha.helpers.convert_to_zcl_values (dict[str, Any] fields, CommandSchema schema)
 
ZHAData homeassistant.components.zha.helpers.create_zha_config (HomeAssistant hass, HAZHAData ha_zha_data)
 
dict[str, Any] homeassistant.components.zha.helpers.exclude_none_values (Mapping[str, Any] obj)
 
ConfigEntry homeassistant.components.zha.helpers.get_config_entry (HomeAssistant hass)
 
HAZHAData homeassistant.components.zha.helpers.get_zha_data (HomeAssistant hass)
 
Gateway homeassistant.components.zha.helpers.get_zha_gateway (HomeAssistant hass)
 
ZHAGatewayProxy homeassistant.components.zha.helpers.get_zha_gateway_proxy (HomeAssistant hass)
 
Any homeassistant.components.zha.helpers.schema_type_to_vol (Any field_type)
 

Variables

 homeassistant.components.zha.helpers._LogFilterType
 
 homeassistant.components.zha.helpers._LOGGER = logging.getLogger(__name__)
 
 homeassistant.components.zha.helpers.CONF_ZHA_ALARM_SCHEMA
 
 homeassistant.components.zha.helpers.CONF_ZHA_OPTIONS_SCHEMA
 
string homeassistant.components.zha.helpers.DEBUG_COMP_BELLOWS = "bellows"
 
string homeassistant.components.zha.helpers.DEBUG_COMP_ZHA = "homeassistant.components.zha"
 
string homeassistant.components.zha.helpers.DEBUG_COMP_ZIGPY = "zigpy"
 
string homeassistant.components.zha.helpers.DEBUG_COMP_ZIGPY_DECONZ = "zigpy_deconz"
 
string homeassistant.components.zha.helpers.DEBUG_COMP_ZIGPY_XBEE = "zigpy_xbee"
 
string homeassistant.components.zha.helpers.DEBUG_COMP_ZIGPY_ZIGATE = "zigpy_zigate"
 
string homeassistant.components.zha.helpers.DEBUG_COMP_ZIGPY_ZNP = "zigpy_znp"
 
string homeassistant.components.zha.helpers.DEBUG_LEVEL_CURRENT = "current"
 
string homeassistant.components.zha.helpers.DEBUG_LEVEL_ORIGINAL = "original"
 
dictionary homeassistant.components.zha.helpers.DEBUG_LEVELS
 
string homeassistant.components.zha.helpers.DEBUG_LIB_ZHA = "zha"
 
list homeassistant.components.zha.helpers.DEBUG_RELAY_LOGGERS = [DEBUG_COMP_ZHA, DEBUG_COMP_ZIGPY, DEBUG_LIB_ZHA]
 
string homeassistant.components.zha.helpers.DEPTH = "depth"
 
string homeassistant.components.zha.helpers.DEST_NWK = "dest_nwk"
 
string homeassistant.components.zha.helpers.DEVICE_REG_ID = "device_reg_id"
 
string homeassistant.components.zha.helpers.ENTITIES = "entities"
 
string homeassistant.components.zha.helpers.EXTENDED_PAN_ID = "extended_pan_id"
 
list homeassistant.components.zha.helpers.GROUP_ENTITY_DOMAINS = [Platform.LIGHT, Platform.SWITCH, Platform.FAN]
 
string homeassistant.components.zha.helpers.MANY_TO_ONE = "many_to_one"
 
string homeassistant.components.zha.helpers.MEMORY_CONSTRAINED = "memory_constrained"
 
string homeassistant.components.zha.helpers.NEXT_HOP = "next_hop"
 
string homeassistant.components.zha.helpers.PERMIT_JOINING = "permit_joining"
 
string homeassistant.components.zha.helpers.RELATIONSHIP = "relationship"
 
string homeassistant.components.zha.helpers.ROUTE_RECORD_REQUIRED = "route_record_required"
 
string homeassistant.components.zha.helpers.ROUTE_STATUS = "route_status"
 
string homeassistant.components.zha.helpers.RX_ON_WHEN_IDLE = "rx_on_when_idle"
 
string homeassistant.components.zha.helpers.SIGNAL_ADD_ENTITIES = "zha_add_entities"
 
string homeassistant.components.zha.helpers.SIGNAL_REMOVE_ENTITIES = "zha_remove_entities"
 
string homeassistant.components.zha.helpers.USER_GIVEN_NAME = "user_given_name"
 
string homeassistant.components.zha.helpers.ZHA_GW_MSG_LOG_ENTRY = "log_entry"
 
string homeassistant.components.zha.helpers.ZHA_GW_MSG_LOG_OUTPUT = "log_output"