3.9 KiB
| title | description | ha_category | ha_release | ha_iot_class | ha_domain | ha_platforms | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Command Line | Instructions on how to integrate Command binary sensors within Home Assistant. |
|
0.12 | Local Polling | command_line |
|
The command_line binary sensor platform issues specific commands to get data.
Configuration
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"
It's highly recommended to enclose the command in single quotes ' as it ensures all characters can be used in the command and reduces the risk of unintentional escaping. To include a single quote in a command enclosed in single quotes, double it: ''.
{% configuration %} command: description: The action to take to get the value. required: true type: string name: description: Let you overwrite the name of the device. required: false type: string default: "name from the device" device_class: description: Sets the class of the device, changing the device state and icon that is displayed on the frontend. required: false type: string payload_on: description: The payload that represents enabled state. required: false type: string default: 'ON' payload_off: description: The payload that represents disabled state. required: false type: string default: 'OFF' value_template: description: Defines a template to extract a value from the payload. required: false type: string scan_interval: description: Defines number of seconds for polling interval. required: false type: integer default: 60 command_timeout: description: Defines number of seconds for command timeout. required: false type: integer default: 15 {% endconfiguration %}
Examples
In this section you find some real-life examples of how to use this sensor.
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"
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.
Check if a system service is running
The services running is listed in /etc/systemd/system and can be checked with the systemctl command:
$ systemctl is-active home-assistant@rock64.service
active
$ sudo service home-assistant@rock64.service stop
$ systemctl is-active home-assistant@rock64.service
inactive
A binary command line sensor can check this:
binary_sensor:
- platform: command_line
command: '/bin/systemctl is-active home-assistant@rock64.service'
payload_on: "active"
payload_off: "inactive"
Services
Available services: reload.
Service command_line.reload
Reload all command_line entities.
This service takes no service data attributes.