diff --git a/source/_integrations/command_line.markdown b/source/_integrations/command_line.markdown index 55cdbbac49f..0d11e957f71 100644 --- a/source/_integrations/command_line.markdown +++ b/source/_integrations/command_line.markdown @@ -18,7 +18,7 @@ ha_platforms: - switch ha_integration_type: integration ha_codeowners: - - "@gjohansson-ST" + - '@gjohansson-ST' --- The `command_line` offers functionality that issues specific commands to get data or to control a device. @@ -31,203 +31,203 @@ It's highly recommended to enclose the command in single quotes `'` as it ensure {% configuration %} command_line: -description: The platforms to use for you command_line integration. -required: true -type: list -keys: -binary_sensor: -description: Binary sensor platform. -required: false -type: map -keys: -command: -description: The action to take to get the value. -required: true -type: string -command_timeout: -description: Defines number of seconds for command timeout. -required: false -type: integer -default: 15 -device_class: -description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend. -required: false -type: string -name: -description: Let you overwrite the name of the device. -required: false -type: string -default: "_name_ from the device" -payload_on: -description: The payload that represents enabled state. -required: false -type: string -default: 'ON' -unique_id: -description: An ID that uniquely identifies this binary sensor. Set this to a unique value to allow customization through the UI. -required: false -type: string -payload_off: -description: The payload that represents disabled state. -required: false -type: string -default: 'OFF' -value_template: -description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. -required: false -type: string -scan_interval: -description: Define time in seconds between each update. -required: false -type: integer -default: 60 -cover: -description: Cover platform. -required: false -type: map -keys: -command_close: -description: The action to close the cover. -required: true -default: true -type: string -command_open: -description: The command to open the cover. -required: true -default: true -type: string -command_state: -description: If given, this will act as a sensor that runs in the background and updates the state of the cover. If the command returns a `0` the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open. -required: false -type: string -command_stop: -description: The action to stop the cover. -required: true -default: true -type: string -command_timeout: -description: Defines number of seconds for command timeout. -required: false -type: integer -default: 15 -name: -description: The name used to display the cover in the frontend. -required: true -type: string -unique_id: -description: An ID that uniquely identifies this cover. Set this to a unique value to allow customization through the UI. -required: false -type: string -value_template: -description: if specified, `command_state` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `command_state` returns a string "open", using `value_template` as in the example configuration above will allow you to translate that into the valid state `100`. -required: false -type: template -scan_interval: -description: Define time in seconds between each update. -required: false -type: integer -default: 15 -notify: -description: Notify platform. -required: false -type: map -keys: -name: -description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. -required: false -default: notify -type: string -command: -description: The action to take. -required: true -type: string -command_timeout: -description: Defines number of seconds for command timeout. -required: false -type: integer -default: 15 -sensor: -description: Sensor platform. -required: false -type: map -keys: -command: -description: The action to take to get the value. -required: true -type: string -command_timeout: -description: Defines number of seconds for command timeout -required: false -type: integer -default: 15 -json_attributes: -description: Defines a list of keys to extract values from a JSON dictionary result and then set as sensor attributes. -required: false -type: [string, list] -name: -description: Name of the command sensor. -required: false -type: string -unique_id: -description: An ID that uniquely identifies this sensor. Set this to a unique value to allow customization through the UI. -required: false -type: string -unit_of_measurement: -description: Defines the unit of measurement of the sensor, if any. -required: false -type: string -value_template: -description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." -required: false -type: string -scan_interval: -description: Define time in seconds between each update. -required: false -type: integer -default: 60 -switch: -description: Switch platform. -required: false -type: map -keys: -command_on: -description: The action to take for on. -required: true -type: string -command_off: -description: The action to take for off. -required: true -type: string -command_state: -description: "If given, this command will be run. Returning a result code `0` will indicate that the switch is on." -required: false -type: string -command_timeout: -description: Defines number of seconds for command timeout. -required: false -type: integer -default: 15 -name: -description: The name used to display the switch in the frontend. -required: true -type: string -icon_template: -description: Defines a template for the icon of the entity. -required: false -type: template -unique_id: -description: An ID that uniquely identifies this switch. Set this to a unique value to allow customization through the UI. -required: false -type: string -value_template: -description: "If specified, `command_state` will ignore the result code of the command but the template evaluating to `true` will indicate the switch is on." -required: false -type: string -scan_interval: -description: Define time in seconds between each update. -required: false -type: integer -default: 30 + description: The platforms to use for you command_line integration. + required: true + type: list + keys: + binary_sensor: + description: Binary sensor platform. + required: false + type: map + keys: + command: + description: The action to take to get the value. + required: true + type: string + command_timeout: + description: Defines number of seconds for command timeout. + required: false + type: integer + default: 15 + device_class: + description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend. + required: false + type: string + name: + description: Let you overwrite the name of the device. + required: false + type: string + default: "*name* from the device" + payload_on: + description: The payload that represents enabled state. + required: false + type: string + default: 'ON' + unique_id: + description: An ID that uniquely identifies this binary sensor. Set this to a unique value to allow customization through the UI. + required: false + type: string + payload_off: + description: The payload that represents disabled state. + required: false + type: string + default: 'OFF' + value_template: + description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. + required: false + type: string + scan_interval: + description: Define time in seconds between each update. + required: false + type: integer + default: 60 + cover: + description: Cover platform. + required: false + type: map + keys: + command_close: + description: The action to close the cover. + required: true + default: true + type: string + command_open: + description: The command to open the cover. + required: true + default: true + type: string + command_state: + description: If given, this will act as a sensor that runs in the background and updates the state of the cover. If the command returns a `0` the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open. + required: false + type: string + command_stop: + description: The action to stop the cover. + required: true + default: true + type: string + command_timeout: + description: Defines number of seconds for command timeout. + required: false + type: integer + default: 15 + name: + description: The name used to display the cover in the frontend. + required: true + type: string + unique_id: + description: An ID that uniquely identifies this cover. Set this to a unique value to allow customization through the UI. + required: false + type: string + value_template: + description: if specified, `command_state` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `command_state` returns a string "open", using `value_template` as in the example configuration above will allow you to translate that into the valid state `100`. + required: false + type: template + scan_interval: + description: Define time in seconds between each update. + required: false + type: integer + default: 15 + notify: + description: Notify platform. + required: false + type: map + keys: + name: + description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + required: false + default: notify + type: string + command: + description: The action to take. + required: true + type: string + command_timeout: + description: Defines number of seconds for command timeout. + required: false + type: integer + default: 15 + sensor: + description: Sensor platform. + required: false + type: map + keys: + command: + description: The action to take to get the value. + required: true + type: string + command_timeout: + description: Defines number of seconds for command timeout + required: false + type: integer + default: 15 + json_attributes: + description: Defines a list of keys to extract values from a JSON dictionary result and then set as sensor attributes. + required: false + type: [string, list] + name: + description: Name of the command sensor. + required: false + type: string + unique_id: + description: An ID that uniquely identifies this sensor. Set this to a unique value to allow customization through the UI. + required: false + type: string + unit_of_measurement: + description: Defines the unit of measurement of the sensor, if any. + required: false + type: string + value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." + required: false + type: string + scan_interval: + description: Define time in seconds between each update. + required: false + type: integer + default: 60 + switch: + description: Switch platform. + required: false + type: map + keys: + command_on: + description: The action to take for on. + required: true + type: string + command_off: + description: The action to take for off. + required: true + type: string + command_state: + description: "If given, this command will be run. Returning a result code `0` will indicate that the switch is on." + required: false + type: string + command_timeout: + description: Defines number of seconds for command timeout. + required: false + type: integer + default: 15 + name: + description: The name used to display the switch in the frontend. + required: true + type: string + icon_template: + description: Defines a template for the icon of the entity. + required: false + type: template + unique_id: + description: An ID that uniquely identifies this switch. Set this to a unique value to allow customization through the UI. + required: false + type: string + value_template: + description: "If specified, `command_state` will ignore the result code of the command but the template evaluating to `true` will indicate the switch is on." + required: false + type: string + scan_interval: + description: Define time in seconds between each update. + required: false + type: integer + default: 30 {% endconfiguration %} ## Binary sensor @@ -235,14 +235,12 @@ default: 30 To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file: {% raw %} - ```yaml # Example configuration.yaml entry command_line: - binary_sensor: command: "cat /proc/sys/net/ipv4/ip_forward" ``` - {% endraw%} ## Cover @@ -252,7 +250,6 @@ A `command_line`cover platform that issues specific commands when it is moved up To enable a command line cover in your installation, add the following to your `configuration.yaml` file: {% raw %} - ```yaml # Example configuration.yaml entry command_line: @@ -262,7 +259,6 @@ command_line: command_stop: move_command stop garage name: Garage ``` - {% endraw%} ## Notify @@ -272,14 +268,12 @@ The `command_line` platform allows you to use external tools for notifications f To enable those notifications in your installation, add the following to your `configuration.yaml` file: {% raw %} - ```yaml # Example configuration.yaml entry command_line: - notify: command: "espeak -vmb/mb-us1" ``` - {% endraw%} To use notifications, please see the [getting started with automation page](/getting-started/automation/). @@ -289,14 +283,12 @@ To use notifications, please see the [getting started with automation page](/get To enable it, add the following lines to your `configuration.yaml`: {% raw %} - ```yaml # Example configuration.yaml entry command_line: - sensor: command: SENSOR_COMMAND ``` - {% endraw%} ## Switch @@ -309,7 +301,6 @@ controlled from the command line, including calling other scripts! To enable it, add the following lines to your `configuration.yaml`: {% raw %} - ```yaml # Example configuration.yaml entry command_line: @@ -318,13 +309,12 @@ command_line: command_on: switch_command on kitchen command_off: switch_command off kitchen ``` - {% endraw%}