hd

homebridge-doorsensor

Door/contact sensor plugin for Homebridge

Showing:

Popularity

Downloads/wk

3

GitHub Stars

0

Maintenance

Last Commit

3yrs ago

Contributors

1

Package

Dependencies

1

Size (min+gzip)

4.3KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

view on npm npm module downloads

homebridge-doorsensor

This is a plugin for homebridge which can either monitor 1) a contact / door sensor connected to power and a GPIO pin or 2) a file populated with a 1 or a 0 that serves the same purpose. My configuration uses a reed switch connected to numbered pins 17 (3.3v DC Power) and 18 (GPIO_GEN5). The other option is to use a file popluated with a 0 or a 1 by an external application. This plugin will read the file to determine the sensor state. The flipBehavior flag allows you to switch the reported status.

Installation

  1. Install homebridge using: npm install -g homebridge
  2. Install this plugin using: npm install -g homebridge-doorsensor
  3. Follow the install instructions for rpio
  4. Update your configuration file. See below for a sample.

Example config

  {
    "accessory": "DoorSensor",
    "name": "Garage Door",
    "sensorPollInMs": 5000,
    "flipBehavior": false,
    "sensorPin": 18,         /* sensorPin or triggerFile required */
    "triggerFile": "file"    /* but not both */
  }

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100