Inheritance diagram for homeassistant.components.remote.RemoteEntity:

Collaboration diagram for homeassistant.components.remote.RemoteEntity:

Public Member Functions
list[str]\|None	activity_list (self)

None	async_delete_command (self, **Any kwargs)

None	async_learn_command (self, **Any kwargs)

None	async_send_command (self, Iterable[str] command, **Any kwargs)

str\|None	current_activity (self)

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)

None	async_turn_off (self, **Any kwargs)

None	async_turn_on (self, **Any kwargs)

bool\|None	is_on (self)

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.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_added_to_hass (self)

None	async_device_update (self, bool warning=True)

None	async_internal_added_to_hass (self)

None	async_internal_will_remove_from_hass (self)

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)

bool	available (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)

Mapping[str, Any]\|None	extra_state_attributes (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, str]	translation_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)

Static Public Attributes
	None

	RemoteEntityFeature

Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
	None

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

Base class for remote entities.

Definition at line 179 of file __init__.py.

Member Function Documentation

◆ activity_list()

list[str] | None homeassistant.components.remote.RemoteEntity.activity_list ( self )

List of available activities.

Reimplemented in homeassistant.components.harmony.remote.HarmonyRemote.

Definition at line 211 of file __init__.py.

◆ async_delete_command()

None homeassistant.components.remote.RemoteEntity.async_delete_command	(		self,
		**Any	kwargs
	)

Delete commands from the database.

Reimplemented in homeassistant.components.broadlink.remote.BroadlinkRemote.

Definition at line 249 of file __init__.py.

◆ async_learn_command()

None homeassistant.components.remote.RemoteEntity.async_learn_command	(		self,
		**Any	kwargs
	)

Learn a command from a device.

Reimplemented in homeassistant.components.mysensors.remote.MySensorsRemote, and homeassistant.components.broadlink.remote.BroadlinkRemote.

Definition at line 241 of file __init__.py.

◆ async_send_command()

None homeassistant.components.remote.RemoteEntity.async_send_command	(		self,
		Iterable[str]	command,
		**Any	kwargs
	)

Send commands to a device.

Definition at line 231 of file __init__.py.

◆ current_activity()

str | None homeassistant.components.remote.RemoteEntity.current_activity ( self )

Active activity.

Reimplemented in homeassistant.components.harmony.remote.HarmonyRemote.

Definition at line 206 of file __init__.py.

◆ delete_command()

None homeassistant.components.remote.RemoteEntity.delete_command	(		self,
		**Any	kwargs
	)

Delete commands from the database.

Definition at line 245 of file __init__.py.

◆ learn_command()

None homeassistant.components.remote.RemoteEntity.learn_command	(		self,
		**Any	kwargs
	)

Learn a command from a device.

Definition at line 237 of file __init__.py.

◆ send_command()

None homeassistant.components.remote.RemoteEntity.send_command	(		self,
		Iterable[str]	command,
		**Any	kwargs
	)

Send commands to a device.

Reimplemented in homeassistant.components.sky_remote.remote.SkyRemote, homeassistant.components.kira.remote.KiraRemote, homeassistant.components.jellyfin.remote.JellyfinRemote, homeassistant.components.itach.remote.ITachIP2IRRemote, and homeassistant.components.demo.remote.DemoRemote.

Definition at line 227 of file __init__.py.

◆ state_attributes()

dict[str, Any] | None homeassistant.components.remote.RemoteEntity.state_attributes ( self )

Return optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 217 of file __init__.py.

◆ supported_features()

RemoteEntityFeature homeassistant.components.remote.RemoteEntity.supported_features ( self )

Flag supported features.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.mysensors.remote.MySensorsRemote.

Definition at line 188 of file __init__.py.

◆ supported_features_compat()

RemoteEntityFeature homeassistant.components.remote.RemoteEntity.supported_features_compat ( self )

Return the supported features as RemoteEntityFeature.

Remove this compatibility shim in 2025.1 or later.

Definition at line 193 of file __init__.py.

Member Data Documentation

◆ None

homeassistant.components.remote.RemoteEntity.None

static

Definition at line 183 of file __init__.py.

◆ RemoteEntityFeature

homeassistant.components.remote.RemoteEntity.RemoteEntityFeature