Skip to content

Commit eae785c

Browse files
sVnsationabmantis
andauthored
Document operation modes for Twinkly integration (home-assistant#36567)
Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
1 parent cc168b3 commit eae785c

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

source/_integrations/twinkly.markdown

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,54 @@ ha_integration_type: integration
2020

2121
The Twinkly integration allows you to control [Twinkly](https://twinkly.com/) LED string from Home Assistant.
2222

23+
This integration can be used to:
24+
- Turn your Twinklys on and off
25+
- Adjust brightness
26+
- Control static colors and effects
27+
- Switch between operation modes (see explanation below)
28+
29+
Music mode is currently not supported.
30+
2331
## Effects
2432

2533
For devices with software version > 2.7.1, you can also control the effects on your Twinklys.
2634

2735
The Twinkly devices do not initially have any effects stored locally. Effects must be added from the Twinkly application before they become visible in Home Assistant.
2836

2937
Make sure the latest firmware is installed on your Twinkly devices and add effects by _apply_-ing them from the Twinkly app.
30-
This integration can then be used to switch between static colors and effects, and to turn your Twinklys on and off.
3138

32-
Playlists and Music modes are currently not supported.
39+
## Operation Modes
40+
41+
Modes can be switched using the select entity.
42+
43+
For most use cases, "Color", "Movie" and "Playlist" modes are the most relevant.
44+
45+
**Color Mode**
46+
- Displays a static color
47+
- Controlled through the light entity
48+
- Color can be set via RGB/RGBW
49+
50+
**Movie Mode**
51+
- Plays effects previously uploaded through the Twinkly app
52+
- Effects must be created and transferred to the device first using the app
53+
- Effect selection is done through the light entity
54+
55+
**Playlist Mode**
56+
- Sequential playback of multiple effects
57+
- Playlist must be uploaded through the Twinkly app first
58+
59+
**Off Mode**
60+
- Turns off the lighting
61+
62+
**Demo Mode**
63+
- Shows predefined demo effects
64+
- Primarily intended for presentation purposes
65+
- Limited practical use
66+
67+
**Unsupported Modes:**
68+
- Effect Mode: predefined effects built into the device. Alternatively, you can use Movie Mode
69+
- RT (Real-Time): Live control of individual LEDs
70+
- Music: Music-controlled light show
3371

3472
{% include integrations/config_flow.md %}
3573

0 commit comments

Comments
 (0)