Command Line Cover


A command_linecover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line.

To enable a command line cover in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
cover:
  - platform: command_line
    covers:
      garage_door:
        command_open: move_command up garage
        command_close: move_command down garage
        command_stop: move_command stop garage

Configuration Variables

covers

(list)(Required)The array that contains all command line covers.

identifier

(list)(Required)Name of the command line cover as slug. Multiple entries are possible.

command_open

(string)(Required)The command to open the cover.

Default value: true

command_close

(string)(Required)The action to close the cover.

Default value: true

command_stop

(string)(Required)The action to stop the cover.

Default value: true

command_state

(string)(Optional)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.

value_template

(template)(Optional)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 config above will allow you to translate that into the valid state 100.

Default value: ‘{{ value }}’

friendly_name

(string)(Optional)The name used to display the cover in the frontend.

Examples

In this section you find some real-life examples of how to use this sensor.

Full configuration

# Example configuration.yaml entry
cover:
  - platform: command_line
    covers:
      garage_door:
        command_open: move_command up garage
        command_close: move_command down garage
        command_stop: move_command stop garage
        command_state: state_command garage
        value_template: >
          {% if value == 'open' %}
          100
          {% elif value == 'closed' %}
          0
          {% endif %}