home-assistant.io/source/components/switch.command_switch.markdown

layout	title	description	date	sidebar	comments	sharing	footer
page	Command line switches support	Instructions how to have a switch call command line commands.	2015-06-10 22:41	false	false	true	true

A switch platform that issues specific commands when it is turned on and off. This might very well become our most 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_switch
  switches:
    kitchen_light:
      oncmd: switch_command on kitchen
      offcmd: switch_command off kitchen

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.

{% 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](http://curl.haxx.se/) is used to toogle a pin which is controllable through REST.

# Example configuration.yaml entry
switch:
  platform: command_switch
  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 shudown your host immediately, there will be no confirmation.

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