homeassistant.components.harmony.data.HarmonyData Class Reference

Inheritance diagram for homeassistant.components.harmony.data.HarmonyData:

Collaboration diagram for homeassistant.components.harmony.data.HarmonyData:

Public Member Functions
None	__init__ (self, HomeAssistant hass, str address, str name, str|None unique_id)
def	activities (self)
list[str]	activity_names (self)
None	async_power_off (self)
None	async_send_command (self, Iterable[str] commands, str device, int num_repeats, float delay_secs, float hold_secs)
None	async_start_activity (self, str activity)
bool	available (self)
None	change_channel (self, int channel)
None	connect (self)
tuple	current_activity (self)
DeviceInfo	device_info (self, str domain)
def	device_names (self)
def	json_config (self)
None	shutdown (self)
bool	sync (self)
def	unique_id (self)
Public Member Functions inherited from homeassistant.components.harmony.subscriber.HarmonySubscriberMixin
None	__init__ (self, HomeAssistant hass)
None	async_lock_start_activity (self)
CALLBACK_TYPE	async_subscribe (self, HarmonyCallback update_callbacks)
None	async_unlock_start_activity (self)
None	async_unsubscribe (self, HarmonyCallback update_callback)

Public Attributes
	name

Private Attributes
	_address
	_available
	_client
	_unique_id

Detailed Description

HarmonyData registers for Harmony hub updates.

Definition at line 26 of file data.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.harmony.data.HarmonyData.__init__	(		self,
		HomeAssistant	hass,
		str	address,
		str	name,
		str | None	unique_id
	)

Initialize a data object.

Definition at line 31 of file data.py.

Member Function Documentation

activities()

def homeassistant.components.harmony.data.HarmonyData.activities

(

self

)

List of all non-poweroff activity objects.

Definition at line 42 of file data.py.

activity_names()

list[str] homeassistant.components.harmony.data.HarmonyData.activity_names

(

self

)

Names of all the remotes activities.

Definition at line 52 of file data.py.

async_power_off()

None homeassistant.components.harmony.data.HarmonyData.async_power_off

(

self

)

Start the PowerOff activity.

Definition at line 187 of file data.py.

async_send_command()

None homeassistant.components.harmony.data.HarmonyData.async_send_command	(		self,
		Iterable[str]	commands,
		str	device,
		int	num_repeats,
		float	delay_secs,
		float	hold_secs
	)

Send a list of commands to one device.

Definition at line 195 of file data.py.

async_start_activity()

None homeassistant.components.harmony.data.HarmonyData.async_start_activity	(		self,
		str	activity
	)

Start an activity from the Harmony device.

Definition at line 144 of file data.py.

available()

bool homeassistant.components.harmony.data.HarmonyData.available

(

self

)

Return if connected to the hub.

Definition at line 76 of file data.py.

change_channel()

None homeassistant.components.harmony.data.HarmonyData.change_channel	(		self,
		int	channel
	)

Change the channel using Harmony remote.

Definition at line 257 of file data.py.

connect()

None homeassistant.components.harmony.data.HarmonyData.connect

(

self

)

Connect to the Harmony Hub.

Definition at line 101 of file data.py.

current_activity()

tuple homeassistant.components.harmony.data.HarmonyData.current_activity

(

self

)

Return the current activity tuple.

Definition at line 81 of file data.py.

device_info()

DeviceInfo homeassistant.components.harmony.data.HarmonyData.device_info	(		self,
		str	domain
	)

Return hub device info.

Definition at line 85 of file data.py.

device_names()

def homeassistant.components.harmony.data.HarmonyData.device_names

(

self

)

Names of all of the devices connected to the hub.

Definition at line 58 of file data.py.

json_config()

def homeassistant.components.harmony.data.HarmonyData.json_config

(

self

)

Return the hub config as json.

Definition at line 69 of file data.py.

shutdown()

None homeassistant.components.harmony.data.HarmonyData.shutdown

(

self

)

Close connection on shutdown.

Definition at line 136 of file data.py.

sync()

bool homeassistant.components.harmony.data.HarmonyData.sync

(

self

)

Sync the Harmony device with the web service.

Returns True if the sync was successful.

Definition at line 265 of file data.py.

unique_id()

def homeassistant.components.harmony.data.HarmonyData.unique_id

(

self

)

Return the Harmony device's unique_id.

Definition at line 64 of file data.py.

Member Data Documentation

_address

homeassistant.components.harmony.data.HarmonyData._address

private

Definition at line 39 of file data.py.

_available

homeassistant.components.harmony.data.HarmonyData._available

private

Definition at line 38 of file data.py.

_client

homeassistant.components.harmony.data.HarmonyData._client

private

Definition at line 112 of file data.py.

_unique_id

homeassistant.components.harmony.data.HarmonyData._unique_id

private

Definition at line 37 of file data.py.

name

homeassistant.components.harmony.data.HarmonyData.name

Definition at line 36 of file data.py.

---

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

• core/homeassistant/components/harmony/data.py