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

Public Member Functions

def __init__ (self, friendly_name, device, unique_id, slot, timeout, commands)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
def device (self)
 
def is_on (self)
 
def name (self)
 
def send_command (self, command, **kwargs)
 
def slot (self)
 
def timeout (self)
 
def unique_id (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)
 
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)
 
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)
 
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 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)
 

Private Member Functions

def _send_command (self, payload)
 

Private Attributes

 _commands
 
 _device
 
 _name
 
 _slot
 
 _state
 
 _timeout
 
 _unique_id
 

Static Private Attributes

bool _attr_should_poll = False
 

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.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

Representation of a Xiaomi Miio Remote device.

Definition at line 183 of file remote.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote.__init__ (   self,
  friendly_name,
  device,
  unique_id,
  slot,
  timeout,
  commands 
)
Initialize the remote.

Definition at line 188 of file remote.py.

Member Function Documentation

◆ _send_command()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._send_command (   self,
  payload 
)
private
Send a command.

Definition at line 246 of file remote.py.

◆ async_turn_off()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 239 of file remote.py.

◆ async_turn_on()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 232 of file remote.py.

◆ device()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote.device (   self)
Return the remote object.

Definition at line 209 of file remote.py.

◆ is_on()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote.is_on (   self)
Return False if device is unreachable, else True.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 224 of file remote.py.

◆ name()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote.name (   self)
Return the name of the remote.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 204 of file remote.py.

◆ send_command()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote.send_command (   self,
  command,
**  kwargs 
)
Send a command.

Definition at line 256 of file remote.py.

◆ slot()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote.slot (   self)
Return the slot to save learned command.

Definition at line 214 of file remote.py.

◆ timeout()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote.timeout (   self)
Return the timeout for learning command.

Definition at line 219 of file remote.py.

◆ unique_id()

def homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote.unique_id (   self)
Return an unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 199 of file remote.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._attr_should_poll = False
staticprivate

Definition at line 186 of file remote.py.

◆ _commands

homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._commands
private

Definition at line 196 of file remote.py.

◆ _device

homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._device
private

Definition at line 191 of file remote.py.

◆ _name

homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._name
private

Definition at line 190 of file remote.py.

◆ _slot

homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._slot
private

Definition at line 193 of file remote.py.

◆ _state

homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._state
private

Definition at line 195 of file remote.py.

◆ _timeout

homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._timeout
private

Definition at line 194 of file remote.py.

◆ _unique_id

homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote._unique_id
private

Definition at line 192 of file remote.py.


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