================================================================== XLED - unofficial control of Twinkly - Smart Decoration LED lights

XLED is a python library and command line interface (CLI) to control Twinkly_ - Smart Decoration LED lights for Christmas.

Official materials says:

Twinkly is a LED light device that you can control via smartphone. It
allows you to play with colouful and animated effects, or create new ones.
Decoration lights, not suitable for household illumination.

Since its Kickstarter project_ in 2016 many products were introduced with varying properties and features. Most notably products released since September 2019 are identified as Generation II. Older products are since then referred as Generation I.

Library and CLI are free software available under MIT license.

Installation

Both library and CLI tool are supported on Linux, primarily Fedora.

#. First make sure that you have pip installed_. E.g. for Fedora:

::

   $ sudo dnf install python3-pip python3-wheel

#. You might want to create and activate a virtual environment_. E.g.:

::

   $ mkdir -p ~/.virtualenvs
   $ python3 -m venv ~/.virtualenvs/xled
   $ source ~/.virtualenvs/xled/bin/activate

#. Install xled from PyPI_:

::

   $ python3 -m pip install --upgrade xled

Usage

If you have installed the project into virtual environment, activate it first. E.g.

.. code-block::

$ source ~/.virtualenvs/xled/bin/activate

Use of the library:

.. code-block:: python

>>> import xled
>>> discovered_device = xled.discover.discover()
>>> discovered_device.id
'Twinkly_33AAFF'
>>> control = xled.ControlInterface(discovered_device.ip_address, discovered_device.hw_address)
>>> control.set_mode('movie')
<ApplicationResponse [1000]>
>>> control.get_mode()['mode']
'movie'
>>> control.get_device_info()['number_of_led']
210

Documentation for the library can be found online_.

Use of the CLI:

.. code-block:: console

$ xled on
Looking for any device...
Working on device: Twinkly_33AAFF
Turned on.

For more commands and options see xled --help.

Why?

My first Twinkly was 105 LEDs starter light set. That was the 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.

As of 2020 Twinkly devices can be controlled by Amazon Alexa and Google Assistant as well. Mobile application now requires an account to operate lights even locally. No sign of public API for local devices though. Therefore with my second device - Twinkly 210 RGB+W Wall I keep improving this library and CLI documentation to be able to operate my devices locally and not rely on availability of manufacturer's servers.

Related projects

Unofficial documentation of private protocol and API is available online_.

For other projects that might be more suitable for your needs see section client implementations in xled-docs_.

Credits

This package was created with Cookiecutter_ and the audreyr/cookiecutter-pypackage_ project template.

.. _Twinkly: https://www.twinkly.com/ .. _Kickstarter project: https://www.kickstarter.com/projects/twinkly/twinkly-smart-decoration-for-your-christmas .. _available online: https://xled-docs.readthedocs.io .. _documented this private API: https://xled-docs.readthedocs.io .. _promised around Christmas 2016: https://www.kickstarter.com/projects/twinkly/twinkly-smart-decoration-for-your-christmas/comments?cursor=15497325#comment-15497324 .. _API won't be available any time soon: https://www.kickstarter.com/projects/twinkly/twinkly-smart-decoration-for-your-christmas/comments?cursor=14619713#comment-14619712 .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _documented this private API: https://xled-docs.readthedocs.io .. _audreyr/cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackage .. _pip installed: https://packaging.python.org/guides/installing-using-linux-tools/ .. _create and activate a virtual environment: https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments .. _xled from PyPI: https://pypi.org/project/xled/ .. _Documentation for the library can be found online: https://xled.readthedocs.io .. _section client implementations in xled-docs: https://xled-docs.readthedocs.io/en/latest/readme.html#client-implementations

.. image:: https://badges.gitter.im/xled-community/chat.svg :alt: Join the chat at https://gitter.im/xled-community/chat :target: https://gitter.im/xled-community/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge