Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.rfxtrx.device_action Namespace Reference

Functions

tuple[dict[str, str], Callable[..., None]] _get_commands (HomeAssistant hass, str device_id, str action_type)
 
None async_call_action_from_config (HomeAssistant hass, ConfigType config, TemplateVarsType variables, Context|None context)
 
list[dict[str, str]] async_get_actions (HomeAssistant hass, str device_id)
 
ConfigType async_validate_action_config (HomeAssistant hass, ConfigType config)
 

Variables

 ACTION_SCHEMA
 
dictionary ACTION_SELECTION
 
string ACTION_TYPE_COMMAND = "send_command"
 
string ACTION_TYPE_STATUS = "send_status"
 
dictionary ACTION_TYPES
 
string CONF_DATA = "data"
 
string CONF_SUBTYPE = "subtype"
 

Detailed Description

Provides device automations for RFXCOM RFXtrx.

Function Documentation

◆ _get_commands()

tuple[dict[str, str], Callable[..., None]] homeassistant.components.rfxtrx.device_action._get_commands ( HomeAssistant  hass,
str  device_id,
str   action_type 
)
private

Definition at line 65 of file device_action.py.

◆ async_call_action_from_config()

None homeassistant.components.rfxtrx.device_action.async_call_action_from_config ( HomeAssistant  hass,
ConfigType  config,
TemplateVarsType  variables,
Context | None  context 
)
Execute a device action.

Definition at line 90 of file device_action.py.

◆ async_get_actions()

list[dict[str, str]] homeassistant.components.rfxtrx.device_action.async_get_actions ( HomeAssistant  hass,
str   device_id 
)
List device actions for RFXCOM RFXtrx devices.

Definition at line 42 of file device_action.py.

◆ async_validate_action_config()

ConfigType homeassistant.components.rfxtrx.device_action.async_validate_action_config ( HomeAssistant  hass,
ConfigType   config 
)
Validate config.

Definition at line 74 of file device_action.py.

Variable Documentation

◆ ACTION_SCHEMA

homeassistant.components.rfxtrx.device_action.ACTION_SCHEMA
Initial value:
1 = cv.DEVICE_ACTION_BASE_SCHEMA.extend(
2  {
3  vol.Required(CONF_TYPE): vol.In(ACTION_TYPES),
4  vol.Required(CONF_SUBTYPE): str,
5  }
6 )

Definition at line 34 of file device_action.py.

◆ ACTION_SELECTION

dictionary homeassistant.components.rfxtrx.device_action.ACTION_SELECTION
Initial value:
1 = {
2  ACTION_TYPE_COMMAND: "COMMANDS",
3  ACTION_TYPE_STATUS: "STATUS",
4 }

Definition at line 29 of file device_action.py.

◆ ACTION_TYPE_COMMAND

string homeassistant.components.rfxtrx.device_action.ACTION_TYPE_COMMAND = "send_command"

Definition at line 21 of file device_action.py.

◆ ACTION_TYPE_STATUS

string homeassistant.components.rfxtrx.device_action.ACTION_TYPE_STATUS = "send_status"

Definition at line 22 of file device_action.py.

◆ ACTION_TYPES

dictionary homeassistant.components.rfxtrx.device_action.ACTION_TYPES
Initial value:
1 = {
2  ACTION_TYPE_COMMAND,
3  ACTION_TYPE_STATUS,
4 }

Definition at line 24 of file device_action.py.

◆ CONF_DATA

string homeassistant.components.rfxtrx.device_action.CONF_DATA = "data"

Definition at line 18 of file device_action.py.

◆ CONF_SUBTYPE

string homeassistant.components.rfxtrx.device_action.CONF_SUBTYPE = "subtype"

Definition at line 19 of file device_action.py.