homebridge-wink-schmittx

Homebridge plugin for wink.com


Keywords
homebridge-plugin, wink
License
ISC
Install
npm install homebridge-wink-schmittx@2.0.1

Documentation

homebridge-wink-schmittx

Yet another Wink plugin for homebridge.

  • Uses Wink API v2, and local control.
  • Subscribes to Wink push notifications, instead of polling for device updates.
  • Written in ES7 (arrow functions, async/await, classes).
  • Accessory services and characteristics are defined declaratively.
  • Supports 2 methods of authentication including API tokens obtained from developer.wink.com

Disclaimer

This is a lightly-modified version of homebridge-wink3 for my own personal use.

All credit goes to sibartlett for his excellent work!

Contents

  1. Installation
  2. Configuration
  3. Authentication
    1. OAuth Authorization Code
    2. OAuth Password Grant
  4. Device support
  5. FAQ
  6. Acknowledgements

Installation

Requires Node.js 6 or later.

  1. Install homebridge: npm install -g homebridge
  2. Install this plugin: npm install -g homebridge-wink-schmittx
  3. Update your configuration file. See sample config.json snippet below.

Configuration

"platforms": [
  {
    "platform": "Wink",
    "name": "Wink",
    "username": "your@email.com",
    "password": "WINK_PASSWORD",
    "hide_groups": [
      "garage_door",
      "thermostat"
    ],
    "accessory_info": [
      {
        "device_ids": ["123456", "654321"],
        "manufacturer": "Manufacturer",
        "model": "Model",
        "serial_number": "Serial Number"
      }
    ]
  }
]
Parameter Required Notes
platform X Must always be "Wink".
name X Can be anything.
client_id X See Authentication
client_secret X See Authentication
username * See Authentication
password * See Authentication
hide_groups List of Wink Device Groups/Types that will be hidden from Homebridge. (see Device Support table below)
hide_ids List of Wink IDs that will be hidden from Homebridge.
fan_ids List of Wink IDs (for binary switches or light bulbs/dimmers) that will be added as fans to Homebridge.
outlet_ids List of Wink IDs (for binary switches) that will be added as outlets to Homebridge.
switch_ids List of Wink IDs (for binary switches) that will be added as switches to Homebridge.
valve_ids List of Wink IDs (for binary switches) that will be added as valves to Homebridge.
accessory_info Allows you to override the default accessory information for the specified Wink IDs.
direct_access Attempt to establish direct communication with the Wink hub. Defaults to true.

Authentication

homebridge-wink3 supports 2 methods of authentication.

OAuth Authorization Code

This is the method of authentication preferred by Wink. Using API credentials obtained from developer.wink.com, the plugin will direct the user to authenticate via the wink.com at startup.

You need to provide the following configuration options: client_id and client_secret

Note: DO NOT use use username and password configuration options.

Obtaining a Client ID and secret
  1. Create an account at developer.wink.com
  2. Create an application, with the following information:
  1. Wait for the application to be approved (may take hours)
  2. Once approved, the Client ID and Secret can be seen here.

OAuth Password Grant

If you have old Wink API credentials that support OAuth password grant.

You need to provide the following configuration options: client_id, client_secret, username and password

Device support

See DEVICES.md for more detailed information.

Category Device Type Device Group
Air Conditioners air_conditioner air_conditioners
Binary Switches binary_switch binary_switches
Cameras camera cameras
Door Bells door_bell door_bells
Fans fan fans
Garage Doors garage_door garage_doors
Light Bulbs light_bulb light_bulbs
Locks lock locks
Propane Tanks propane_tank propane_tanks
Sensors sensor_pod sensor_pods
Shades shade shades
Sirens siren sirens
Smoke Detectors smoke_detector smoke_detectors
Thermostats thermostat thermostats

FAQ

Chamberlain garage opener does not seem to response to commands

Unfortunately, Chamberlain garage openers are only controllable when using a Client ID and Secret obtained from one of the official Wink apps. (Source)

Chamberlain now offer official HomeKit support using the MyQ® Home Bridge.

GoControl garage opener does not seem to response to commands

It has been reported that GoControl garage openers do not respond when using OAuth Password Grant, instead I recommend using OAuth Authorization Code. (Source)

Is Pivot Power Genius supported?

No, but checkout this other plugin.

Acknowledgements

This plugin is a crazy rewrite of those that came before: