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

Namespaces

 binary_sensor
 
 const
 
 cover
 
 notify
 
 sensor
 
 switch
 
 utils
 

Functions

None async_load_platforms (HomeAssistant hass, list[dict[str, dict[str, Any]]] command_line_config, ConfigType config)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string BINARY_SENSOR_DEFAULT_NAME = "Binary Command Sensor"
 
 BINARY_SENSOR_SCHEMA
 
 COMBINED_SCHEMA
 
string CONF_NOTIFIERS = "notifiers"
 
 CONFIG_SCHEMA
 
 COVER_SCHEMA
 
string DEFAULT_PAYLOAD_OFF = "OFF"
 
string DEFAULT_PAYLOAD_ON = "ON"
 
 NOTIFY_SCHEMA
 
dictionary PLATFORM_MAPPING
 
string SENSOR_DEFAULT_NAME = "Command Sensor"
 
 SENSOR_SCHEMA
 
 SWITCH_SCHEMA
 

Detailed Description

The command_line component.

Function Documentation

◆ async_load_platforms()

None homeassistant.components.command_line.async_load_platforms ( HomeAssistant  hass,
list[dict[str, dict[str, Any]]]  command_line_config,
ConfigType  config 
) 
Load platforms from yaml.

Definition at line 205 of file __init__.py.

◆ async_setup()

bool homeassistant.components.command_line.async_setup ( HomeAssistant  hass,
ConfigType  config 
) 
Set up Command Line from yaml config.

Definition at line 184 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 85 of file __init__.py.

◆ BINARY_SENSOR_DEFAULT_NAME

string homeassistant.components.command_line.BINARY_SENSOR_DEFAULT_NAME = "Binary Command Sensor"

Definition at line 71 of file __init__.py.

◆ BINARY_SENSOR_SCHEMA

homeassistant.components.command_line.BINARY_SENSOR_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_COMMAND): cv.string,
4  vol.Optional(CONF_NAME, default=BINARY_SENSOR_DEFAULT_NAME): cv.string,
5  vol.Optional(CONF_ICON): cv.template,
6  vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
7  vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
8  vol.Optional(CONF_DEVICE_CLASS): BINARY_SENSOR_DEVICE_CLASSES_SCHEMA,
9  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
10  vol.Optional(CONF_COMMAND_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
11  vol.Optional(CONF_UNIQUE_ID): cv.string,
12  vol.Optional(
13  CONF_SCAN_INTERVAL, default=BINARY_SENSOR_DEFAULT_SCAN_INTERVAL
14  ): vol.All(cv.time_period, cv.positive_timedelta),
15  vol.Optional(CONF_AVAILABILITY): cv.template,
16  }
17 )

Definition at line 87 of file __init__.py.

◆ COMBINED_SCHEMA

homeassistant.components.command_line.COMBINED_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(BINARY_SENSOR_DOMAIN): BINARY_SENSOR_SCHEMA,
4  vol.Optional(COVER_DOMAIN): COVER_SCHEMA,
5  vol.Optional(NOTIFY_DOMAIN): NOTIFY_SCHEMA,
6  vol.Optional(SENSOR_DOMAIN): SENSOR_SCHEMA,
7  vol.Optional(SWITCH_DOMAIN): SWITCH_SCHEMA,
8  }
9 )

Definition at line 164 of file __init__.py.

◆ CONF_NOTIFIERS

string homeassistant.components.command_line.CONF_NOTIFIERS = "notifiers"

Definition at line 75 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.command_line.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(DOMAIN): vol.All(
4  cv.ensure_list,
5  [COMBINED_SCHEMA],
6  )
7  },
8  extra=vol.ALLOW_EXTRA,
9 )

Definition at line 173 of file __init__.py.

◆ COVER_SCHEMA

homeassistant.components.command_line.COVER_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_COMMAND_CLOSE, default="true"): cv.string,
4  vol.Optional(CONF_COMMAND_OPEN, default="true"): cv.string,
5  vol.Optional(CONF_COMMAND_STATE): cv.string,
6  vol.Optional(CONF_COMMAND_STOP, default="true"): cv.string,
7  vol.Required(CONF_NAME): cv.string,
8  vol.Optional(CONF_ICON): cv.template,
9  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
10  vol.Optional(CONF_COMMAND_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
11  vol.Optional(CONF_DEVICE_CLASS): COVER_DEVICE_CLASSES_SCHEMA,
12  vol.Optional(CONF_UNIQUE_ID): cv.string,
13  vol.Optional(CONF_SCAN_INTERVAL, default=COVER_DEFAULT_SCAN_INTERVAL): vol.All(
14  cv.time_period, cv.positive_timedelta
15  ),
16  vol.Optional(CONF_AVAILABILITY): cv.template,
17  }
18 )

Definition at line 104 of file __init__.py.

◆ DEFAULT_PAYLOAD_OFF

string homeassistant.components.command_line.DEFAULT_PAYLOAD_OFF = "OFF"

Definition at line 73 of file __init__.py.

◆ DEFAULT_PAYLOAD_ON

string homeassistant.components.command_line.DEFAULT_PAYLOAD_ON = "ON"

Definition at line 72 of file __init__.py.

◆ NOTIFY_SCHEMA

homeassistant.components.command_line.NOTIFY_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_COMMAND): cv.string,
4  vol.Optional(CONF_NAME): cv.string,
5  vol.Optional(CONF_COMMAND_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
6  }
7 )

Definition at line 122 of file __init__.py.

◆ PLATFORM_MAPPING

dictionary homeassistant.components.command_line.PLATFORM_MAPPING
Initial value:
1 = {
2  BINARY_SENSOR_DOMAIN: Platform.BINARY_SENSOR,
3  COVER_DOMAIN: Platform.COVER,
4  NOTIFY_DOMAIN: Platform.NOTIFY,
5  SENSOR_DOMAIN: Platform.SENSOR,
6  SWITCH_DOMAIN: Platform.SWITCH,
7 }

Definition at line 77 of file __init__.py.

◆ SENSOR_DEFAULT_NAME

string homeassistant.components.command_line.SENSOR_DEFAULT_NAME = "Command Sensor"

Definition at line 74 of file __init__.py.

◆ SENSOR_SCHEMA

homeassistant.components.command_line.SENSOR_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_COMMAND): cv.string,
4  vol.Optional(CONF_COMMAND_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
5  vol.Optional(CONF_JSON_ATTRIBUTES): cv.ensure_list_csv,
6  vol.Optional(CONF_JSON_ATTRIBUTES_PATH): cv.string,
7  vol.Optional(CONF_NAME, default=SENSOR_DEFAULT_NAME): cv.string,
8  vol.Optional(CONF_ICON): cv.template,
9  vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
10  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
11  vol.Optional(CONF_UNIQUE_ID): cv.string,
12  vol.Optional(CONF_DEVICE_CLASS): SENSOR_DEVICE_CLASSES_SCHEMA,
13  vol.Optional(CONF_STATE_CLASS): SENSOR_STATE_CLASSES_SCHEMA,
14  vol.Optional(CONF_SCAN_INTERVAL, default=SENSOR_DEFAULT_SCAN_INTERVAL): vol.All(
15  cv.time_period, cv.positive_timedelta
16  ),
17  vol.Optional(CONF_AVAILABILITY): cv.template,
18  }
19 )

Definition at line 129 of file __init__.py.

◆ SWITCH_SCHEMA

homeassistant.components.command_line.SWITCH_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_COMMAND_OFF, default="true"): cv.string,
4  vol.Optional(CONF_COMMAND_ON, default="true"): cv.string,
5  vol.Optional(CONF_COMMAND_STATE): cv.string,
6  vol.Required(CONF_NAME): cv.string,
7  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
8  vol.Optional(CONF_ICON): cv.template,
9  vol.Optional(CONF_COMMAND_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
10  vol.Optional(CONF_UNIQUE_ID): cv.string,
11  vol.Optional(CONF_SCAN_INTERVAL, default=SWITCH_DEFAULT_SCAN_INTERVAL): vol.All(
12  cv.time_period, cv.positive_timedelta
13  ),
14  vol.Optional(CONF_AVAILABILITY): cv.template,
15  }
16 )

Definition at line 148 of file __init__.py.