Shell Commands

Integration Key: shell

The Shell integration allows you to execute any shell command on a schedule and use the output as the state of a sensor. This is useful for passing metrics about the machine that room-assistant is running on or for integrating sensors that do not have native support.

The commands are run with the same user that room-assistant is running with, so make sure your permissions are setup accordingly.

Settings

Name	Type	Default	Description
sensors	Shell Sensors		An array of shell sensor definitions.
switches	Shell Switches		An array of shell switch definitions.

Sensors

Name	Type	Default	Description
name	String		Friendly name of this sensor.
command	String		Shell command that should be executed.
regex	String		Regex that is used for parsing the stdout output of the command, if configured. Otherwise the complete output is used as the state.
cron	String		Cron pattern describing the schedule that this command should be run with.
icon	String		Icon that the sensor should be represented with in Home Assistant Core.
unitOfMeasurement	String		Unit of measurement of the sensor state, leave empty if none.
deviceClass	String		Home Assistant Core device class to be used for this sensor.

Switches

Name	Type	Default	Description
name	String		Friendly name of this switch.
onCommand	String		Shell command that should be executed when the switch is turned on.
offCommand	String		Shell command that should be executed when the switch is turned off.
icon	String		Icon that the sensor should be represented with in Home Assistant Core.

Example Config

global:
  integrations:
    - shell
shell:
  sensors:
    - name: Kitchen Wifi Strength
      command: 'iwconfig wlan0 | grep -i quality'
      regex: 'Signal level=(-?[0-9]+) dBm'
      cron: '* * * * *'
      icon: mdi:wifi
      unitOfMeasurement: dBm
      deviceClass: signal_strength
  switches:
    - name: Onboard LED
      onCommand: 'echo mmc0 | sudo tee /sys/class/leds/led0/trigger'
      offCommand: 'echo none | sudo tee /sys/class/leds/led0/trigger && echo 1 | sudo tee /sys/class/leds/led0/brightness'