Rust - RGB LED Matrix Bricklet

This is the description of the Rust API bindings for the RGB LED Matrix Bricklet. General information and technical specifications for the RGB LED Matrix Bricklet are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

The example code below is Public Domain (CC0 1.0).

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occured.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

pub fn RgbLedMatrixBricklet::new(uid: &str, ip_connection: &IpConnection) → RgbLedMatrixBricklet
Parameters:
  • uid – Type: &str
  • ip_connection – Type: &IPConnection
Returns:
  • rgb_led_matrix – Type: RgbLedMatrixBricklet

Creates a new RgbLedMatrixBricklet object with the unique device ID uid and adds it to the IPConnection ip_connection:

let rgb_led_matrix = RgbLedMatrixBricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected (see examples above).

pub fn RgbLedMatrixBricklet::set_red(&self, red: [u8; 64]) → ConvertingReceiver<()>
Parameters:
  • red – Type: [u8; 64], Range: [0 to 255]

Sets the 64 red LED values of the matrix.

pub fn RgbLedMatrixBricklet::get_red(&self) → ConvertingReceiver<[u8; 64]>
Returns:
  • red – Type: [u8; 64], Range: [0 to 255], Default: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

Returns the red LED values as set by RgbLedMatrixBricklet::set_red.

pub fn RgbLedMatrixBricklet::set_green(&self, green: [u8; 64]) → ConvertingReceiver<()>
Parameters:
  • green – Type: [u8; 64], Range: [0 to 255], Default: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

Sets the 64 green LED values of the matrix.

pub fn RgbLedMatrixBricklet::get_green(&self) → ConvertingReceiver<[u8; 64]>
Returns:
  • green – Type: [u8; 64], Range: [0 to 255], Default: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

Returns the green LED values as set by RgbLedMatrixBricklet::set_green.

pub fn RgbLedMatrixBricklet::set_blue(&self, blue: [u8; 64]) → ConvertingReceiver<()>
Parameters:
  • blue – Type: [u8; 64], Range: [0 to 255], Default: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

Sets the 64 blue LED values of the matrix.

pub fn RgbLedMatrixBricklet::get_blue(&self) → ConvertingReceiver<[u8; 64]>
Returns:
  • blue – Type: [u8; 64], Range: [0 to 255], Default: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

Returns the blue LED values as set by RgbLedMatrixBricklet::set_blue.

pub fn RgbLedMatrixBricklet::set_frame_duration(&self, frame_duration: u16) → ConvertingReceiver<()>
Parameters:
  • frame_duration – Type: u16, Unit: 1 ms, Range: [0 to 216 - 1], Default: 0

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

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

Approach:

For frame duration of 0 see RgbLedMatrixBricklet::draw_frame.

pub fn RgbLedMatrixBricklet::get_frame_duration(&self) → ConvertingReceiver<u16>
Returns:
  • frame_duration – Type: u16, Unit: 1 ms, Range: [0 to 216 - 1], Default: 0

Returns the frame duration as set by RgbLedMatrixBricklet::set_frame_duration.

pub fn RgbLedMatrixBricklet::draw_frame(&self) → ConvertingReceiver<()>

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

Approach:

Advanced Functions

pub fn RgbLedMatrixBricklet::get_supply_voltage(&self) → ConvertingReceiver<u16>
Returns:
  • voltage – Type: u16, Unit: 1 mV, Range: [0 to 216 - 1]

Returns the current supply voltage of the Bricklet.

pub fn RgbLedMatrixBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Return Object:
  • error_count_ack_checksum – Type: u32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: u32, Range: [0 to 232 - 1]
  • error_count_frame – Type: u32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: u32, 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.

pub fn RgbLedMatrixBricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameters:
  • mode – Type: u8, Range: See constants
Returns:
  • status – Type: u8, Range: See constants

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 constants are available for this function:

For mode:

  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn RgbLedMatrixBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Returns:
  • mode – Type: u8, Range: See constants

Returns the current bootloader mode, see RgbLedMatrixBricklet::set_bootloader_mode.

The following constants are available for this function:

For mode:

  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • RGB_LED_MATRIX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn RgbLedMatrixBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameters:
  • pointer – Type: u32, Unit: 1 B, Range: [0 to 232 - 1]

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

pub fn RgbLedMatrixBricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameters:
  • data – Type: [u8; 64], Range: [0 to 255]
Returns:
  • status – Type: u8, Range: [0 to 255]

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

pub fn RgbLedMatrixBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameters:
  • config – Type: u8, Range: See constants, Default: 3

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 constants are available for this function:

For config:

  • RGB_LED_MATRIX_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • RGB_LED_MATRIX_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • RGB_LED_MATRIX_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • RGB_LED_MATRIX_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn RgbLedMatrixBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Returns:
  • config – Type: u8, Range: See constants, Default: 3

Returns the configuration as set by RgbLedMatrixBricklet::set_status_led_config

The following constants are available for this function:

For config:

  • RGB_LED_MATRIX_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • RGB_LED_MATRIX_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • RGB_LED_MATRIX_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • RGB_LED_MATRIX_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn RgbLedMatrixBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Returns:
  • temperature – Type: i16, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

pub fn RgbLedMatrixBricklet::reset(&self) → ConvertingReceiver<()>

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!

pub fn RgbLedMatrixBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameters:
  • uid – Type: u32, Range: [0 to 232 - 1]

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.

pub fn RgbLedMatrixBricklet::read_uid(&self) → ConvertingReceiver<u32>
Returns:
  • uid – Type: u32, Range: [0 to 232 - 1]

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

pub fn RgbLedMatrixBricklet::get_identity(&self) → ConvertingReceiver<Identity>
Return Object:
  • uid – Type: String, Length: up to 8
  • connected_uid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardware_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]
  • firmware_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]
  • device_identifier – Type: u16, 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

pub fn RgbLedMatrixBricklet::get_frame_started_callback_receiver(&self) → ConvertingCallbackReceiver<u32>
Event:
  • frame_number – Type: u32, Range: [0 to 232 - 1]

Receivers created with this function receive Frame Started events.

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.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

pub fn RgbLedMatrixBricklet::get_api_version(&self) → [u8; 3]
Return Object:
  • api_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

pub fn RgbLedMatrixBricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameters:
  • function_id – Type: u8, Range: See constants
Returns:
  • response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by RgbLedMatrixBricklet::set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_RED = 1
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_GREEN = 3
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_BLUE = 5
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_FRAME_DURATION = 7
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_DRAW_FRAME = 9
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_RESET = 243
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn RgbLedMatrixBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameters:
  • function_id – Type: u8, Range: See constants
  • response_expected – Type: bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_RED = 1
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_GREEN = 3
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_BLUE = 5
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_FRAME_DURATION = 7
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_DRAW_FRAME = 9
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_RESET = 243
  • RGB_LED_MATRIX_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn RgbLedMatrixBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameters:
  • response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

pub const RgbLedMatrixBricklet::DEVICE_IDENTIFIER

This constant is used to identify a RGB LED Matrix Bricklet.

The RgbLedMatrixBricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

pub const RgbLedMatrixBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a RGB LED Matrix Bricklet.