jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update configuration variables

Browse Source
This commit is contained in:
Fabian Affolter 2016-09-08 12:13:09 +02:00
parent 3ebaef2102
commit 8beaf8ba7e
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
2 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
source/_components/cover.command_line.markdown
View File

@ -22,11 +22,11 @@ To enable a command line cover in your installation, add the following to your `
cover: cover:
- platform: command_line - platform: command_line
covers: covers:
Garage door: garage_door:
opencmd: move_command up kitchen command_open: move_command up garage
closecmd: move_command down kitchen command_close: move_command down garage
stopcmd: move_command stop kitchen command_stop: move_command stop garage
statecmd: state_command kitchen command_state: state_command garage
value_template: {% raw %}> value_template: {% raw %}>
{% if value == 'open' %} {% if value == 'open' %}
100 100
@ -40,8 +40,9 @@ Configuration variables:
- **covers** (*Required*): The array that contains all command line covers. - **covers** (*Required*): The array that contains all command line covers.
- **entry** (*Required*): Name of the command line cover. Multiple entries are possible. - **entry** (*Required*): Name of the command line cover. Multiple entries are possible.
- **opencmd** (*Required*): The command to open the cover. - **command_open** (*Required*): The command to open the cover.
- **closecmd** (*Required*): The action to close the cover. - **command_close** (*Required*): The action to close the cover.
- **stopcmd** (*Required*): The action to stop the cover. - **command_stop** (*Required*): The action to stop the cover.
- **statecmd** (*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. - **command_state** (*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** (*optional - default: '{% raw %}{{ value }}{% endraw%}'*): if specified, `statecmd` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `statecmd` returns a string "open", using `value_template` as in the example config above will allow you to translate that into the valid state `100`. - **value_template** (*optional - default: '{% raw %}{{ value }}{% endraw%}'*): 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`.
- **friendly_name** (*Optional*): The name used to display the cover in the frontend.

32
source/_components/switch.command_line.markdown
View File

@ -24,20 +24,22 @@ switch:
platform: command_line platform: command_line
switches: switches:
kitchen_light: kitchen_light:
oncmd: switch_command on kitchen command_on: switch_command on kitchen
offcmd: switch_command off kitchen command_off: switch_command off kitchen
statecmd: query_command kitchen command_state: query_command kitchen
value_template: '{% raw %}{{ value == "online" }}{% endraw %}' value_template: '{% raw %}{{ value == "online" }}{% endraw %}'
friendly_name: Kitchen switch
``` ```
Configuration variables: Configuration variables:
- **switches** (*Required*): The array that contains all command switches. - **switches** (*Required*): The array that contains all command switches.
- **entry** (*Required*): Name of the command switch. Multiple entries are possible. - **entry** (*Required*): Name of the command switch. Multiple entries are possible.
- **oncmd** (*Required*): The action to take for on. - **command_on** (*Required*): The action to take for on.
- **offcmd** (*Required*): The action to take for off. - **command_off** (*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. - **command_state** (*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. - **value_template** (*Optional*): If specified, `command_state` will ignore the result code of the command but the template evaluating to `true` will indicate the switch is on.
- **friendly_name** (*Optional*): The name used to display the switch in the frontend.
## {% linkable_title Examples %} ## {% linkable_title Examples %}
@ -53,8 +55,8 @@ switch:
platform: command_line platform: command_line
switches: switches:
arest_pin4: arest_pin4:
oncmd: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/1" command_on: "/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" command_off: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/0"
``` ```
### {% linkable_title Shutdown your local host %} ### {% linkable_title Shutdown your local host %}
@ -72,7 +74,7 @@ switch:
platform: command_line platform: command_line
switches: switches:
Home Assistant system shutdown: Home Assistant system shutdown:
offcmd: "/usr/sbin/poweroff" command_off: "/usr/sbin/poweroff"
``` ```
### {% linkable_title Control your VLC player %} ### {% linkable_title Control your VLC player %}
@ -86,8 +88,8 @@ switch:
platform: command_line platform: command_line
switches: switches:
VLC: VLC:
oncmd: "cvlc 1.mp3 vlc://quit &" command_on: "cvlc 1.mp3 vlc://quit &"
offcmd: "pkill vlc" command_off: "pkill vlc"
``` ```
### {% linkable_title Control Foscam Motion Sensor %} ### {% linkable_title Control Foscam Motion Sensor %}
@ -100,9 +102,9 @@ switch:
platform: command_line platform: command_line
switches: switches:
foscam_motion: foscam_motion:
oncmd: 'curl -k "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&isEnable=1&usr=admin&pwd=password"' command_on: '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"' command_off: '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>)"' command_state: 'curl -k --silent "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=getMotionDetectConfig&usr=admin&pwd=password" | grep -oP "(?<=isEnable>).*?(?=</isEnable>)"'
value_template: {% raw %}'{{ value == "1" }}'{% endraw %} value_template: {% raw %}'{{ value == "1" }}'{% endraw %}
``` ```