mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Add scan_interval option to Command line (#27580)
This commit is contained in:
G Johansson
Franck Nijhof
parent
718a2e49f9
commit
9f95073041
@ -18,7 +18,7 @@ ha_platforms:
|
||||
- switch
|
||||
ha_integration_type: integration
|
||||
ha_codeowners:
|
||||
- '@gjohansson-ST'
|
||||
- "@gjohansson-ST"
|
||||
---
|
||||
|
||||
The `command_line` offers functionality that issues specific commands to get data or to control a device.
|
||||
@ -31,183 +31,203 @@ It's highly recommended to enclose the command in single quotes `'` as it ensure
|
||||
|
||||
{% configuration %}
|
||||
command_line:
|
||||
description: The platforms to use for you command_line integration.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
binary_sensor:
|
||||
description: Binary sensor platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
command:
|
||||
description: The action to take to get the value.
|
||||
required: true
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
device_class:
|
||||
description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend.
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
description: Let you overwrite the name of the device.
|
||||
required: false
|
||||
type: string
|
||||
default: "*name* from the device"
|
||||
payload_on:
|
||||
description: The payload that represents enabled state.
|
||||
required: false
|
||||
type: string
|
||||
default: 'ON'
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this binary sensor. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
payload_off:
|
||||
description: The payload that represents disabled state.
|
||||
required: false
|
||||
type: string
|
||||
default: 'OFF'
|
||||
value_template:
|
||||
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
|
||||
required: false
|
||||
type: string
|
||||
cover:
|
||||
description: Cover platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
command_close:
|
||||
description: The action to close the cover.
|
||||
required: true
|
||||
default: true
|
||||
type: string
|
||||
command_open:
|
||||
description: The command to open the cover.
|
||||
required: true
|
||||
default: true
|
||||
type: string
|
||||
command_state:
|
||||
description: 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.
|
||||
required: false
|
||||
type: string
|
||||
command_stop:
|
||||
description: The action to stop the cover.
|
||||
required: true
|
||||
default: true
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
name:
|
||||
description: The name used to display the cover in the frontend.
|
||||
required: true
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this cover. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
value_template:
|
||||
description: 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 configuration above will allow you to translate that into the valid state `100`.
|
||||
required: false
|
||||
type: template
|
||||
notify:
|
||||
description: Notify platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
required: false
|
||||
default: notify
|
||||
type: string
|
||||
command:
|
||||
description: The action to take.
|
||||
required: true
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
sensor:
|
||||
description: Sensor platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
command:
|
||||
description: The action to take to get the value.
|
||||
required: true
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
json_attributes:
|
||||
description: Defines a list of keys to extract values from a JSON dictionary result and then set as sensor attributes.
|
||||
required: false
|
||||
type: [string, list]
|
||||
name:
|
||||
description: Name of the command sensor.
|
||||
required: false
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
unit_of_measurement:
|
||||
description: Defines the unit of measurement of the sensor, if any.
|
||||
required: false
|
||||
type: string
|
||||
value_template:
|
||||
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload."
|
||||
required: false
|
||||
type: string
|
||||
switch:
|
||||
description: Switch platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
command_on:
|
||||
description: The action to take for on.
|
||||
required: true
|
||||
type: string
|
||||
command_off:
|
||||
description: The action to take for off.
|
||||
required: true
|
||||
type: string
|
||||
command_state:
|
||||
description: "If given, this command will be run. Returning a result code `0` will indicate that the switch is on."
|
||||
required: false
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
name:
|
||||
description: The name used to display the switch in the frontend.
|
||||
required: true
|
||||
type: string
|
||||
icon_template:
|
||||
description: Defines a template for the icon of the entity.
|
||||
required: false
|
||||
type: template
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this switch. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
value_template:
|
||||
description: "If specified, `command_state` will ignore the result code of the command but the template evaluating to `true` will indicate the switch is on."
|
||||
required: false
|
||||
type: string
|
||||
description: The platforms to use for you command_line integration.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
binary_sensor:
|
||||
description: Binary sensor platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
command:
|
||||
description: The action to take to get the value.
|
||||
required: true
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
device_class:
|
||||
description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend.
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
description: Let you overwrite the name of the device.
|
||||
required: false
|
||||
type: string
|
||||
default: "_name_ from the device"
|
||||
payload_on:
|
||||
description: The payload that represents enabled state.
|
||||
required: false
|
||||
type: string
|
||||
default: 'ON'
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this binary sensor. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
payload_off:
|
||||
description: The payload that represents disabled state.
|
||||
required: false
|
||||
type: string
|
||||
default: 'OFF'
|
||||
value_template:
|
||||
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
|
||||
required: false
|
||||
type: string
|
||||
scan_interval:
|
||||
description: Define time in seconds between each update.
|
||||
required: false
|
||||
type: integer
|
||||
default: 60
|
||||
cover:
|
||||
description: Cover platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
command_close:
|
||||
description: The action to close the cover.
|
||||
required: true
|
||||
default: true
|
||||
type: string
|
||||
command_open:
|
||||
description: The command to open the cover.
|
||||
required: true
|
||||
default: true
|
||||
type: string
|
||||
command_state:
|
||||
description: 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.
|
||||
required: false
|
||||
type: string
|
||||
command_stop:
|
||||
description: The action to stop the cover.
|
||||
required: true
|
||||
default: true
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
name:
|
||||
description: The name used to display the cover in the frontend.
|
||||
required: true
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this cover. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
value_template:
|
||||
description: 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 configuration above will allow you to translate that into the valid state `100`.
|
||||
required: false
|
||||
type: template
|
||||
scan_interval:
|
||||
description: Define time in seconds between each update.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
notify:
|
||||
description: Notify platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
required: false
|
||||
default: notify
|
||||
type: string
|
||||
command:
|
||||
description: The action to take.
|
||||
required: true
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
sensor:
|
||||
description: Sensor platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
command:
|
||||
description: The action to take to get the value.
|
||||
required: true
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
json_attributes:
|
||||
description: Defines a list of keys to extract values from a JSON dictionary result and then set as sensor attributes.
|
||||
required: false
|
||||
type: [string, list]
|
||||
name:
|
||||
description: Name of the command sensor.
|
||||
required: false
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this sensor. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
unit_of_measurement:
|
||||
description: Defines the unit of measurement of the sensor, if any.
|
||||
required: false
|
||||
type: string
|
||||
value_template:
|
||||
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload."
|
||||
required: false
|
||||
type: string
|
||||
scan_interval:
|
||||
description: Define time in seconds between each update.
|
||||
required: false
|
||||
type: integer
|
||||
default: 60
|
||||
switch:
|
||||
description: Switch platform.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
command_on:
|
||||
description: The action to take for on.
|
||||
required: true
|
||||
type: string
|
||||
command_off:
|
||||
description: The action to take for off.
|
||||
required: true
|
||||
type: string
|
||||
command_state:
|
||||
description: "If given, this command will be run. Returning a result code `0` will indicate that the switch is on."
|
||||
required: false
|
||||
type: string
|
||||
command_timeout:
|
||||
description: Defines number of seconds for command timeout.
|
||||
required: false
|
||||
type: integer
|
||||
default: 15
|
||||
name:
|
||||
description: The name used to display the switch in the frontend.
|
||||
required: true
|
||||
type: string
|
||||
icon_template:
|
||||
description: Defines a template for the icon of the entity.
|
||||
required: false
|
||||
type: template
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this switch. Set this to a unique value to allow customization through the UI.
|
||||
required: false
|
||||
type: string
|
||||
value_template:
|
||||
description: "If specified, `command_state` will ignore the result code of the command but the template evaluating to `true` will indicate the switch is on."
|
||||
required: false
|
||||
type: string
|
||||
scan_interval:
|
||||
description: Define time in seconds between each update.
|
||||
required: false
|
||||
type: integer
|
||||
default: 30
|
||||
{% endconfiguration %}
|
||||
|
||||
## Binary sensor
|
||||
@ -215,12 +235,14 @@ command_line:
|
||||
To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
- binary_sensor:
|
||||
command: "cat /proc/sys/net/ipv4/ip_forward"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
## Cover
|
||||
@ -230,6 +252,7 @@ A `command_line`cover platform that issues specific commands when it is moved up
|
||||
To enable a command line cover in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -239,6 +262,7 @@ command_line:
|
||||
command_stop: move_command stop garage
|
||||
name: Garage
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
## Notify
|
||||
@ -248,12 +272,14 @@ The `command_line` platform allows you to use external tools for notifications f
|
||||
To enable those notifications in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
- notify:
|
||||
command: "espeak -vmb/mb-us1"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
@ -263,12 +289,14 @@ To use notifications, please see the [getting started with automation page](/get
|
||||
To enable it, add the following lines to your `configuration.yaml`:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
- sensor:
|
||||
command: SENSOR_COMMAND
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
## Switch
|
||||
@ -281,6 +309,7 @@ controlled from the command line, including calling other scripts!
|
||||
To enable it, add the following lines to your `configuration.yaml`:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -289,6 +318,7 @@ command_line:
|
||||
command_on: switch_command on kitchen
|
||||
command_off: switch_command off kitchen
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
<div class='note'>
|
||||
@ -322,6 +352,7 @@ In this section you find some real-life examples of how to use the command_line
|
||||
Check the state of an [SickRage](https://github.com/sickragetv/sickrage) instance.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -332,6 +363,7 @@ command_line:
|
||||
payload_on: "Running"
|
||||
payload_off: "Not running"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Check RasPlex
|
||||
@ -339,6 +371,7 @@ command_line:
|
||||
Check if [RasPlex](https://github.com/RasPlex/RasPlex) is `online`.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
command_line:
|
||||
- binary_sensor:
|
||||
@ -348,20 +381,23 @@ command_line:
|
||||
payload_on: 1
|
||||
payload_off: 0
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
An alternative solution could look like this:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
command_line:
|
||||
- binary_sensor:
|
||||
name: Printer
|
||||
command: 'ping -W 1 -c 1 192.168.1.10 > /dev/null 2>&1 && echo success || echo fail'
|
||||
command: "ping -W 1 -c 1 192.168.1.10 > /dev/null 2>&1 && echo success || echo fail"
|
||||
device_class: connectivity
|
||||
payload_on: "success"
|
||||
payload_off: "fail"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
Consider to use the [ping sensor](/integrations/ping#binary-sensor) as an alternative to the samples above.
|
||||
@ -371,6 +407,7 @@ Consider to use the [ping sensor](/integrations/ping#binary-sensor) as an altern
|
||||
The services running is listed in `/etc/systemd/system` and can be checked with the `systemctl` command:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```bash
|
||||
$ systemctl is-active home-assistant@rock64.service
|
||||
active
|
||||
@ -378,23 +415,27 @@ $ sudo service home-assistant@rock64.service stop
|
||||
$ systemctl is-active home-assistant@rock64.service
|
||||
inactive
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
A binary command line sensor can check this:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
command_line:
|
||||
- binary_sensor:
|
||||
command: '/bin/systemctl is-active home-assistant@rock64.service'
|
||||
command: "/bin/systemctl is-active home-assistant@rock64.service"
|
||||
payload_on: "active"
|
||||
payload_off: "inactive"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
## Example cover platform
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -411,6 +452,7 @@ command_line:
|
||||
0
|
||||
{% endif %}
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
## Examples sensor platform
|
||||
@ -422,6 +464,7 @@ In this section you find some real-life examples of how to use this sensor.
|
||||
Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your `configuration.yaml` file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -432,6 +475,7 @@ command_line:
|
||||
unit_of_measurement: "°C"
|
||||
value_template: "{{ value | multiply(0.001) | round(1) }}"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Monitoring failed login attempts on Home Assistant
|
||||
@ -439,6 +483,7 @@ command_line:
|
||||
If you'd like to know how many failed login attempts are made to Home Assistant, add the following to your `configuration.yaml` file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -446,11 +491,13 @@ command_line:
|
||||
name: Badlogin
|
||||
command: "grep -c 'Login attempt' /home/hass/.homeassistant/home-assistant.log"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
Make sure to configure the [Logger integration](/integrations/logger) to monitor the [HTTP integration](/integrations/http/) at least the `warning` level.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example working logger settings that works
|
||||
logger:
|
||||
@ -458,6 +505,7 @@ logger:
|
||||
logs:
|
||||
homeassistant.components.http: warning
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Details about the upstream Home Assistant release
|
||||
@ -465,12 +513,14 @@ logger:
|
||||
You can see directly in the frontend (**Developer tools** -> **About**) what release of Home Assistant you are running. The Home Assistant releases are available on the [Python Package Index](https://pypi.python.org/pypi). This makes it possible to get the current release.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
command_line:
|
||||
- sensor:
|
||||
command: python3 -c "import requests; print(requests.get('https://pypi.python.org/pypi/homeassistant/json').json()['info']['version'])"
|
||||
name: HA release
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Read value out of a remote text file
|
||||
@ -478,12 +528,14 @@ command_line:
|
||||
If you own devices which are storing values in text files which are accessible over HTTP then you can use the same approach as shown in the previous section. Instead of looking at the JSON response we directly grab the sensor's value.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
command_line:
|
||||
- sensor:
|
||||
command: python3 -c "import requests; print(requests.get('http://remote-host/sensor_data.txt').text)"
|
||||
name: File value
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Use an external script
|
||||
@ -493,14 +545,17 @@ The example is doing the same as the [aREST sensor](/integrations/arest#sensor)
|
||||
The one-line script to retrieve a value is shown below. Of course it would be possible to use this directly in the `configuration.yaml` file but need extra care about the quotation marks.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```bash
|
||||
python3 -c "import requests; print(requests.get('http://10.0.0.48/analog/2').json()['return_value'])"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
The script (saved as `arest-value.py`) that is used looks like the example below.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```python
|
||||
#!/usr/bin/python3
|
||||
from requests import get
|
||||
@ -508,11 +563,13 @@ from requests import get
|
||||
response = get("http://10.0.0.48/analog/2")
|
||||
print(response.json()["return_value"])
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
To use the script you need to add something like the following to your `configuration.yaml` file.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -520,6 +577,7 @@ command_line:
|
||||
name: Brightness
|
||||
command: "python3 /path/to/script/arest-value.py"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Usage of templating in `command:`
|
||||
@ -527,6 +585,7 @@ command_line:
|
||||
[Templates](/docs/configuration/templating/) are supported in the `command` configuration variable. This could be used if you want to include the state of a specific sensor as an argument to your external script.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -535,6 +594,7 @@ command_line:
|
||||
command: "sh /home/pi/.homeassistant/scripts/wind_direction.sh {{ states('sensor.wind_direction') }}"
|
||||
unit_of_measurement: "Direction"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Usage of JSON attributes in command output
|
||||
@ -542,6 +602,7 @@ command_line:
|
||||
The example shows how you can retrieve multiple values with one sensor (where the additional values are attributes) by using `value_json` and `json_attributes`.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -553,6 +614,7 @@ command_line:
|
||||
command: "python3 /home/pi/.homeassistant/scripts/datetime.py"
|
||||
value_template: "{{ value_json.time }}"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
## Example switch platform
|
||||
@ -562,6 +624,7 @@ command_line:
|
||||
This example demonstrates how to use template to change the icon as its state changes. This icon is referencing its own state.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
command_line:
|
||||
- switch:
|
||||
@ -578,6 +641,7 @@ command_line:
|
||||
{% else %} mdi:toggle-switch-off
|
||||
{% endif %}
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### aREST device
|
||||
@ -588,6 +652,7 @@ The command line tool [`curl`](https://curl.haxx.se/) is used to toggle a pin
|
||||
which is controllable through REST.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -598,6 +663,7 @@ command_line:
|
||||
value_template: '{{ value == "1" }}'
|
||||
name: Kitchen Lightswitch
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
Given this example, in the UI one would see the `friendly_name` of
|
||||
@ -614,6 +680,7 @@ This switch will shutdown your host immediately, there will be no confirmation.
|
||||
</div>
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -621,6 +688,7 @@ command_line:
|
||||
name: Home Assistant System Shutdown
|
||||
command_off: "/usr/sbin/poweroff"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Control your VLC player
|
||||
@ -629,6 +697,7 @@ This switch will control a local VLC media player
|
||||
([Source](https://community.home-assistant.io/t/vlc-player/106)).
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -637,6 +706,7 @@ command_line:
|
||||
command_on: "cvlc 1.mp3 vlc://quit &"
|
||||
command_off: "pkill vlc"
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
### Control Foscam Motion Sensor
|
||||
@ -647,6 +717,7 @@ This switch supports statecmd,
|
||||
which checks the current state of motion detection.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
command_line:
|
||||
@ -657,6 +728,7 @@ command_line:
|
||||
command_state: 'curl -k --silent "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=getMotionDetectConfig&usr=admin&pwd=password" | grep -oP "(?<=isEnable>).*?(?=</isEnable>)"'
|
||||
value_template: '{{ value == "1" }}'
|
||||
```
|
||||
|
||||
{% endraw%}
|
||||
|
||||
- Replace admin and password with an "Admin" privileged Foscam user
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user