Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.rflink.entity.RflinkCommand Class Reference
Inheritance diagram for homeassistant.components.rflink.entity.RflinkCommand:
[legend]
Collaboration diagram for homeassistant.components.rflink.entity.RflinkCommand:
[legend]

Public Member Functions

def cancel_queued_send_commands (self)
 
def is_connected (cls)
 
def send_command (cls, device_id, action)
 
None set_rflink_protocol (cls, ProtocolBase|None protocol, bool|None wait_ack=None)
 
- 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)
 
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)
 
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)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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 Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

def _async_handle_command (self, command, *args)
 
def _async_send_command (self, cmd, repetitions)
 

Private Attributes

 _protocol
 
 _repetition_task
 
 _state
 
 _wait_ack
 

Additional Inherited Members

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

Detailed Description

Singleton class to make Rflink command interface available to entities.

This class is to be inherited by every Entity class that is actionable
(switches/lights). It exposes the Rflink command interface for these
entities.

The Rflink interface is managed as a class level and set during setup (and
reset on reconnect).

Definition at line 183 of file entity.py.

Member Function Documentation

◆ _async_handle_command()

def homeassistant.components.rflink.entity.RflinkCommand._async_handle_command (   self,
  command,
args 
)
private
Do bookkeeping for command, send it to rflink and update state.

Definition at line 221 of file entity.py.

◆ _async_send_command()

def homeassistant.components.rflink.entity.RflinkCommand._async_send_command (   self,
  cmd,
  repetitions 
)
private
Send a command for device to Rflink gateway.

Reimplemented in homeassistant.components.rflink.cover.InvertedRflinkCover.

Definition at line 276 of file entity.py.

◆ cancel_queued_send_commands()

def homeassistant.components.rflink.entity.RflinkCommand.cancel_queued_send_commands (   self)
Cancel queued signal repetition commands.

For example when user changed state while repetitions are still
queued for broadcast. Or when an incoming Rflink command (remote
switch) changes the state.

Definition at line 265 of file entity.py.

◆ is_connected()

def homeassistant.components.rflink.entity.RflinkCommand.is_connected (   cls)
Return connection status.

Definition at line 212 of file entity.py.

◆ send_command()

def homeassistant.components.rflink.entity.RflinkCommand.send_command (   cls,
  device_id,
  action 
)
Send device command to Rflink and wait for acknowledgement.

Definition at line 217 of file entity.py.

◆ set_rflink_protocol()

None homeassistant.components.rflink.entity.RflinkCommand.set_rflink_protocol (   cls,
ProtocolBase | None  protocol,
bool | None   wait_ack = None 
)
Set the Rflink asyncio protocol as a class variable.

Definition at line 203 of file entity.py.

Member Data Documentation

◆ _protocol

homeassistant.components.rflink.entity.RflinkCommand._protocol
private

Definition at line 207 of file entity.py.

◆ _repetition_task

homeassistant.components.rflink.entity.RflinkCommand._repetition_task
private

Definition at line 295 of file entity.py.

◆ _state

homeassistant.components.rflink.entity.RflinkCommand._state
private

Definition at line 227 of file entity.py.

◆ _wait_ack

homeassistant.components.rflink.entity.RflinkCommand._wait_ack
private

Definition at line 209 of file entity.py.

◆ None

homeassistant.components.rflink.entity.RflinkCommand.None
static

Definition at line 196 of file entity.py.


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