homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, aiounifi.Controller api)
None	initialize (self)
None	queue_poe_port_command (self, str device_id, int port_idx, str poe_mode)
None	remove_heartbeat (self, str unique_id)
None	reset (self)
str	signal_heartbeat (self)
None	update_heartbeat (self, str unique_id, datetime heartbeat_expire_time)

Public Attributes
	api
	hass

Private Attributes
	_device_command
	_heartbeat

Detailed Description

UniFi Network integration handling platforms for entity registration.

Definition at line 16 of file entity_helper.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.__init__	(		self,
		HomeAssistant	hass,
		aiounifi.Controller	api
	)

Initialize the UniFi entity loader.

Definition at line 19 of file entity_helper.py.

Member Function Documentation

initialize()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.initialize

(

self

)

Initialize entity helper.

Definition at line 34 of file entity_helper.py.

queue_poe_port_command()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.queue_poe_port_command	(		self,
		str	device_id,
		int	port_idx,
		str	poe_mode
	)

Queue commands to execute them together per device.

Definition at line 54 of file entity_helper.py.

remove_heartbeat()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.remove_heartbeat	(		self,
		str	unique_id
	)

Update device time in heartbeat monitor.

Definition at line 49 of file entity_helper.py.

reset()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.reset

(

self

)

Cancel timers.

Definition at line 28 of file entity_helper.py.

signal_heartbeat()

str homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.signal_heartbeat

(

self

)

Event to signal new heartbeat missed.

Definition at line 39 of file entity_helper.py.

update_heartbeat()

None homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.update_heartbeat	(		self,
		str	unique_id,
		datetime	heartbeat_expire_time
	)

Update device time in heartbeat monitor.

Definition at line 44 of file entity_helper.py.

Member Data Documentation

_device_command

homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper._device_command

private

Definition at line 24 of file entity_helper.py.

_heartbeat

homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper._heartbeat

private

Definition at line 25 of file entity_helper.py.

api

homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.api

Definition at line 22 of file entity_helper.py.

hass

homeassistant.components.unifi.hub.entity_helper.UnifiEntityHelper.hass

Definition at line 21 of file entity_helper.py.

---

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

• core/homeassistant/components/unifi/hub/entity_helper.py