This is the description of the Shell API bindings for the LED Strip Bricklet. General information and technical specifications for the LED Strip Bricklet are summarized in its hardware description.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
r=0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
g=255,255,255,255,255,255,255,255,255,255,0,0,0,0,0,0
b=0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
# Set first 10 LEDs to green
tinkerforge call led-strip-bricklet $uid set-rgb-values 0 10 $r $g $b
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the LED Strip Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the LED Strip Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Parameters: |
|
---|---|
Output: | no output |
Sets the rgb values for the LEDs with the given length starting from index.
The maximum length is 16, the index goes from 0 to 319 and the rgb values have 8 bits each.
Example: If you set
the LED with index 5 will be red, 6 will be green and 7 will be blue.
Note
Depending on the LED circuitry colors can be permuted.
The colors will be transfered to actual LEDs when the next frame duration ends, see set-frame-duration.
Generic approach:
This approach ensures that you can change the LED colors with a fixed frame rate.
The actual number of controllable LEDs depends on the number of free Bricklet ports. See here for more information. A call of set-rgb-values with index + length above the bounds is ignored completely.
Parameters: |
|
---|---|
Output: |
|
Returns the rgb with the given length starting from the given index.
The values are the last values that were set by set-rgb-values.
Parameters: |
|
---|---|
Output: | no output |
Sets the frame duration in ms.
Example: If you want to achieve 20 frames per second, you should set the frame duration to 50ms (50ms * 20 = 1 second).
For an explanation of the general approach see set-rgb-values.
Default value: 100ms (10 frames per second).
Output: |
|
---|
Returns the frame duration as set by set-frame-duration.
Output: |
|
---|
Returns the current supply voltage of the LEDs. The voltage is given in mV.
Parameters: |
|
---|---|
Output: | no output |
Sets the frequency of the clock in Hz. The range is 10000Hz (10kHz) up to 2000000Hz (2MHz).
The Bricklet will choose the nearest achievable frequency, which may be off by a few Hz. You can get the exact frequency that is used by calling get-clock-frequency.
If you have problems with flickering LEDs, they may be bits flipping. You can fix this by either making the connection between the LEDs and the Bricklet shorter or by reducing the frequency.
With a decreasing frequency your maximum frames per second will decrease too.
The default value is 1.66MHz.
Note
The frequency in firmware version 2.0.0 is fixed at 2MHz.
New in version 2.0.1 (Plugin).
Output: |
|
---|
Returns the currently used clock frequency as set by set-clock-frequency.
New in version 2.0.1 (Plugin).
Parameters: |
|
---|---|
Output: | no output |
Sets the type of the led driver chip. We currently support the chips
The WS2812 is sometimes also called "NeoPixel", a name coined by Adafruit.
The default value is WS2801 (chip = 2801).
The following symbols are available for this function:
New in version 2.0.2 (Plugin).
Output: |
|
---|
Returns the currently used chip type as set by set-chip-type.
The following symbols are available for this function:
New in version 2.0.2 (Plugin).
Output: |
|
---|
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.
The position can be 'a', 'b', 'c' or 'd'.
The device identifier numbers can be found here.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch led-strip-bricklet <uid> example
The available callbacks are described below.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
Output: |
|
---|
This callback is triggered directly after a new frame is rendered.
You should send the data for the next frame directly after this callback was triggered.
For an explanation of the general approach see set-rgb-values.