TCP/IP - RGB LED Matrix Bricklet

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

API

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

Basic Functions

BrickletRGBLEDMatrix.set_red
Function ID:
  • 1
Request:
  • red – Type: uint8[64], Range: [0 to 255]
Response:
  • no response

Sets the 64 red LED values of the matrix.

BrickletRGBLEDMatrix.get_red
Function ID:
  • 2
Request:
  • empty payload
Response:
  • red – Type: uint8[64], Range: [0 to 255]

Returns the red LED values as set by set_red.

BrickletRGBLEDMatrix.set_green
Function ID:
  • 3
Request:
  • green – Type: uint8[64], Range: [0 to 255]
Response:
  • no response

Sets the 64 green LED values of the matrix.

BrickletRGBLEDMatrix.get_green
Function ID:
  • 4
Request:
  • empty payload
Response:
  • green – Type: uint8[64], Range: [0 to 255]

Returns the green LED values as set by set_green.

BrickletRGBLEDMatrix.set_blue
Function ID:
  • 5
Request:
  • blue – Type: uint8[64], Range: [0 to 255]
Response:
  • no response

Sets the 64 blue LED values of the matrix.

BrickletRGBLEDMatrix.get_blue
Function ID:
  • 6
Request:
  • empty payload
Response:
  • blue – Type: uint8[64], Range: [0 to 255]

Returns the blue LED values as set by set_blue.

BrickletRGBLEDMatrix.set_frame_duration
Function ID:
  • 7
Request:
  • frame_duration – Type: uint16, Range: [0 to 216 - 1]
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).

Set this value to 0 to turn the automatic frame write mechanism off.

Approach:

For frame duration of 0 see draw_frame.

Default value: 0 = off.

BrickletRGBLEDMatrix.get_frame_duration
Function ID:
  • 8
Request:
  • empty payload
Response:
  • frame_duration – Type: uint16, Range: [0 to 216 - 1]

Returns the frame duration in ms as set by set_frame_duration.

BrickletRGBLEDMatrix.draw_frame
Function ID:
  • 9
Request:
  • empty payload
Response:
  • no response

If you set the frame duration to 0 (see set_frame_duration), you can use this function to transfer the frame to the matrix.

Approach:

Advanced Functions

BrickletRGBLEDMatrix.get_supply_voltage
Function ID:
  • 10
Request:
  • empty payload
Response:
  • voltage – Type: uint16, Range: [0 to 216 - 1]

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

BrickletRGBLEDMatrix.get_spitfp_error_count
Function ID:
  • 234
Request:
  • empty payload
Response:
  • error_count_ack_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_frame – Type: uint32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

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.

BrickletRGBLEDMatrix.set_bootloader_mode
Function ID:
  • 235
Request:
  • mode – Type: uint8, Range: See meanings
Response:
  • status – Type: uint8, Range: See meanings

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.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

For status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletRGBLEDMatrix.get_bootloader_mode
Function ID:
  • 236
Request:
  • empty payload
Response:
  • mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletRGBLEDMatrix.set_write_firmware_pointer
Function ID:
  • 237
Request:
  • pointer – Type: uint32, Range: [0 to 232 - 1]
Response:
  • no response

Sets the firmware pointer for write_firmware. 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.

BrickletRGBLEDMatrix.write_firmware
Function ID:
  • 238
Request:
  • data – Type: uint8[64], Range: [0 to 255]
Response:
  • status – Type: uint8, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer 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.

BrickletRGBLEDMatrix.set_status_led_config
Function ID:
  • 239
Request:
  • config – Type: uint8, Range: See meanings
Response:
  • no response

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.

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletRGBLEDMatrix.get_status_led_config
Function ID:
  • 240
Request:
  • empty payload
Response:
  • config – Type: uint8, Range: See meanings

Returns the configuration as set by set_status_led_config

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletRGBLEDMatrix.get_chip_temperature
Function ID:
  • 242
Request:
  • empty payload
Response:
  • temperature – Type: int16, Range: [-215 to 215 - 1]

Returns the temperature in °C 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.

BrickletRGBLEDMatrix.reset
Function ID:
  • 243
Request:
  • empty payload
Response:
  • no response

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!

BrickletRGBLEDMatrix.write_uid
Function ID:
  • 248
Request:
  • uid – Type: uint32, Range: [0 to 232 - 1]
Response:
  • no response

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.

BrickletRGBLEDMatrix.read_uid
Function ID:
  • 249
Request:
  • empty payload
Response:
  • uid – Type: uint32, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletRGBLEDMatrix.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char
  • hardware_version – Type: uint8[3], Range: [0 to 255]
  • firmware_version – Type: uint8[3], Range: [0 to 255]
  • device_identifier – Type: uint16, Range: [0 to 216 - 1]

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

BrickletRGBLEDMatrix.CALLBACK_FRAME_STARTED
Function ID:
  • 11
Response:
  • frame_number – Type: uint32, Range: [0 to 232 - 1]

This callback is triggered as soon as a new frame write is started. The LED values are double buffered, so you can send the LED values for the next frame directly after this callback is triggered.