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

Public Member Functions

None async_send_command (self, Iterable[str] command, **Any kwargs)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool is_on (self)
 
- Public Member Functions inherited from homeassistant.components.roku.entity.RokuEntity
None __init__ (self, *RokuDataUpdateCoordinator coordinator, EntityDescription|None description=None)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.remote.RemoteEntity
list[str]|None activity_list (self)
 
None async_delete_command (self, **Any kwargs)
 
None async_learn_command (self, **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)
 
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, 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)
 

Static Private Attributes

 _attr_name = None
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.roku.entity.RokuEntity
 entity_description
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.remote.RemoteEntity
 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
 

Detailed Description

Device that sends commands to an Roku.

Definition at line 37 of file remote.py.

Member Function Documentation

◆ async_send_command()

None homeassistant.components.roku.remote.RokuRemote.async_send_command (   self,
Iterable[str command,
**Any  kwargs 
)
Send a command to one device.

Reimplemented from homeassistant.components.remote.RemoteEntity.

Definition at line 60 of file remote.py.

◆ async_turn_off()

None homeassistant.components.roku.remote.RokuRemote.async_turn_off (   self,
**Any  kwargs 
)
Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 54 of file remote.py.

◆ async_turn_on()

None homeassistant.components.roku.remote.RokuRemote.async_turn_on (   self,
**Any  kwargs 
)
Turn the device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 48 of file remote.py.

◆ is_on()

bool homeassistant.components.roku.remote.RokuRemote.is_on (   self)
Return true if device is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 43 of file remote.py.

Member Data Documentation

◆ _attr_name

homeassistant.components.roku.remote.RokuRemote._attr_name = None
staticprivate

Definition at line 40 of file remote.py.


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