TCP/IP - 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
  - 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
    - Protocol
    - API
      - Brick Daemon Functions
      - Broadcast Functions
      - General Callbacks
      - Bricks and Bricklets
        - 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
            - API
              - 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
  - Modbus Protocol
  - Wireshark Dissector

# TCP/IP - LED Strip Bricklet

This is the description of the TCP/IP protocol for the LED Strip Bricklet. General information and technical specifications for the LED Strip Bricklet are summarized in its hardware description.

## API

A general description of the TCP/IP protocol structure can be found here.

### Basic Functions

`BrickletLEDStrip.``set_rgb_values`

  Function ID: | 1

  Request:

  - index -- uint16
  - length -- uint8
  - r -- uint8[16]
  - g -- uint8[16]
  - b -- uint8[16]

  Response: | no response

  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 `CALLBACK_FRAME_RENDERED` callback.
  - Set all of the LED colors for next frame.
  - Wait for the `CALLBACK_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.

`BrickletLEDStrip.``get_rgb_values`

  Function ID: | 2

  Request:

  - index -- uint16
  - length -- uint8

  Response:

  - r -- uint8[16]
  - g -- uint8[16]
  - b -- uint8[16]

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

`BrickletLEDStrip.``set_frame_duration`

  Function ID: | 3

  Request:

  - duration -- uint16

  Response: | no response

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

`BrickletLEDStrip.``get_frame_duration`

  Function ID: | 4
  Request: | empty payload

  Response:

  - duration -- uint16

  Returns the frame duration as set by `set_frame_duration`.

`BrickletLEDStrip.``get_supply_voltage`

  Function ID: | 5
  Request: | empty payload

  Response:

  - voltage -- uint16

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

`BrickletLEDStrip.``set_clock_frequency`

  Function ID: | 7

  Request:

  - frequency -- uint32

  Response: | no response

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

`BrickletLEDStrip.``get_clock_frequency`

  Function ID: | 8
  Request: | empty payload

  Response:

  - frequency -- uint32

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

  New in version 2.0.1 (Plugin).

`BrickletLEDStrip.``set_chip_type`

  Function ID: | 9

  Request:

  - chip -- uint16

  Response: | no response

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

  New in version 2.0.2 (Plugin).

`BrickletLEDStrip.``get_chip_type`

  Function ID: | 10
  Request: | empty payload

  Response:

  - chip -- uint16

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

  New in version 2.0.2 (Plugin).

### Advanced Functions

`BrickletLEDStrip.``get_identity`

  Function ID: | 255
  Request: | empty payload

  Response:

  - uid -- char[8]
  - connected_uid -- char[8]
  - position -- char
  - hardware_version -- uint8[3]
  - firmware_version -- uint8[3]
  - device_identifier -- uint16

  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

`BrickletLEDStrip.``CALLBACK_FRAME_RENDERED`

  Function ID: | 6

  Response:

  - length -- uint16

  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.