sunix-ledstrip-controller-client 2.0.5

Installation

pip install sunix-ledstrip-controller-client

Usage

For a basic example have a look at the example.py file. If you need more info have a look at the documentation which should help.

Create the LEDStripControllerClient object

The first thing you need to communicate with any controller is the api client. Create one like this:

from sunix_ledstrip_controller_client import LEDStripControllerClient

api = LEDStripControllerClient()

The next thing you need is a Controller object that specifies the basics about your Sunix controller hardware. You can either let the api search automatically for your controller using:

devices = api.discover_controllers()

or create one manually like this:

from sunix_ledstrip_controller_client import Controller
device = Controller(api, "192.168.2.23")

or including a port if you want to access it from outside of your local network:

device = Controller(api, "my-dyndns-address.org", 12345)

Note that you have to supply an api object so the Controller can fetch is state.

Turn it on!

Now you have all that is needed to control your device. It’s time to turn it on and off! Use this method to turn it on:

device.turn_on()

and this to turn it off:

device.turn_off()

Make it a rainbow (changing colors)

Now to the fun part. The RGB values and the WW (warm white and cold white) value can be adjusted separately (while keeping the other value) or both at the same time.

All values have a valid range of 0 to 255.

If you only want to change the RGB values use:

device.set_rgb(255, 255, 255)

and this one if you only want to change the WW value:

device.set_ww(255, 255)

To set both at the same time use (you guessed it):

device.set_rgbww(255, 255, 255, 255, 255)

Functions

The official app for the Sunix controller offers 20 different functions that can be activated and customized in speed. These functions are hardcoded in the controller so they can not be altered in any way. You can activate them though using:

from sunix_ledstrip_controller_client import FunctionId
device.set_function(FunctionId.RED_GRADUAL_CHANGE, 240)

Function ids can be found in the FunctionId enum class.

0 is slow - 255 is fast.

In the network protocol the speed is actually reversed (0 is fast, 255 is slow) but I changed this for the sake of simplicity. You should be aware though that the speed curve seems to be exponential. This means 255 is very fast but 240 is already a lot slower.

Custom Functions

Another feature of the official app is to set a custom color loop with a custom transition and speed between the colors. Since v1.2.0 of this library you can set those too :)

Simply have a look at the example_custom_function.py file for a detailed example.

Set/Get Time

The Sunix® controller has a build in clock to be able to execute timer actions. Currently there is no way to get or set timers with this library. You can however get and set the current time of the controller.

To get the currently set time use:

time = device.get_time()

Note that this might be None though if you have never set a time for this controller before. To set a new value use:

dt = datetime.datetime.now()
device.set_time(dt)