Skip to content

BrandonLive/Twinklier-API-Client

Repository files navigation

Twinklier-API-Client

This is an early work in progress based on some experimentation with the Twinkly (not officially documented) controller API. This was built initially by observing traffic between the Twinkly app (as well as the music adapter) and the light controllers, but along the way I discovered the very nicely organized unofficial documentation some others had produced here.

Rough plans I've in mind include:

  • Filling out the API library
  • Creating a simulator (initially to aid in development of the library and things built on top, but perhaps also for UI purposes)
  • Adding tests
  • Creating authoring and playback tools, or intergrating with something that already exists

API

TODO

Samples

CLI Sample

connect - Connects to the specified IP/hostname, or the default (in cli-sample.ts) if none is specified
disconnect - Abandons the current session
set-mode - Sets the controller to the specified mode. Valid modes are "off", "movie", "realtime", and "demo"
help - Lists supported commands
send-demo - Sends a pre-programmed demo sequence to the connected Twinkly controller
enable-proxy - Enables usage of a proxy server (e.g. Fiddler), using the proxy configuration specified in cli-sample.ts (Host: 127.0.0.1 Port: 8888)
exit - Exits this sample app

Basics

  • Lights are numbered started from the controller and incrementing outword. Most (all?) sets have two strands which begin at the controller. Index 0 is the first light on one strand. For a 600 light set, index 300 is the first on the second strand.

TODO: More documentation

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published