Home Assistant Unofficial Reference 2024.12.1
Namespaces | Classes | Functions | Variables
homeassistant.components.remote Namespace Reference

Namespaces

 device_action
 
 device_condition
 
 device_trigger
 
 reproduce_state
 
 significant_change
 

Classes

class  RemoteEntity
 
class  RemoteEntityDescription
 
class  RemoteEntityFeature
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
bool is_on (HomeAssistant hass, str entity_id)
 

Variables

 __all__ = all_with_deprecated_constants(globals())
 
 __dir__
 
 __getattr__ = ft.partial(check_if_deprecated_constant, module_globals=globals())
 
 _DEPRECATED_SUPPORT_ACTIVITY
 
 _DEPRECATED_SUPPORT_DELETE_COMMAND
 
 _DEPRECATED_SUPPORT_LEARN_COMMAND
 
 _LOGGER = logging.getLogger(__name__)
 
string ATTR_ACTIVITY = "activity"
 
string ATTR_ACTIVITY_LIST = "activity_list"
 
string ATTR_ALTERNATIVE = "alternative"
 
string ATTR_COMMAND_TYPE = "command_type"
 
string ATTR_CURRENT_ACTIVITY = "current_activity"
 
string ATTR_DELAY_SECS = "delay_secs"
 
string ATTR_DEVICE = "device"
 
string ATTR_HOLD_SECS = "hold_secs"
 
string ATTR_NUM_REPEATS = "num_repeats"
 
string ATTR_TIMEOUT = "timeout"
 
dictionary CACHED_PROPERTIES_WITH_ATTR_
 
float DEFAULT_DELAY_SECS = 0.4
 
int DEFAULT_HOLD_SECS = 0
 
int DEFAULT_NUM_REPEATS = 1
 
string DOMAIN = "remote"
 
string ENTITY_ID_FORMAT = DOMAIN + ".{}"
 
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
 
 PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
 
 REMOTE_SERVICE_ACTIVITY_SCHEMA
 
 SCAN_INTERVAL = timedelta(seconds=30)
 
string SERVICE_DELETE_COMMAND = "delete_command"
 
string SERVICE_LEARN_COMMAND = "learn_command"
 
string SERVICE_SEND_COMMAND = "send_command"
 
string SERVICE_SYNC = "sync"
 

Detailed Description

Support to interface with universal remote control devices.

Function Documentation

◆ async_setup()

bool homeassistant.components.remote.async_setup ( HomeAssistant  hass,
ConfigType  config 
) 
Track states and offer events for remotes.

Definition at line 101 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.remote.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Set up a config entry.

Definition at line 158 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.remote.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Unload a config entry.

Definition at line 163 of file __init__.py.

◆ is_on()

bool homeassistant.components.remote.is_on ( HomeAssistant  hass,
str  entity_id 
) 
Return if the remote is on based on the statemachine.

Definition at line 96 of file __init__.py.

Variable Documentation

◆ __all__

homeassistant.components.remote.__all__ = all_with_deprecated_constants(globals())
private

Definition at line 261 of file __init__.py.

◆ __dir__

homeassistant.components.remote.__dir__
private
Initial value:
1 = ft.partial(
2  dir_with_deprecated_constants, module_globals_keys=[*globals().keys()]
3 )

Definition at line 258 of file __init__.py.

◆ __getattr__

homeassistant.components.remote.__getattr__ = ft.partial(check_if_deprecated_constant, module_globals=globals())
private

Definition at line 257 of file __init__.py.

◆ _DEPRECATED_SUPPORT_ACTIVITY

homeassistant.components.remote._DEPRECATED_SUPPORT_ACTIVITY
private
Initial value:
1 = DeprecatedConstantEnum(
2  RemoteEntityFeature.ACTIVITY, "2025.1"
3 )

Definition at line 85 of file __init__.py.

◆ _DEPRECATED_SUPPORT_DELETE_COMMAND

homeassistant.components.remote._DEPRECATED_SUPPORT_DELETE_COMMAND
private
Initial value:
1 = DeprecatedConstantEnum(
2  RemoteEntityFeature.DELETE_COMMAND, "2025.1"
3 )

Definition at line 82 of file __init__.py.

◆ _DEPRECATED_SUPPORT_LEARN_COMMAND

homeassistant.components.remote._DEPRECATED_SUPPORT_LEARN_COMMAND
private
Initial value:
1 = DeprecatedConstantEnum(
2  RemoteEntityFeature.LEARN_COMMAND, "2025.1"
3 )

Definition at line 79 of file __init__.py.

◆ _LOGGER

homeassistant.components.remote._LOGGER = logging.getLogger(__name__)
private

Definition at line 37 of file __init__.py.

◆ ATTR_ACTIVITY

string homeassistant.components.remote.ATTR_ACTIVITY = "activity"

Definition at line 46 of file __init__.py.

◆ ATTR_ACTIVITY_LIST

string homeassistant.components.remote.ATTR_ACTIVITY_LIST = "activity_list"

Definition at line 47 of file __init__.py.

◆ ATTR_ALTERNATIVE

string homeassistant.components.remote.ATTR_ALTERNATIVE = "alternative"

Definition at line 54 of file __init__.py.

◆ ATTR_COMMAND_TYPE

string homeassistant.components.remote.ATTR_COMMAND_TYPE = "command_type"

Definition at line 49 of file __init__.py.

◆ ATTR_CURRENT_ACTIVITY

string homeassistant.components.remote.ATTR_CURRENT_ACTIVITY = "current_activity"

Definition at line 48 of file __init__.py.

◆ ATTR_DELAY_SECS

string homeassistant.components.remote.ATTR_DELAY_SECS = "delay_secs"

Definition at line 52 of file __init__.py.

◆ ATTR_DEVICE

string homeassistant.components.remote.ATTR_DEVICE = "device"

Definition at line 50 of file __init__.py.

◆ ATTR_HOLD_SECS

string homeassistant.components.remote.ATTR_HOLD_SECS = "hold_secs"

Definition at line 53 of file __init__.py.

◆ ATTR_NUM_REPEATS

string homeassistant.components.remote.ATTR_NUM_REPEATS = "num_repeats"

Definition at line 51 of file __init__.py.

◆ ATTR_TIMEOUT

string homeassistant.components.remote.ATTR_TIMEOUT = "timeout"

Definition at line 55 of file __init__.py.

◆ CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.remote.CACHED_PROPERTIES_WITH_ATTR_
Initial value:
1 = {
2  "supported_features",
3  "current_activity",
4  "activity_list",
5 }

Definition at line 172 of file __init__.py.

◆ DEFAULT_DELAY_SECS

float homeassistant.components.remote.DEFAULT_DELAY_SECS = 0.4

Definition at line 65 of file __init__.py.

◆ DEFAULT_HOLD_SECS

int homeassistant.components.remote.DEFAULT_HOLD_SECS = 0

Definition at line 66 of file __init__.py.

◆ DEFAULT_NUM_REPEATS

int homeassistant.components.remote.DEFAULT_NUM_REPEATS = 1

Definition at line 64 of file __init__.py.

◆ DOMAIN

string homeassistant.components.remote.DOMAIN = "remote"

Definition at line 39 of file __init__.py.

◆ ENTITY_ID_FORMAT

string homeassistant.components.remote.ENTITY_ID_FORMAT = DOMAIN + ".{}"

Definition at line 41 of file __init__.py.

◆ MIN_TIME_BETWEEN_SCANS

homeassistant.components.remote.MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)

Definition at line 57 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.remote.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 42 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.remote.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 43 of file __init__.py.

◆ REMOTE_SERVICE_ACTIVITY_SCHEMA

homeassistant.components.remote.REMOTE_SERVICE_ACTIVITY_SCHEMA
Initial value:
1 = cv.make_entity_service_schema(
2  {vol.Optional(ATTR_ACTIVITY): cv.string}
3 )

Definition at line 90 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.remote.SCAN_INTERVAL = timedelta(seconds=30)

Definition at line 44 of file __init__.py.

◆ SERVICE_DELETE_COMMAND

string homeassistant.components.remote.SERVICE_DELETE_COMMAND = "delete_command"

Definition at line 61 of file __init__.py.

◆ SERVICE_LEARN_COMMAND

string homeassistant.components.remote.SERVICE_LEARN_COMMAND = "learn_command"

Definition at line 60 of file __init__.py.

◆ SERVICE_SEND_COMMAND

string homeassistant.components.remote.SERVICE_SEND_COMMAND = "send_command"

Definition at line 59 of file __init__.py.

◆ SERVICE_SYNC

string homeassistant.components.remote.SERVICE_SYNC = "sync"

Definition at line 62 of file __init__.py.