search

apexad / homebridge-sensor-cmd

Homebridge plugin that creates a contact sensor with state determined by a command-line/shell command in only 25 lines of code"
MIT License
4 stars 1 forks source link

readme

homebridge-sensor-cmd

mit license npm npm donate

Homebridge plugin that is a proof of concept to create something functional in a ridiculously small amount of code (50 lines to be exaxt, also this README is just 25 lines).
It impliments a Contact/Motion/Occupancy Sensor that is triggered via the output of a command line/shell script.
The script simply needs to return a 1 or 0

Configuration

This easiest way to use this plugin is to use homebridge-config-ui-x.
To configure, add to the accessories section of Homebridge's config.json after installing the plugin.

Config:

{
  "accessory": "SensorCmd",
  "name": "<name of the sensor>",
  "type": "<sensor type: contact/motion/occupancy) - default is Contact>",
  "command": "<command-line/shell command to execute>"
}