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

Public Member Functions

def __init__ (self, device, codes, flags)
 
None async_added_to_hass (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)
 
None async_turn_off (self, **Any kwargs)
 
None async_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_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)
 
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)
 
- Public Member Functions inherited from homeassistant.components.remote.RemoteEntity
list[str]|None activity_list (self)
 
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)
 
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.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)
 

Private Member Functions

def _async_learn_ir_command (self, command)
 
def _async_learn_rf_command (self, command)
 
def _async_load_storage (self)
 
def _extract_codes (self, commands, device=None)
 
def _get_codes (self)
 
def _get_flags (self)
 

Private Attributes

 _attr_is_on
 
 _attr_supported_features
 
 _attr_unique_id
 
 _code_storage
 
 _codes
 
 _flag_storage
 
 _flags
 
 _lock
 
 _storage_loaded
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- 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

Representation of a Broadlink remote.

Definition at line 107 of file remote.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.broadlink.remote.BroadlinkRemote.__init__ (   self,
  device,
  codes,
  flags 
)
Initialize the remote.

Definition at line 113 of file remote.py.

Member Function Documentation

◆ _async_learn_ir_command()

def homeassistant.components.broadlink.remote.BroadlinkRemote._async_learn_ir_command (   self,
  command 
)
private
Learn an infrared command.

Definition at line 316 of file remote.py.

◆ _async_learn_rf_command()

def homeassistant.components.broadlink.remote.BroadlinkRemote._async_learn_rf_command (   self,
  command 
)
private
Learn a radiofrequency command.

Definition at line 354 of file remote.py.

◆ _async_load_storage()

def homeassistant.components.broadlink.remote.BroadlinkRemote._async_load_storage (   self)
private
Load code and flag storage from disk.

Definition at line 198 of file remote.py.

◆ _extract_codes()

def homeassistant.components.broadlink.remote.BroadlinkRemote._extract_codes (   self,
  commands,
  device = None 
)
private
Extract a list of codes.

If the command starts with `b64:`, extract the code from it.
Otherwise, extract the code from storage, using the command and
device as keys.

The codes are returned in sublists. For toggle commands, the
sublist contains two codes that must be sent alternately with
each call.

Definition at line 129 of file remote.py.

◆ _get_codes()

def homeassistant.components.broadlink.remote.BroadlinkRemote._get_codes (   self)
private
Return a dictionary of codes.

Definition at line 169 of file remote.py.

◆ _get_flags()

def homeassistant.components.broadlink.remote.BroadlinkRemote._get_flags (   self)
private
Return a dictionary of toggle flags.

A toggle flag indicates whether the remote should send an
alternative code.

Definition at line 174 of file remote.py.

◆ async_added_to_hass()

None homeassistant.components.broadlink.remote.BroadlinkRemote.async_added_to_hass (   self)
Call when the remote is added to hass.

Reimplemented from homeassistant.components.broadlink.entity.BroadlinkEntity.

Definition at line 182 of file remote.py.

◆ async_delete_command()

None homeassistant.components.broadlink.remote.BroadlinkRemote.async_delete_command (   self,
**Any  kwargs 
)
Delete a list of commands from a remote.

Reimplemented from homeassistant.components.remote.RemoteEntity.

Definition at line 430 of file remote.py.

◆ async_learn_command()

None homeassistant.components.broadlink.remote.BroadlinkRemote.async_learn_command (   self,
**Any  kwargs 
)
Learn a list of commands from a remote.

Reimplemented from homeassistant.components.remote.RemoteEntity.

Definition at line 263 of file remote.py.

◆ async_send_command()

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

Reimplemented from homeassistant.components.remote.RemoteEntity.

Definition at line 206 of file remote.py.

◆ async_turn_off()

None homeassistant.components.broadlink.remote.BroadlinkRemote.async_turn_off (   self,
**Any  kwargs 
)
Turn off the remote.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 193 of file remote.py.

◆ async_turn_on()

None homeassistant.components.broadlink.remote.BroadlinkRemote.async_turn_on (   self,
**Any  kwargs 
)
Turn on the remote.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 188 of file remote.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.broadlink.remote.BroadlinkRemote._attr_has_entity_name = True
staticprivate

Definition at line 110 of file remote.py.

◆ _attr_is_on

homeassistant.components.broadlink.remote.BroadlinkRemote._attr_is_on
private

Definition at line 123 of file remote.py.

◆ _attr_name

homeassistant.components.broadlink.remote.BroadlinkRemote._attr_name = None
staticprivate

Definition at line 111 of file remote.py.

◆ _attr_supported_features

homeassistant.components.broadlink.remote.BroadlinkRemote._attr_supported_features
private

Definition at line 124 of file remote.py.

◆ _attr_unique_id

homeassistant.components.broadlink.remote.BroadlinkRemote._attr_unique_id
private

Definition at line 127 of file remote.py.

◆ _code_storage

homeassistant.components.broadlink.remote.BroadlinkRemote._code_storage
private

Definition at line 116 of file remote.py.

◆ _codes

homeassistant.components.broadlink.remote.BroadlinkRemote._codes
private

Definition at line 119 of file remote.py.

◆ _flag_storage

homeassistant.components.broadlink.remote.BroadlinkRemote._flag_storage
private

Definition at line 117 of file remote.py.

◆ _flags

homeassistant.components.broadlink.remote.BroadlinkRemote._flags
private

Definition at line 120 of file remote.py.

◆ _lock

homeassistant.components.broadlink.remote.BroadlinkRemote._lock
private

Definition at line 121 of file remote.py.

◆ _storage_loaded

homeassistant.components.broadlink.remote.BroadlinkRemote._storage_loaded
private

Definition at line 118 of file remote.py.


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