Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.zha.helpers.ZHADeviceProxy Class Reference
Inheritance diagram for homeassistant.components.zha.helpers.ZHADeviceProxy:
[legend]
Collaboration diagram for homeassistant.components.zha.helpers.ZHADeviceProxy:
[legend]

Public Member Functions

None __init__ (self, Device device, ZHAGatewayProxy gateway_proxy)
 
str device_id (self)
 
None device_id (self, str device_id)
 
dict[str, Any] device_info (self)
 
None handle_zha_channel_bind (self, ClusterBindEvent event)
 
None handle_zha_channel_cfg_done (self, ClusterHandlerConfigurationComplete event)
 
None handle_zha_channel_configure_reporting (self, ClusterConfigureReportingEvent event)
 
None handle_zha_event (self, ZHAEvent zha_event)
 
dict[str, Any] zha_device_info (self)
 

Public Attributes

 device
 
 gateway_proxy
 

Private Attributes

 _ha_device_id
 

Detailed Description

Proxy class to interact with the ZHA device instances.

Definition at line 299 of file helpers.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.zha.helpers.ZHADeviceProxy.__init__ (   self,
Device  device,
ZHAGatewayProxy  gateway_proxy 
)
Initialize the gateway proxy.

Definition at line 304 of file helpers.py.

Member Function Documentation

◆ device_id() [1/2]

str homeassistant.components.zha.helpers.ZHADeviceProxy.device_id (   self)
Return the HA device registry device id.

Definition at line 313 of file helpers.py.

◆ device_id() [2/2]

None homeassistant.components.zha.helpers.ZHADeviceProxy.device_id (   self,
str  device_id 
)
Set the HA device registry device id.

Definition at line 318 of file helpers.py.

◆ device_info()

dict[str, Any] homeassistant.components.zha.helpers.ZHADeviceProxy.device_info (   self)
Return a device description for device.

Definition at line 323 of file helpers.py.

◆ handle_zha_channel_bind()

None homeassistant.components.zha.helpers.ZHADeviceProxy.handle_zha_channel_bind (   self,
ClusterBindEvent  event 
)
Handle a ZHA cluster bind event.

Definition at line 462 of file helpers.py.

◆ handle_zha_channel_cfg_done()

None homeassistant.components.zha.helpers.ZHADeviceProxy.handle_zha_channel_cfg_done (   self,
ClusterHandlerConfigurationComplete   event 
)
Handle a ZHA cluster configure reporting event.

Definition at line 449 of file helpers.py.

◆ handle_zha_channel_configure_reporting()

None homeassistant.components.zha.helpers.ZHADeviceProxy.handle_zha_channel_configure_reporting (   self,
ClusterConfigureReportingEvent   event 
)
Handle a ZHA cluster configure reporting event.

Definition at line 431 of file helpers.py.

◆ handle_zha_event()

None homeassistant.components.zha.helpers.ZHADeviceProxy.handle_zha_event (   self,
ZHAEvent  zha_event 
)
Handle a ZHA event.

Definition at line 418 of file helpers.py.

◆ zha_device_info()

dict[str, Any] homeassistant.components.zha.helpers.ZHADeviceProxy.zha_device_info (   self)
Get ZHA device information.

Definition at line 348 of file helpers.py.

Member Data Documentation

◆ _ha_device_id

homeassistant.components.zha.helpers.ZHADeviceProxy._ha_device_id
private

Definition at line 320 of file helpers.py.

◆ device

homeassistant.components.zha.helpers.ZHADeviceProxy.device

Definition at line 307 of file helpers.py.

◆ gateway_proxy

homeassistant.components.zha.helpers.ZHADeviceProxy.gateway_proxy

Definition at line 308 of file helpers.py.


The documentation for this class was generated from the following file: