public class BrickletRGBLEDMatrix extends Device
Modifier and Type | Class and Description |
---|---|
static interface |
BrickletRGBLEDMatrix.FrameStartedListener
This listener is triggered as soon as a new frame write is started.
|
class |
BrickletRGBLEDMatrix.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletRGBLEDMatrix(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addFrameStartedListener(BrickletRGBLEDMatrix.FrameStartedListener listener)
Adds a FrameStarted listener.
|
void |
drawFrame()
If you set the frame duration to 0 (see
setFrameDuration(int) ), you can use this
function to transfer the frame to the matrix. |
int[] |
getBlue()
Returns the blue LED values as set by
setBlue(int[]) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
int |
getFrameDuration()
Returns the frame duration as set by
setFrameDuration(int) . |
int[] |
getGreen()
Returns the green LED values as set by
setGreen(int[]) . |
Device.Identity |
getIdentity()
Returns the UID, the UID where the Bricklet is connected to,
the position, the hardware and firmware version as well as the
device identifier.
|
int[] |
getRed()
Returns the red LED values as set by
setRed(int[]) . |
BrickletRGBLEDMatrix.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
int |
getSupplyVoltage()
Returns the current supply voltage of the Bricklet.
|
long |
readUID()
Returns the current UID as an integer.
|
void |
removeFrameStartedListener(BrickletRGBLEDMatrix.FrameStartedListener listener)
Removes a FrameStarted listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
void |
setBlue(int[] blue)
Sets the 64 blue LED values of the matrix.
|
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setFrameDuration(int frameDuration)
Sets the frame duration.
|
void |
setGreen(int[] green)
Sets the 64 green LED values of the matrix.
|
void |
setRed(int[] red)
Sets the 64 red LED values of the matrix.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_SET_RED
public static final byte FUNCTION_GET_RED
public static final byte FUNCTION_SET_GREEN
public static final byte FUNCTION_GET_GREEN
public static final byte FUNCTION_SET_BLUE
public static final byte FUNCTION_GET_BLUE
public static final byte FUNCTION_SET_FRAME_DURATION
public static final byte FUNCTION_GET_FRAME_DURATION
public static final byte FUNCTION_DRAW_FRAME
public static final byte FUNCTION_GET_SUPPLY_VOLTAGE
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletRGBLEDMatrix(java.lang.String uid, IPConnection ipcon)
public void setRed(int[] red) throws TinkerforgeException
TinkerforgeException
public int[] getRed() throws TinkerforgeException
setRed(int[])
.TinkerforgeException
public void setGreen(int[] green) throws TinkerforgeException
TinkerforgeException
public int[] getGreen() throws TinkerforgeException
setGreen(int[])
.TinkerforgeException
public void setBlue(int[] blue) throws TinkerforgeException
TinkerforgeException
public int[] getBlue() throws TinkerforgeException
setBlue(int[])
.TinkerforgeException
public void setFrameDuration(int frameDuration) throws TinkerforgeException
setFrameDuration(int)
with value > 0.
* Set LED values for first frame with setRed(int[])
, setGreen(int[])
, setBlue(int[])
.
* Wait for BrickletRGBLEDMatrix.FrameStartedListener
listener.
* Set LED values for second frame with setRed(int[])
, setGreen(int[])
, setBlue(int[])
.
* Wait for BrickletRGBLEDMatrix.FrameStartedListener
listener.
* and so on.
For frame duration of 0 see drawFrame()
.TinkerforgeException
public int getFrameDuration() throws TinkerforgeException
setFrameDuration(int)
.TinkerforgeException
public void drawFrame() throws TinkerforgeException
setFrameDuration(int)
), you can use this
function to transfer the frame to the matrix.
Approach:
* Call setFrameDuration(int)
with 0.
* Set LED values for first frame with setRed(int[])
, setGreen(int[])
, setBlue(int[])
.
* Call drawFrame()
.
* Wait for BrickletRGBLEDMatrix.FrameStartedListener
listener.
* Set LED values for second frame with setRed(int[])
, setGreen(int[])
, setBlue(int[])
.
* Call drawFrame()
.
* Wait for BrickletRGBLEDMatrix.FrameStartedListener
listener.
* and so on.TinkerforgeException
public int getSupplyVoltage() throws TinkerforgeException
TinkerforgeException
public BrickletRGBLEDMatrix.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addFrameStartedListener(BrickletRGBLEDMatrix.FrameStartedListener listener)
public void removeFrameStartedListener(BrickletRGBLEDMatrix.FrameStartedListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.