search

adyanth / homebridge-plugin-command

This Homebridge plugin enables you to create virtual switches that can run any custom command when it is turned on or off.
Apache License 2.0
3 stars 1 forks source link

readme

homebridge-plugin-command

This Homebridge plugin enables you to create virtual switches that can run any custom command when it is turned on or off.

How to use

Under Plugins > Homebridge Plugin Command > Settings, add an accessory and fill in the form!

By default, check_status assumes turned on if the exit code of the command is 0. Set invert_status to true to flip it. check_status command is optional, and if not provided, it just alternates as you turn it on and off. You can enable polling the check status and automatically pushing the change by setting the poll_check to number of seconds or in this format 1d2h3m4s.

If you like a JSON config, see the sample below.

{
  "accessory": "Command Accessory",
  "name": "File switch",
  "turn_on": "touch /tmp/testFile",
  "turn_off": "rm /tmp/testFile",
  "check_status": "ls /tmp/testFile",
  "poll_check": "5",
  "invert_status": false
}