home-assistant.io/source/_components/switch.command_line.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category
page	Command line Switch	Instructions how to have switches call command line commands.	2015-06-10 22:41	true	false	true	true	command_line.png	Switch

A switch platform that issues specific commands when it is turned on and off. This might very well become our most powerful platform as it allows anyone to integrate any type of switch into Home Assistant that can be controlled from the command line, including calling other scripts!

To enable it, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
switch:
  platform: command_line
  switches:
    kitchen_light:
      oncmd: switch_command on kitchen
      offcmd: switch_command off kitchen
      statecmd: query_command kitchen
      value_template: '{% raw %}{{ value == "online" }}{% endraw %}'

Configuration variables:

• switches (Required): The array that contains all command switches.
  • entry (Required): Name of the command switch. Multiple entries are possible.
    • oncmd (Required): The action to take for on.
    • offcmd (Required): The action to take for off.
    • statecmd (Optional): If given, this command will be run. Returning a result code 0 will indicate that the switch is on.
    • value_template (Optional): If specified, statecmd will ignore the result code of the command but the template evaluating to true will indicate the switch is on.

{% linkable_title Examples %}

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

{% linkable_title aREST device %}

The example below is doing the same as the aREST switch. The commandline tool curl is used to toogle a pin which is controllable through REST.

# Example configuration.yaml entry
switch:
  platform: command_line
  switches:
    arest_pin4:
      oncmd: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/1"
      offcmd: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/0"

{% linkable_title Shutdown your local host %}

This switch will shutdown your system that is hosting Home Assistant.

This switch will shutdown your host immediately, there will be no confirmation.

# Example configuration.yaml entry
switch:
  platform: command_line
  switches:
    Home Assistant system shutdown:
      offcmd: "/usr/sbin/poweroff"

{% linkable_title Control your VLC player %}

This switch will control a local VLC media player (Source).

# Example configuration.yaml entry
switch:
  platform: command_line
  switches:
    VLC:
      oncmd: "cvlc 1.mp3 vlc://quit &"
      offcmd: "pkill vlc"

{% linkable_title Control Foscam Motion Sensor %}

This switch will control the motion sensor of Foscam Webcams which Support CGI Commands (Source). This switch supports statecmd, which checks the current state of motion detection.

# Example configuration.yaml entry
# Replace admin and password with an "Admin" priviledged Foscam user
# Replace ipaddress with the local IP address of your Foscam
switch:
  platform: command_line
  switches:
    foscam_motion:
      oncmd: 'curl -k "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&isEnable=1&usr=admin&pwd=password"'
      offcmd: 'curl -k "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&isEnable=0&usr=admin&pwd=password"'
      statecmd: 'curl -k --silent "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=getMotionDetectConfig&usr=admin&pwd=password" | grep -oP "(?<=isEnable>).*?(?=</isEnable>)"'
      value_template: '{{ value == "1" }}'