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 Variables
- command
(string)(Required)
The action to take to get the value.
- name
-
(string)(Optional)
Let you overwrite the name of the device.
Default value:
name from the device
- device_class
(string)(Optional)
Sets the class of the device, changing the device state and icon that is displayed on the frontend.
- payload_on
-
(string)(Optional)
The payload that represents enabled state.
Default value:
ON
- payload_off
-
(string)(Optional)
The payload that represents disabled state.
Default value:
OFF
- value_template
(string)(Optional)
Defines a template to extract a value from the payload.
- scan_interval
-
(integer)(Optional)
Defines number of seconds for polling interval.
Default value:
60
- command_timeout
-
(integer)(Optional)
Defines number of seconds for command timeout.
Default value:
15
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 [email protected]
active
$ sudo service [email protected] stop
$ systemctl is-active [email protected]
inactive
A binary command line sensor can check this:
binary_sensor:
- platform: command_line
command: '/bin/systemctl is-active [email protected]'
payload_on: 'active'
payload_off: 'inactive'