From 40aa661340c0d30529eb736e38ca4b3bcf8929a7 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 12 Sep 2015 08:54:28 +0200 Subject: [PATCH] Update docsstring --- .../components/switch/command_switch.py | 32 ++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/homeassistant/components/switch/command_switch.py b/homeassistant/components/switch/command_switch.py index 4d5aeba94f5..c0a8afa7419 100644 --- a/homeassistant/components/switch/command_switch.py +++ b/homeassistant/components/switch/command_switch.py @@ -2,8 +2,38 @@ """ homeassistant.components.switch.command_switch ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Allows to configure custom shell commands to turn a switch on/off. + +Configuration: + +To use the command_line switch you will need to add something like the +following to your configuration.yaml file. + +switch: + platform: command_switch + switches: + name_of_the_switch: + oncmd: switch_command on for name_of_the_switch + offcmd: switch_command off for name_of_the_switch + +Variables: + +These are the variables for the switches array: + +name_of_the_switch +*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. + +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/switch.command_switch.html """ import logging from homeassistant.components.switch import SwitchDevice