homeassistant.components.apple_tv.AppleTVManager Class Reference

Inheritance diagram for homeassistant.components.apple_tv.AppleTVManager:

Collaboration diagram for homeassistant.components.apple_tv.AppleTVManager:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ConfigEntry config_entry)
None	async_first_connect (self)
None	connect (self)
None	connect_once (self, bool raise_missing_credentials)
None	connection_closed (self)
None	connection_lost (self, Exception exception)
None	disconnect (self)
None	init (self)
bool	is_connecting (self)

Public Attributes
	atv
	config_entry
	hass
	is_on

Static Public Attributes
	None

Private Member Functions
None	_address_updated (self, str address)
None	_async_setup_device_registry (self)
None	_connect (self, AppleTV conf, bool raise_missing_credentials)
None	_connect_loop (self)
None	_connect_once (self, bool raise_missing_credentials)
None	_dispatch_send (self, str signal, *Any args)
None	_handle_disconnect (self)
AppleTV|None	_scan (self)
None	_start_connect_loop (self)

Private Attributes
	_connection_attempts
	_connection_was_lost
	_task

Static Private Attributes
int	_connection_attempts = 0
bool	_connection_was_lost = False

Detailed Description

Connection and power manager for an Apple TV.

An instance is used per device to share the same power state between
several platforms. It also manages scanning and connection establishment
in case of problems.

Definition at line 122 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.apple_tv.AppleTVManager.__init__	(		self,
		HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Initialize power manager.

Definition at line 135 of file __init__.py.

Member Function Documentation

_address_updated()

None homeassistant.components.apple_tv.AppleTVManager._address_updated (   self, str  address  )

private

Update cached address in config entry.

Definition at line 380 of file __init__.py.

_async_setup_device_registry()

None homeassistant.components.apple_tv.AppleTVManager._async_setup_device_registry (   self )

private

Definition at line 345 of file __init__.py.

_connect()

None homeassistant.components.apple_tv.AppleTVManager._connect (   self, AppleTV  conf, bool  raise_missing_credentials  )

private

Connect to device.

Definition at line 299 of file __init__.py.

_connect_loop()

None homeassistant.components.apple_tv.AppleTVManager._connect_loop (   self )

private

Connect loop background task function.

Definition at line 238 of file __init__.py.

_connect_once()

None homeassistant.components.apple_tv.AppleTVManager._connect_once (   self, bool  raise_missing_credentials  )

private

Connect to device once.

Definition at line 205 of file __init__.py.

_dispatch_send()

None homeassistant.components.apple_tv.AppleTVManager._dispatch_send (   self, str  signal, *Any  args  )

private

Dispatch a signal to all entities managed by this manager.

Definition at line 387 of file __init__.py.

_handle_disconnect()

None homeassistant.components.apple_tv.AppleTVManager._handle_disconnect (   self )

private

Handle that the device disconnected and restart connect loop.

Definition at line 164 of file __init__.py.

_scan()

AppleTV | None homeassistant.components.apple_tv.AppleTVManager._scan (   self )

private

Try to find device by scanning for it.

Definition at line 264 of file __init__.py.

_start_connect_loop()

None homeassistant.components.apple_tv.AppleTVManager._start_connect_loop (   self )

private

Start background connect loop to device.

Definition at line 191 of file __init__.py.

async_first_connect()

None homeassistant.components.apple_tv.AppleTVManager.async_first_connect

(

self

)

Connect to device for the first time.

Definition at line 210 of file __init__.py.

connect()

None homeassistant.components.apple_tv.AppleTVManager.connect

(

self

)

Connect to device.

Definition at line 172 of file __init__.py.

connect_once()

None homeassistant.components.apple_tv.AppleTVManager.connect_once	(		self,
		bool	raise_missing_credentials
	)

Try to connect once.

Definition at line 220 of file __init__.py.

connection_closed()

None homeassistant.components.apple_tv.AppleTVManager.connection_closed

(

self

)

Device connection was (intentionally) closed.

This is a callback function from pyatv.interface.DeviceListener.

Definition at line 157 of file __init__.py.

connection_lost()

None homeassistant.components.apple_tv.AppleTVManager.connection_lost	(		self,
		Exception	exception
	)

Device was unexpectedly disconnected.

This is a callback function from pyatv.interface.DeviceListener.

Definition at line 146 of file __init__.py.

disconnect()

None homeassistant.components.apple_tv.AppleTVManager.disconnect

(

self

)

Disconnect from device.

Definition at line 177 of file __init__.py.

init()

None homeassistant.components.apple_tv.AppleTVManager.init

(

self

)

Initialize power management.

Definition at line 141 of file __init__.py.

is_connecting()

bool homeassistant.components.apple_tv.AppleTVManager.is_connecting

(

self

)

Return true if connection is in progress.

Definition at line 376 of file __init__.py.

Member Data Documentation

_connection_attempts [1/2]

int homeassistant.components.apple_tv.AppleTVManager._connection_attempts = 0

staticprivate

Definition at line 131 of file __init__.py.

_connection_attempts [2/2]

homeassistant.components.apple_tv.AppleTVManager._connection_attempts

private

Definition at line 336 of file __init__.py.

_connection_was_lost [1/2]

bool homeassistant.components.apple_tv.AppleTVManager._connection_was_lost = False

staticprivate

Definition at line 132 of file __init__.py.

_connection_was_lost [2/2]

homeassistant.components.apple_tv.AppleTVManager._connection_was_lost

private

Definition at line 154 of file __init__.py.

_task

homeassistant.components.apple_tv.AppleTVManager._task

private

Definition at line 187 of file __init__.py.

atv

homeassistant.components.apple_tv.AppleTVManager.atv

Definition at line 168 of file __init__.py.

config_entry

homeassistant.components.apple_tv.AppleTVManager.config_entry

Definition at line 137 of file __init__.py.

hass

homeassistant.components.apple_tv.AppleTVManager.hass

Definition at line 138 of file __init__.py.

is_on

homeassistant.components.apple_tv.AppleTVManager.is_on

Definition at line 139 of file __init__.py.

None

homeassistant.components.apple_tv.AppleTVManager.None

static

Definition at line 130 of file __init__.py.

---

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

• core/homeassistant/components/apple_tv/__init__.py