Skip to main content

Python library and unofficial API documentation for Twinkly - Smart Decoration LED lights for Christmas.

Project description

Smart LED Christmas lights

Unofficial API documentation for Twinkly - Smart Decoration LED lights for Christmas.

Description of Twinkly on project page of Kickstarter:

Twinkly is a Christmas tree light string, controlled via smartphone: “internet of things” meets extraordinary light effects! Created by ledworks

  • Free software: MIT license

Documentation is available online at https://xled.readthedocs.io.

Why?

I have Twinkly 105 LEDs starter light set. That is latest available model in 2017: TW105S-EU. As of December 2017 there are only two ways to control lights - mobile app on Android or iOS or hardware button on the cord.

Android application didn’t work as advertised on my Xiaomi Redmi 3S phone. On first start it connected and disconnected in very fast pace (like every 1-2 seconds) to the hardware. I wasn’t able to control anything at all. Later I wanted to connect it to my local WiFi network. But popup dialog that shouldn’t have appear never did so.

Public API was promised around Christmas 2016 for next season. Later update from October 2016 it seems API won’t be available any time soon:

API for external control are on our dev check list, we definitely need some feedback from the community to understand which could be a proper core set to start with.

It turned out that application uses HTTP to control lights. I ended up with capturing network traffic and documented this private API. In the end I’m able to configure the device pretty easilly.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.2.1 (2018-01-02)

  • Add missing MANIFEST.in

  • Configure Travis for automatic deployment to PyPI

0.2.0 (2018-01-02)

  • First Python control interface.

0.1.0 (2017-12-17)

  • First private API documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xled-0.2.1.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xled-0.2.1-py2.py3-none-any.whl (13.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file xled-0.2.1.tar.gz.

File metadata

  • Download URL: xled-0.2.1.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for xled-0.2.1.tar.gz
Algorithm Hash digest
SHA256 6782de632a048e77112e2d8301b6dd4f42fbbcbd539029f705baa1cd8fd5e1d7
MD5 598695a1765562f08cc8af2ab1690245
BLAKE2b-256 bfd45265995746b74652dc1c8a02a0f845da623608a5eb4b1917d547b37208b1

See more details on using hashes here.

File details

Details for the file xled-0.2.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for xled-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 31afd9dadbbb7f237803741370c92bcee0f88631f4d5d2960669b11ad2eb4fa3
MD5 780b79f48ece42796ee843323da52147
BLAKE2b-256 aeec342a332e459d3379a2accd1f736cb68ab69fb33fe2d2f9dfa99d04e102d1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page