mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-04-30 00:07:35 +00:00
dd51ad0df5
* fixed double 'the' mostly 's/the the /the /', little style changes where 'is' or 'to' was missing * removed duplicate words removed duplicate words like 'to to', 'you you' or 'account account' etc. a batch of pizza-toasts burnt for this.
2.6 KiB
2.6 KiB
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_iot_class |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | Command line Binary Sensor | Instructions how to integrate Command binary sensors within Home Assistant. | 2016-01-13 12:15 | true | false | true | true | command_line.png | Binary Sensor | 0.12 | Local Polling |
The command_line binary sensor platform issues specific commands to get data.
To use your Command binary sensor in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
binary_sensor:
- platform: command_line
command: cat /proc/sys/net/ipv4/ip_forward
Configuration variables:
- command (Required): The action to take to get the value.
- name (Optional): Let you overwrite the name of the device. By default name from the device is used.
- device_class (Optional): The type/class of the sensor to set the icon in the frontend.
- payload_on (Optional): The payload that represents enabled state. Default is "ON".
- payload_off (Optional): The payload that represents disabled state. Default is "OFF".
- value_template (Optional): Defines a template to extract a value from the payload.
- scan_interval (Optional): Defines number of seconds for polling interval (defaults to 60 seconds).
{% linkable_title Examples %}
In this section you find some real life examples of how to use this sensor.
{% linkable_title SickRage %}
Check the state of an SickRage instance.
# Example configuration.yaml entry
binary_sensor:
- platform: command_line
command: netstat -na | find "33322" | find /c "LISTENING" > nul && (echo "Running") || (echo "Not running")
name: 'sickragerunning'
device_class: moving
payload_on: "Running"
payload_off: "Not running"
{% linkable_title Check RasPlex %}
Check if RasPlex is online.
binary_sensor:
- platform: command_line
command: 'ping -c 1 rasplex.local | grep "1 received" | wc -l'
name: 'is_rasplex_online'
device_class: connectivity
payload_on: 1
payload_off: 0
An alternative solution could look like this:
binary_sensor:
- platform: command_line
name: Printer
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"
Consider to use the ping sensor as an alternative to the samples above.