update to v0.3.0

README.md

@@ -3,9 +3,9 @@ Homebridge platform plugin for local Insteon control
 
 Overview
 --------
-Implements local control of Insteon devices (switches or dimmers only for now) via Homebridge. Leverages [home-controller](https://github.com/automategreen/home-controller) to enable control and status of multiple Insteon devices.  Supports both Insteon Hub 2242 and 2245.
+Implements local control of Insteon devices including switches, dimmers, scenes, iolincs (configured as a garage door), motion sensors, and leak sensors via Homebridge. Leverages [home-controller](https://github.com/automategreen/home-controller) to enable control and status of multiple Insteon devices.  Supports both Insteon Hub 2242 and 2245.
 
-This plugin leverages two mechanisms to get device status - an event listener and periodic polling.  The event listener will listen for events on the Insteon network and automatically update device status in Homebridge.  It will only capture manual events (ie, manually pushing a switch) and not events triggered by other apps or devices (ie, Amazon Echo).  To work around this limitation, the plugin will also periodically poll for the status of configured devices (see configuration below).
+This plugin provides two mechanisms to get device status - an event listener and periodic polling.  The event listener will listen for events on the Insteon network and automatically update device status in Homebridge.  It will only capture manual events (ie, manually pushing a switch) as well as events triggered by other apps or devices (ie, Amazon Echo).  The plugin also provides a mechanism for periodic polling of the status of configured devices.  This is now disabled by default as the event listener should capture events, but can be enabled if desired (see configuration below).
 
 Devices are not yet auto-discovered and must be defined in config.json (see configuration example)
 
@@ -17,11 +17,19 @@ This plugin will set up a local [Express](https://expressjs.com) server at the p
  - `/light/[id]/off`:  turn off the light with Insteon [id]
  - `/light/[id]/status`:  get status of the light with Insteon [id]
  - `/light/[id]/level/[targetlevel]`:  set brightness of the light with Insteon [id] to [targetlevel]
+ - `/scene/[group]/on`:  turn on the scene with Insteon [group] number
+ - `/scene/[group]/off`:  turn off the scene with Insteon [group] number
+ - `/iolinc/[id]/relay_on`:  turn on the relay for iolinc with Insteon [id]
+ - `/iolinc/[id]/relay_off`:  turn off the relay for iolinc with Insteon [id]
+ - `/iolinc/[id]/relay_status`:  get status of the relay for iolinc with Insteon [id]
+ - `/iolinc/[id]/sensor_status`:  get status of the sensor for iolinc with Insteon [id]
  - `/links`:  get all links from your Insteon Hub
  - `/links/[id]`:  get links for device with Insteon [id]
  - `/info/[id]`:  get info for device with Insteon [id]
 
-### Install
+The Express serve is now optional and can be disabled if desired.
+
+## Install
 
 Clone the repository, cd into the cloned directory and install using npm:
 
@@ -30,16 +38,25 @@ Clone the repository, cd into the cloned directory and install using npm:
 Configuration
 -------------
 Edit the config.json (see example) to fit your installation - configuration parameters are:
+
   - `user`:  Hub username from Insteon app (Not your Insteon login username.  Go to Settings->House in the Insteon app and use the 'Hub Username' from there.)
   - `pass`:  Hub password from Insteon app (Not your Insteon login password.  Go to Settings->House in the Insteon app and use the 'Hub Password' from there.)
   - `host`:  local IP of your Insteon hub
   - `port`:  port from Insteon app
   - `model`: model number of your hub.  Valid values are 2242 or 2245
-  - `refresh`: device status refresh interval in seconds (set to 0 for no refresh)
+  - `refresh`: device status refresh interval in seconds (disabled by default, set to 0 to disable polling)
+  - `use_express`: true or false to enable/disable Express server
   - `server_port`: port for local Express server
 
 Devices are also defined in the config.json as follows:
+
   - `name`:  Device name as you want it to appear in Homebridge
   - `deviceID`:  Insteon ID with no spaces or dividers
   - `dimmable`:  dimmable or non-dimming device - valid values are "yes" or "no"
-  - `deviceType`:  "lightbulb" for all devices (for now)
+  - `deviceType`:  valid values include 'lightbulb', 'dimmer', 'switch', 'scene', 'iolinc', 'motionsensor', 'leaksensor'
+
+Scenes are currently on/off only, and do not support status (although the status of the component devices will update).  When defining a scene, the `deviceID` parameter should be the group number in the Insteon app (Scenes->Edit Scene->Group Number).
+
+For iolinc devices, there is an additional parameter that can be defined:
+
+- `gdo_delay`: number of seconds before status of the sensor is checked when opening/closing the door (ie, how long does it take the door to open/close) [default = 15]