Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.harmony.remote.HarmonyRemote Class Reference
Inheritance diagram for homeassistant.components.harmony.remote.HarmonyRemote:
[legend]
Collaboration diagram for homeassistant.components.harmony.remote.HarmonyRemote:
[legend]

Public Member Functions

None __init__ (self, HarmonyData data, str|None activity, float delay_secs, str out_path)
 
def activity_list (self)
 
None async_added_to_hass (self)
 
None async_new_activity (self, tuple activity_info)
 
None async_new_activity_finished (self, tuple activity_info)
 
None async_new_config (self, dict|None _=None)
 
None async_send_command (self, Iterable[str] command, **Any kwargs)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None change_channel (self, int channel)
 
def current_activity (self)
 
dict[str, Any] extra_state_attributes (self)
 
bool is_on (self)
 
None sync (self)
 
None write_config_file (self)
 
- Public Member Functions inherited from homeassistant.components.harmony.entity.HarmonyEntity
None __init__ (self, HarmonyData data)
 
None async_got_connected (self, str|None _=None)
 
None async_got_disconnected (self, str|None _=None)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.remote.RemoteEntity
None async_delete_command (self, **Any kwargs)
 
None async_learn_command (self, **Any kwargs)
 
None delete_command (self, **Any kwargs)
 
None learn_command (self, **Any kwargs)
 
None send_command (self, Iterable[str] command, **Any kwargs)
 
dict[str, Any]|None state_attributes (self)
 
RemoteEntityFeature supported_features (self)
 
RemoteEntityFeature supported_features_compat (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 

Public Attributes

 default_activity
 
 delay_secs
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _async_update_options (self, dict[str, Any] data)
 
None _setup_callbacks (self)
 

Private Attributes

 _activity_starting
 
 _attr_device_info
 
 _attr_unique_id
 
 _config_path
 
 _current_activity
 
 _is_initial_update
 
 _last_activity
 
 _state
 

Static Private Attributes

 _attr_name = None
 
 _attr_supported_features = RemoteEntityFeature.ACTIVITY
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.remote.RemoteEntity
 None
 
 RemoteEntityFeature
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Detailed Description

Remote representation used to control a Harmony device.

Definition at line 86 of file remote.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.harmony.remote.HarmonyRemote.__init__ (   self,
HarmonyData  data,
str | None  activity,
float  delay_secs,
str   out_path 
)
Initialize HarmonyRemote class.

Definition at line 92 of file remote.py.

Member Function Documentation

◆ _async_update_options()

None homeassistant.components.harmony.remote.HarmonyRemote._async_update_options (   self,
dict[str, Any]  data 
)
private
Change options when the options flow does.

Definition at line 108 of file remote.py.

◆ _setup_callbacks()

None homeassistant.components.harmony.remote.HarmonyRemote._setup_callbacks (   self)
private

Definition at line 116 of file remote.py.

◆ activity_list()

def homeassistant.components.harmony.remote.HarmonyRemote.activity_list (   self)
Return the available activities.

Reimplemented from homeassistant.components.remote.RemoteEntity.

Definition at line 174 of file remote.py.

◆ async_added_to_hass()

None homeassistant.components.harmony.remote.HarmonyRemote.async_added_to_hass (   self)
Complete the initialization.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 135 of file remote.py.

◆ async_new_activity()

None homeassistant.components.harmony.remote.HarmonyRemote.async_new_activity (   self,
tuple  activity_info 
)
Call for updating the current activity.

Definition at line 193 of file remote.py.

◆ async_new_activity_finished()

None homeassistant.components.harmony.remote.HarmonyRemote.async_new_activity_finished (   self,
tuple  activity_info 
)
Call for finished updated current activity.

Definition at line 130 of file remote.py.

◆ async_new_config()

None homeassistant.components.harmony.remote.HarmonyRemote.async_new_config (   self,
dict | None   _ = None 
)
Call for updating the current activity.

Definition at line 210 of file remote.py.

◆ async_send_command()

None homeassistant.components.harmony.remote.HarmonyRemote.async_send_command (   self,
Iterable[str command,
**Any  kwargs 
)
Send a list of commands to one device.

Reimplemented from homeassistant.components.remote.RemoteEntity.

Definition at line 239 of file remote.py.

◆ async_turn_off()

None homeassistant.components.harmony.remote.HarmonyRemote.async_turn_off (   self,
**Any  kwargs 
)
Start the PowerOff activity.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 235 of file remote.py.

◆ async_turn_on()

None homeassistant.components.harmony.remote.HarmonyRemote.async_turn_on (   self,
**Any  kwargs 
)
Start an activity from the Harmony device.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 216 of file remote.py.

◆ change_channel()

None homeassistant.components.harmony.remote.HarmonyRemote.change_channel (   self,
int  channel 
)
Change the channel using Harmony remote.

Definition at line 253 of file remote.py.

◆ current_activity()

def homeassistant.components.harmony.remote.HarmonyRemote.current_activity (   self)
Return the current activity.

Reimplemented from homeassistant.components.remote.RemoteEntity.

Definition at line 169 of file remote.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.harmony.remote.HarmonyRemote.extra_state_attributes (   self)
Add platform specific attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 179 of file remote.py.

◆ is_on()

bool homeassistant.components.harmony.remote.HarmonyRemote.is_on (   self)
Return False if PowerOff is the current activity, otherwise True.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 188 of file remote.py.

◆ sync()

None homeassistant.components.harmony.remote.HarmonyRemote.sync (   self)
Sync the Harmony device with the web service.

Definition at line 257 of file remote.py.

◆ write_config_file()

None homeassistant.components.harmony.remote.HarmonyRemote.write_config_file (   self)
Write Harmony configuration file.

This is a handy way for users to figure out the available commands for automations.

Definition at line 262 of file remote.py.

Member Data Documentation

◆ _activity_starting

homeassistant.components.harmony.remote.HarmonyRemote._activity_starting
private

Definition at line 100 of file remote.py.

◆ _attr_device_info

homeassistant.components.harmony.remote.HarmonyRemote._attr_device_info
private

Definition at line 106 of file remote.py.

◆ _attr_name

homeassistant.components.harmony.remote.HarmonyRemote._attr_name = None
staticprivate

Definition at line 90 of file remote.py.

◆ _attr_supported_features

homeassistant.components.harmony.remote.HarmonyRemote._attr_supported_features = RemoteEntityFeature.ACTIVITY
staticprivate

Definition at line 89 of file remote.py.

◆ _attr_unique_id

homeassistant.components.harmony.remote.HarmonyRemote._attr_unique_id
private

Definition at line 105 of file remote.py.

◆ _config_path

homeassistant.components.harmony.remote.HarmonyRemote._config_path
private

Definition at line 104 of file remote.py.

◆ _current_activity

homeassistant.components.harmony.remote.HarmonyRemote._current_activity
private

Definition at line 98 of file remote.py.

◆ _is_initial_update

homeassistant.components.harmony.remote.HarmonyRemote._is_initial_update
private

Definition at line 101 of file remote.py.

◆ _last_activity

homeassistant.components.harmony.remote.HarmonyRemote._last_activity
private

Definition at line 103 of file remote.py.

◆ _state

homeassistant.components.harmony.remote.HarmonyRemote._state
private

Definition at line 207 of file remote.py.

◆ default_activity

homeassistant.components.harmony.remote.HarmonyRemote.default_activity

Definition at line 99 of file remote.py.

◆ delay_secs

homeassistant.components.harmony.remote.HarmonyRemote.delay_secs

Definition at line 102 of file remote.py.


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