Class BrickletLEDStripV2


  • public class BrickletLEDStripV2
    extends Device
    Controls up to 2048 RGB(W) LEDs
    • Constructor Detail

      • BrickletLEDStripV2

        public BrickletLEDStripV2​(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

      • setLEDValuesLowLevel

        public void setLEDValuesLowLevel​(int index,
                                         int valueLength,
                                         int valueChunkOffset,
                                         int[] valueChunkData)
                                  throws TinkerforgeException
        Sets the RGB(W) values for the LEDs starting from *index*. You can set at most 2048 RGB values or 1536 RGBW values (6144 byte each). To make the colors show correctly you need to configure the chip type (see setChipType(int)) and a channel mapping (see setChannelMapping(int)) according to the connected LEDs. If the channel mapping has 3 colors, you need to give the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you need to give data in the sequence RGBWRGBWRGBW... The data is double buffered and the colors will be transfered to the 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 BrickletLEDStripV2.FrameStartedListener listener. * Set all of the LED colors for next frame. * Wait for the BrickletLEDStripV2.FrameStartedListener listener. * And so on. This approach ensures that you can change the LED colors with a fixed frame rate.
        Throws:
        TinkerforgeException
      • getLEDValuesLowLevel

        public BrickletLEDStripV2.LEDValuesLowLevel getLEDValuesLowLevel​(int index,
                                                                         int length)
                                                                  throws TinkerforgeException
        Returns *length* RGB(W) values starting from the given *index*. If the channel mapping has 3 colors, you will get the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you will get the data in the sequence RGBWRGBWRGBW... (assuming you start at an index divisible by 3 (RGB) or 4 (RGBW)).
        Throws:
        TinkerforgeException
      • setFrameDuration

        public void setFrameDuration​(int duration)
                              throws TinkerforgeException
        Sets the frame duration. 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 setLEDValues(int, int[]). Default value: 100ms (10 frames per second).
        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.
        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), * WS2813 / WS2815 (Chip Type = WS2812) * LPD8806 and * APA102 / DotStar.
        Throws:
        TinkerforgeException
      • setChannelMapping

        public void setChannelMapping​(int mapping)
                               throws TinkerforgeException
        Sets the channel mapping for the connected LEDs. If the mapping has 4 colors, the function setLEDValues(int, int[]) expects 4 values per pixel and if the mapping has 3 colors it expects 3 values per pixel. The function always expects the order RGB(W). The connected LED driver chips might have their 3 or 4 channels in a different order. For example, the WS2801 chips typically use BGR order, then WS2812 chips typically use GRB order and the APA102 chips typically use WBGR order. The APA102 chips are special. They have three 8-bit channels for RGB and an additional 5-bit channel for the overall brightness of the RGB LED making them 4-channel chips. Internally the brightness channel is the first channel, therefore one of the Wxyz channel mappings should be used. Then the W channel controls the brightness.
        Throws:
        TinkerforgeException
      • getSPITFPErrorCount

        public BrickletLEDStripV2.SPITFPErrorCount getSPITFPErrorCount()
                                                                throws TinkerforgeException
        Returns the error count for the communication between Brick and Bricklet. The errors are divided into * ACK checksum errors, * message checksum errors, * framing errors and * overflow errors. The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
        Throws:
        TinkerforgeException
      • setBootloaderMode

        public int setBootloaderMode​(int mode)
                              throws TinkerforgeException
        Sets the bootloader mode and returns the status after the requested mode change was instigated. You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
        Throws:
        TinkerforgeException
      • setWriteFirmwarePointer

        public void setWriteFirmwarePointer​(long pointer)
                                     throws TinkerforgeException
        Sets the firmware pointer for writeFirmware(int[]). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256). This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
        Throws:
        TinkerforgeException
      • writeFirmware

        public int writeFirmware​(int[] data)
                          throws TinkerforgeException
        Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer(long) before. The firmware is written to flash every 4 chunks. You can only write firmware in bootloader mode. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
        Throws:
        TinkerforgeException
      • setStatusLEDConfig

        public void setStatusLEDConfig​(int config)
                                throws TinkerforgeException
        Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
        Throws:
        TinkerforgeException
      • getChipTemperature

        public int getChipTemperature()
                               throws TinkerforgeException
        Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature! The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
        Throws:
        TinkerforgeException
      • reset

        public void reset()
                   throws TinkerforgeException
        Calling this function will reset the Bricklet. All configurations will be lost. After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
        Throws:
        TinkerforgeException
      • writeUID

        public void writeUID​(long uid)
                      throws TinkerforgeException
        Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first. We recommend that you use Brick Viewer to change the UID.
        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
      • setLEDValues

        public void setLEDValues​(int index,
                                 int[] value)
                          throws TinkerforgeException
        Sets the RGB(W) values for the LEDs starting from *index*. You can set at most 2048 RGB values or 1536 RGBW values (6144 byte each). To make the colors show correctly you need to configure the chip type (see setChipType(int)) and a channel mapping (see setChannelMapping(int)) according to the connected LEDs. If the channel mapping has 3 colors, you need to give the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you need to give data in the sequence RGBWRGBWRGBW... The data is double buffered and the colors will be transfered to the 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 BrickletLEDStripV2.FrameStartedListener listener. * Set all of the LED colors for next frame. * Wait for the BrickletLEDStripV2.FrameStartedListener listener. * And so on. This approach ensures that you can change the LED colors with a fixed frame rate.
        Throws:
        TinkerforgeException
      • getLEDValues

        public int[] getLEDValues​(int index,
                                  int length)
                           throws TinkerforgeException
        Returns *length* RGB(W) values starting from the given *index*. If the channel mapping has 3 colors, you will get the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you will get the data in the sequence RGBWRGBWRGBW... (assuming you start at an index divisible by 3 (RGB) or 4 (RGBW)).
        Throws:
        TinkerforgeException