homeassistant.components.zha.helpers.ZHAGatewayProxy Class Reference

Inheritance diagram for homeassistant.components.zha.helpers.ZHAGatewayProxy:

Collaboration diagram for homeassistant.components.zha.helpers.ZHAGatewayProxy:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ConfigEntry config_entry, Gateway gateway)
None	async_disable_debug_mode (self, _LogFilterType|None filterer=None)
None	async_enable_debug_mode (self, _LogFilterType|None filterer=None)
None	async_initialize_devices_and_entities (self)
ZHADeviceProxy|None	get_device_proxy (self, EUI64 ieee)
EntityReference|None	get_entity_reference (self, str entity_id)
ZHAGroupProxy|None	get_group_proxy (self, int|str group_id)
collections.defaultdict[EUI64, list[EntityReference]]	ha_entity_refs (self)
None	handle_connection_lost (self, ConnectionLostEvent event)
None	handle_device_fully_initialized (self, DeviceFullInitEvent event)
None	handle_device_joined (self, DeviceJoinedEvent event)
None	handle_device_left (self, DeviceLeftEvent event)
None	handle_device_removed (self, DeviceRemovedEvent event)
None	handle_group_added (self, GroupEvent event)
None	handle_group_member_added (self, GroupEvent event)
None	handle_group_member_removed (self, GroupEvent event)
None	handle_group_removed (self, GroupEvent event)
None	handle_raw_device_initialized (self, RawDeviceInitializedEvent event)
None	register_entity_reference (self, str ha_entity_id, EntityData entity_data, dr.DeviceInfo ha_device_info, asyncio.Future[Any] remove_future)
None	remove_entity_reference (self, ZHAEntity entity)
None	shutdown (self)

Public Attributes
	config_entry
	debug_enabled
	gateway
	hass

Private Member Functions
ZHADeviceProxy	_async_get_or_create_device_proxy (self, Device zha_device)
ZHAGroupProxy	_async_get_or_create_group_proxy (self, GroupInfo group_info)
None	_async_remove_device (self, ZHADeviceProxy device, list[EntityReference]|None entity_refs)
None	_cleanup_group_entity_registry_entries (self, ZHAGroupProxy zha_group_proxy)
None	_create_entity_metadata (self, ZHADeviceProxy|ZHAGroupProxy proxy_object)
None	_handle_entity_registry_updated (self, Event[er.EventEntityRegistryUpdatedData] event)
None	_send_group_gateway_message (self, ZHAGroupProxy zha_group_proxy, str gateway_message_type)
None	_update_group_entities (self, GroupEvent group_event)

Private Attributes
	_reload_task

Detailed Description

Proxy class to interact with the ZHA gateway.

Definition at line 487 of file helpers.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.__init__	(		self,
		HomeAssistant	hass,
		ConfigEntry	config_entry,
		Gateway	gateway
	)

Initialize the gateway proxy.

Definition at line 490 of file helpers.py.

Member Function Documentation

_async_get_or_create_device_proxy()

ZHADeviceProxy homeassistant.components.zha.helpers.ZHAGatewayProxy._async_get_or_create_device_proxy (   self, Device  zha_device  )

private

Get or create a ZHA device.

Definition at line 795 of file helpers.py.

_async_get_or_create_group_proxy()

ZHAGroupProxy homeassistant.components.zha.helpers.ZHAGatewayProxy._async_get_or_create_group_proxy (   self, GroupInfo  group_info  )

private

Get or create a ZHA group.

Definition at line 813 of file helpers.py.

_async_remove_device()

None homeassistant.components.zha.helpers.ZHAGatewayProxy._async_remove_device (   self, ZHADeviceProxy  device, list[EntityReference] | None   entity_refs  )

private

Definition at line 910 of file helpers.py.

_cleanup_group_entity_registry_entries()

None homeassistant.components.zha.helpers.ZHAGatewayProxy._cleanup_group_entity_registry_entries (   self, ZHAGroupProxy   zha_group_proxy  )

private

Remove entity registry entries for group entities when the groups are removed from HA.

Definition at line 849 of file helpers.py.

_create_entity_metadata()

None homeassistant.components.zha.helpers.ZHAGatewayProxy._create_entity_metadata (   self, ZHADeviceProxy | ZHAGroupProxy   proxy_object  )

private

Create HA entity metadata.

Definition at line 823 of file helpers.py.

_handle_entity_registry_updated()

None homeassistant.components.zha.helpers.ZHAGatewayProxy._handle_entity_registry_updated (   self, Event[er.EventEntityRegistryUpdatedData]   event  )

private

Handle when entity registry updated.

Definition at line 541 of file helpers.py.

_send_group_gateway_message()

None homeassistant.components.zha.helpers.ZHAGatewayProxy._send_group_gateway_message (   self, ZHAGroupProxy  zha_group_proxy, str   gateway_message_type  )

private

Send the gateway event for a zigpy group event.

Definition at line 897 of file helpers.py.

_update_group_entities()

None homeassistant.components.zha.helpers.ZHAGatewayProxy._update_group_entities (   self, GroupEvent  group_event  )

private

Update group entities when a group event is received.

Definition at line 886 of file helpers.py.

async_disable_debug_mode()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.async_disable_debug_mode	(		self,
		_LogFilterType | None	filterer = None
	)

Disable debug mode for ZHA.

Definition at line 747 of file helpers.py.

async_enable_debug_mode()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.async_enable_debug_mode	(		self,
		_LogFilterType | None	filterer = None
	)

Enable debug mode for ZHA.

Definition at line 732 of file helpers.py.

async_initialize_devices_and_entities()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.async_initialize_devices_and_entities

(

self

)

Initialize devices and entities.

Definition at line 581 of file helpers.py.

get_device_proxy()

ZHADeviceProxy | None homeassistant.components.zha.helpers.ZHAGatewayProxy.get_device_proxy	(		self,
		EUI64	ieee
	)

Return ZHADevice for given ieee.

Definition at line 763 of file helpers.py.

get_entity_reference()

EntityReference | None homeassistant.components.zha.helpers.ZHAGatewayProxy.get_entity_reference	(		self,
		str	entity_id
	)

Return entity reference for given entity_id if found.

Definition at line 776 of file helpers.py.

get_group_proxy()

ZHAGroupProxy | None homeassistant.components.zha.helpers.ZHAGatewayProxy.get_group_proxy	(		self,
		int | str	group_id
	)

Return Group for given group id.

Definition at line 767 of file helpers.py.

ha_entity_refs()

collections.defaultdict[EUI64, list[EntityReference]] homeassistant.components.zha.helpers.ZHAGatewayProxy.ha_entity_refs

(

self

)

Return entities by ieee.

Definition at line 520 of file helpers.py.

handle_connection_lost()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_connection_lost	(		self,
		ConnectionLostEvent	event
	)

Handle a connection lost event.

Definition at line 593 of file helpers.py.

handle_device_fully_initialized()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_device_fully_initialized	(		self,
		DeviceFullInitEvent	event
	)

Handle a device fully initialized event.

Definition at line 678 of file helpers.py.

handle_device_joined()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_device_joined	(		self,
		DeviceJoinedEvent	event
	)

Handle a device joined event.

Definition at line 608 of file helpers.py.

handle_device_left()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_device_left	(		self,
		DeviceLeftEvent	event
	)

Handle a device left event.

Definition at line 650 of file helpers.py.

handle_device_removed()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_device_removed	(		self,
		DeviceRemovedEvent	event
	)

Handle a device removed event.

Definition at line 624 of file helpers.py.

handle_group_added()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_group_added	(		self,
		GroupEvent	event
	)

Handle a group added event.

Definition at line 716 of file helpers.py.

handle_group_member_added()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_group_member_added	(		self,
		GroupEvent	event
	)

Handle a group member added event.

Definition at line 708 of file helpers.py.

handle_group_member_removed()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_group_member_removed	(		self,
		GroupEvent	event
	)

Handle a group member removed event.

Definition at line 698 of file helpers.py.

handle_group_removed()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_group_removed	(		self,
		GroupEvent	event
	)

Handle a group removed event.

Definition at line 724 of file helpers.py.

handle_raw_device_initialized()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.handle_raw_device_initialized	(		self,
		RawDeviceInitializedEvent	event
	)

Handle a raw device initialized event.

Definition at line 654 of file helpers.py.

register_entity_reference()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.register_entity_reference	(		self,
		str	ha_entity_id,
		EntityData	entity_data,
		dr.DeviceInfo	ha_device_info,
		asyncio.Future[Any]	remove_future
	)

Record the creation of a hass entity associated with ieee.

Definition at line 524 of file helpers.py.

remove_entity_reference()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.remove_entity_reference	(		self,
		ZHAEntity	entity
	)

Remove entity reference for given entity_id if found.

Definition at line 785 of file helpers.py.

shutdown()

None homeassistant.components.zha.helpers.ZHAGatewayProxy.shutdown

(

self

)

Shutdown the gateway proxy.

Definition at line 757 of file helpers.py.

Member Data Documentation

_reload_task

homeassistant.components.zha.helpers.ZHAGatewayProxy._reload_task

private

Definition at line 603 of file helpers.py.

config_entry

homeassistant.components.zha.helpers.ZHAGatewayProxy.config_entry

Definition at line 496 of file helpers.py.

debug_enabled

homeassistant.components.zha.helpers.ZHAGatewayProxy.debug_enabled

Definition at line 744 of file helpers.py.

gateway

homeassistant.components.zha.helpers.ZHAGatewayProxy.gateway

Definition at line 497 of file helpers.py.

hass

homeassistant.components.zha.helpers.ZHAGatewayProxy.hass

Definition at line 495 of file helpers.py.

---

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

• core/homeassistant/components/zha/helpers.py