Skip to content

Commit 2c6949f

Browse files
committed
updated documentation
1 parent 05e78f1 commit 2c6949f

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,36 @@ In the network protocol the speed is actually reversed (0 is fast, 255 is slow)
145145
You should be aware though that the **speed curve seems to be exponential**. This means 255 is very fast but 240 is
146146
already **a lot** slower.
147147

148+
Custom Functions
149+
----------------
150+
151+
Another feature of the official app is to set a custom color loop with a custom transition and speed between the colors.
152+
Since v1.2.0 of this library you can set those too :)
153+
154+
Simply have a look at the `example_custom_function.py <https://github.com/markusressel/sunix-ledstrip-controller-client/blob/master/example_custom_function.py>`_ file
155+
for a detailed example.
156+
157+
Set/Get Time
158+
------------
159+
160+
The Sunix® controller has a build in clock to be able to execute timer actions.
161+
Currently there is no way to get or set timers with this library.
162+
You can however get and set the current time of the controller.
163+
164+
To get the currently set time use:
165+
166+
.. code-block:: python
167+
168+
time = api.get_time(device)
169+
170+
To set a new value use:
171+
172+
.. code-block:: python
173+
174+
dt = datetime.datetime.now()
175+
api.set_time(device, dt)
176+
177+
148178
Attributions
149179
============
150180

0 commit comments

Comments
 (0)