Class BrickletLEDStrip


  • public class BrickletLEDStrip
    extends Device
    Controls up to 320 RGB LEDs
    • Constructor Detail

      • BrickletLEDStrip

        public BrickletLEDStrip​(java.lang.String uid,
                                IPConnection ipcon)
        Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
    • Method Detail

      • setRGBValues

        public void setRGBValues​(int index,
                                 short length,
                                 short[] r,
                                 short[] g,
                                 short[] b)
                          throws TinkerforgeException
        Sets *length* RGB values for the LEDs starting from *index*. To make the colors show correctly you need to configure the chip type (setChipType(int)) and a 3-channel channel mapping (setChannelMapping(short)) according to the connected LEDs. 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 setFrameDuration(int). 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 BrickletLEDStrip.FrameRenderedListener listener. * Set all of the LED colors for next frame. * Wait for the BrickletLEDStrip.FrameRenderedListener listener. * 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 :ref:`here <led_strip_bricklet_ram_constraints>` for more information. A call of setRGBValues(int, short, short[], short[], short[]) with index + length above the bounds is ignored completely.
        Throws:
        TinkerforgeException
      • setClockFrequency

        public void setClockFrequency​(long frequency)
                               throws TinkerforgeException
        Sets the frequency of the clock. 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 getClockFrequency(). 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. \note The frequency in firmware version 2.0.0 is fixed at 2MHz. .. versionadded:: 2.0.1$nbsp;(Plugin)
        Throws:
        TinkerforgeException
      • setChipType

        public void setChipType​(int chip)
                         throws TinkerforgeException
        Sets the type of the LED driver chip. We currently support the chips * WS2801, * WS2811, * WS2812 / SK6812 / NeoPixel RGB, * SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812), * LPD8806 and * APA102 / DotStar. .. versionadded:: 2.0.2$nbsp;(Plugin)
        Throws:
        TinkerforgeException
      • setRGBWValues

        public void setRGBWValues​(int index,
                                  short length,
                                  short[] r,
                                  short[] g,
                                  short[] b,
                                  short[] w)
                           throws TinkerforgeException
        Sets *length* RGBW values for the LEDs starting from *index*. To make the colors show correctly you need to configure the chip type (setChipType(int)) and a 4-channel channel mapping (setChannelMapping(short)) according to the connected LEDs. The maximum length is 12, the index goes from 0 to 239 and the rgbw values have 8 bits each. Example: If you set * index to 5, * length to 4, * r to [255, 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], * b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] and * w to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] the LED with index 5 will be red, 6 will be green, 7 will be blue and 8 will be white. \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 setFrameDuration(int). 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 BrickletLEDStrip.FrameRenderedListener listener. * Set all of the LED colors for next frame. * Wait for the BrickletLEDStrip.FrameRenderedListener listener. * 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 :ref:`here <led_strip_bricklet_ram_constraints>` for more information. A call of setRGBWValues(int, short, short[], short[], short[], short[]) with index + length above the bounds is ignored completely. The LPD8806 LED driver chips have 7-bit channels for RGB. Internally the LED Strip Bricklets divides the 8-bit values set using this function by 2 to make them 7-bit. Therefore, you can just use the normal value range (0-255) for LPD8806 LEDs. The brightness channel of the APA102 LED driver chips has 5-bit. Internally the LED Strip Bricklets divides the 8-bit values set using this function by 8 to make them 5-bit. Therefore, you can just use the normal value range (0-255) for the brightness channel of APA102 LEDs. .. versionadded:: 2.0.6$nbsp;(Plugin)
        Throws:
        TinkerforgeException
      • getIdentity

        public Device.Identity getIdentity()
                                    throws TinkerforgeException
        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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
        Specified by:
        getIdentity in class Device
        Throws:
        TinkerforgeException