Skip to content

Latest commit

 

History

History
121 lines (90 loc) · 3.86 KB

README.md

File metadata and controls

121 lines (90 loc) · 3.86 KB
Raw

homebridge-twinkly-plus

verified-by-homebridge

Unofficial Homebridge plugin for Twinkly decorative smart lights

Features

Use Siri or HomeKit automation to:

  • Turn lights on or off
  • Change brightness
  • Change the color

A simple command line tool is also included.

Setup

  1. First set up Homebridge.
  2. Configure Twinkly using the iOS or Android app and make sure it's connected to the same network.
  3. Install homebridge-twinkly-plus using homebridge-config-ui-x or manually using sudo npm install -g homebridge-twinkly-plus.

Configuration options

Value Default Description
allowBrightnessControl true Adds a brightness control instead of a simple on/off switch
allowColorControl true Adds a color picker/wheel to the brightness control slider
removeUnreachableDeviceMinutes 0 When to remove unreachable devices (0 meaning never)

The options can be configured using the UI or manually in a config.json.

Example config.json

{
  "bridge": {
    "name": "…"
  },
  "platforms": [{
    "platform": "Twinkly",
    "allowBrightnessControl": true,
    "allowColorControl": true,
    "removeUnreachableDeviceMinutes": 0
  }]
}

Setup as accessory (deprecated)

Prior to version 0.4.0 all lights had to be added individually. This is still possible, but is deprecated. Use this if device discovery doesn't work in your network.

You'll need to find the IP address of each light using the Twinkly app. It might be useful to have your router always assign it the same IP address.

Configuration options

Value Default Description
accessory (required) Identifies module and must be "Twinkly"
name (required) The name for light as it will appear in HomeKit
ip (required) The IP address of the lights.
allowBrightnessControl true Adds a brightness control instead of a simple on/off switch
allowColorControl true Adds a color picker/wheel to the brightness control slider

The options can be configured using the UI or manually in a config.json. Multiple lights are can be added as individual accessories.

Example config.json

{
  "bridge": {
    "name": "…"
  },
  "accessories": [{
    "accessory": "Twinkly",
    "name": "Christmas Lights",
    "ip": "192.168.4.1",
    "allowBrightnessControl": true
    "allowColorControl": true
  }]
}

Command line

Discover devices on network:

twinkly-cli --discover

Turn on:

twinkly-cli --mode movie

Turn off:

twinkly-cli --mode off

Set brightness to 50%:

twinkly-cli --brightness 50

Blink:

twinkly-cli -c 128,0,0 -c 0,255,0 -c 64,0,6 --effect blink --delay 500

Issues

Same Config as for homebridge-twinkly plugin

This plugin uses the exact same configuration as the previous homebridge-twinkly. That is just a nice convenience. However, if you have used the original plugin, just be sure you disable it, so you do not cause any conflicts.

Acknowledgements

Thanks to Pavol Babinčák for documenting the private API.