Shell - LED Strip Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
            - Examples
              - Simple
            - API
              - Command Structure
              - Basic Functions
              - Advanced Functions
              - Callbacks
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Shell - LED Strip Bricklet

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.

## Examples

The example code below is Public Domain (CC0 1.0).

### Simple

Download (example-simple.sh)

     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

## API

Possible exit codes for all `tinkerforge` commands are:

- 1: interrupted (ctrl+c)
- 2: syntax error
- 21: Python 2.5 or newer is required
- 22: Python `argparse` module is missing
- 23: socket error
- 24: other exception
- 25: invalid placeholder in format string
- 26: authentication error
- 201: timeout occurred
- 209: invalid argument value
- 210: function is not supported
- 211: unknown error

### Command Structure

The common options of the `call` and `dispatch` commands are documented here. The specific command structure is shown below.

tinkerforge `call` `led-strip-bricklet` [<option>..] <uid> <function> [<argument>..]

  Parameters:

  - <uid> -- string
  - <function> -- string

  The `call` command is used to call a function of the LED Strip Bricklet. It can take several options:

  - `--help` shows help for the specific `call` command and exits
  - `--list-functions` shows a list of known functions of the LED Strip Bricklet and exits

tinkerforge `dispatch` `led-strip-bricklet` [<option>..] <uid> <callback>

  Parameters:

  - <uid> -- string
  - <callback> -- string

  The `dispatch` command is used to dispatch a callback of the LED Strip Bricklet. It can take several options:

  - `--help` shows help for the specific `dispatch` command and exits
  - `--list-callbacks` shows a list of known callbacks of the LED Strip Bricklet and exits

tinkerforge call `led-strip-bricklet` <uid> `<function>` [<option>..] [<argument>..]

  Parameters:

  - <uid> -- string
  - <function> -- string

  The `<function>` to be called can take different options depending of its kind. All functions can take the following options:

  - `--help` shows help for the specific function and exits

  Getter functions can take the following options:

  - `--execute <command>` shell command line to execute for each incoming response (see section about output formatting for details)

  Setter functions can take the following options:

  - `--expect-response` requests response and waits for it

  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.

tinkerforge dispatch `led-strip-bricklet` <uid> `<callback>` [<option>..]

  Parameters:

  - <uid> -- string
  - <callback> -- string

  The `<callback>` to be dispatched can take several options:

  - `--help` shows help for the specific callback and exits
  - `--execute <command>` shell command line to execute for each incoming response (see section about output formatting for details)

### Basic Functions

tinkerforge call `led-strip-bricklet` <uid> `set-rgb-values` <index> <length> <r> <g> <b>

  Parameters:

  - <index> -- int
  - <length> -- int
  - <r> -- int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
  - <g> -- int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
  - <b> -- int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int

  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

  - index to 5,
  - length to 3,
  - r to [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  - g to [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] and
  - b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

  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:

  - Set the frame duration to a value that represents the number of frames per second you want to achieve.
  - Set all of the LED colors for one frame.
  - Wait for the `frame-rendered` callback.
  - Set all of the LED colors for next frame.
  - Wait for the `frame-rendered` callback.
  - and so on.

  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.

tinkerforge call `led-strip-bricklet` <uid> `get-rgb-values` <index> <length>

  Parameters:

  - <index> -- int
  - <length> -- int

  Output:

  - r -- int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
  - g -- int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
  - b -- int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int

  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`.

tinkerforge call `led-strip-bricklet` <uid> `set-frame-duration` <duration>

  Parameters:

  - <duration> -- int

  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).

tinkerforge call `led-strip-bricklet` <uid> `get-frame-duration`

  Output:

  - duration -- int

  Returns the frame duration as set by `set-frame-duration`.

tinkerforge call `led-strip-bricklet` <uid> `get-supply-voltage`

  Output:

  - voltage -- int

  Returns the current supply voltage of the LEDs. The voltage is given in mV.

tinkerforge call `led-strip-bricklet` <uid> `set-clock-frequency` <frequency>

  Parameters:

  - <frequency> -- int

  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).

tinkerforge call `led-strip-bricklet` <uid> `get-clock-frequency`

  Output:

  - frequency -- int

  Returns the currently used clock frequency as set by `set-clock-frequency`.

  New in version 2.0.1 (Plugin).

tinkerforge call `led-strip-bricklet` <uid> `set-chip-type` <chip>

  Parameters:

  - <chip> -- int (has symbols)

  Output: | no output

  Sets the type of the led driver chip. We currently support the chips

  - WS2801 (`chip` = 2801),
  - WS2811 (`chip` = 2811) and
  - WS2812 (`chip` = 2812).

  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:

  - `ws2801` = 2801, for <chip>
  - `ws2811` = 2811, for <chip>
  - `ws2812` = 2812, for <chip>

  New in version 2.0.2 (Plugin).

tinkerforge call `led-strip-bricklet` <uid> `get-chip-type`

  Output:

  - chip -- int (has symbols)

  Returns the currently used chip type as set by `set-chip-type`.

  The following symbols are available for this function:

  - `ws2801` = 2801, for chip
  - `ws2811` = 2811, for chip
  - `ws2812` = 2812, for chip

  New in version 2.0.2 (Plugin).

### Advanced Functions

tinkerforge call `led-strip-bricklet` <uid> `get-identity`

  Output:

  - uid -- string
  - connected-uid -- string
  - position -- char
  - hardware-version -- int,int,int
  - firmware-version -- int,int,int
  - device-identifier -- int (has symbols)

  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

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.

tinkerforge dispatch `led-strip-bricklet` <uid> `frame-rendered`

  Output:

  - length -- int

  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`.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.