class Tinkerforge::BrickletRGBLEDMatrix

RGB LED Matrix with 8x8 pixel

Constants

CALLBACK_FRAME_STARTED

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.

Public Class Methods

new(uid, ipcon) click to toggle source

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.

Calls superclass method
# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 65
def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_RED] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_RED] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_GREEN] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_GREEN] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BLUE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_BLUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_FRAME_DURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_FRAME_DURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_DRAW_FRAME] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SUPPLY_VOLTAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_FRAME_STARTED] = [12, 'L']

  @ipcon.add_device self
end

Public Instance Methods

draw_frame() click to toggle source

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

Approach:

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 183
def draw_frame
  check_validity

  send_request FUNCTION_DRAW_FRAME, [], '', 8, ''
end
get_blue() click to toggle source

Returns the blue LED values as set by BrickletRGBLEDMatrix#set_blue.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 134
def get_blue
  check_validity

  send_request FUNCTION_GET_BLUE, [], '', 72, 'C64'
end
get_bootloader_mode() click to toggle source

Returns the current bootloader mode, see BrickletRGBLEDMatrix#set_bootloader_mode.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 229
def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end
get_chip_temperature() click to toggle source

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.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 287
def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end
get_frame_duration() click to toggle source

Returns the frame duration as set by BrickletRGBLEDMatrix#set_frame_duration.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 164
def get_frame_duration
  check_validity

  send_request FUNCTION_GET_FRAME_DURATION, [], '', 10, 'S'
end
get_green() click to toggle source

Returns the green LED values as set by BrickletRGBLEDMatrix#set_green.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 120
def get_green
  check_validity

  send_request FUNCTION_GET_GREEN, [], '', 72, 'C64'
end
get_identity() click to toggle source

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|

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 334
def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end
get_red() click to toggle source

Returns the red LED values as set by BrickletRGBLEDMatrix#set_red.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 106
def get_red
  check_validity

  send_request FUNCTION_GET_RED, [], '', 72, 'C64'
end
get_spitfp_error_count() click to toggle source

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.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 207
def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end
get_status_led_config() click to toggle source

Returns the configuration as set by BrickletRGBLEDMatrix#set_status_led_config

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 275
def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end
get_supply_voltage() click to toggle source

Returns the current supply voltage of the Bricklet.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 190
def get_supply_voltage
  check_validity

  send_request FUNCTION_GET_SUPPLY_VOLTAGE, [], '', 10, 'S'
end
read_uid() click to toggle source

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

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 318
def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end
register_callback(id, &block) click to toggle source

Registers a callback with ID id to the block block.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 339
def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end
reset() click to toggle source

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!

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 299
def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end
set_blue(blue) click to toggle source

Sets the 64 blue LED values of the matrix.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 127
def set_blue(blue)
  check_validity

  send_request FUNCTION_SET_BLUE, [blue], 'C64', 8, ''
end
set_bootloader_mode(mode) click to toggle source

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.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 222
def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end
set_frame_duration(frame_duration) click to toggle source

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 BrickletRGBLEDMatrix#draw_frame.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 157
def set_frame_duration(frame_duration)
  check_validity

  send_request FUNCTION_SET_FRAME_DURATION, [frame_duration], 'S', 8, ''
end
set_green(green) click to toggle source

Sets the 64 green LED values of the matrix.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 113
def set_green(green)
  check_validity

  send_request FUNCTION_SET_GREEN, [green], 'C64', 8, ''
end
set_red(red) click to toggle source

Sets the 64 red LED values of the matrix.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 99
def set_red(red)
  check_validity

  send_request FUNCTION_SET_RED, [red], 'C64', 8, ''
end
set_status_led_config(config) click to toggle source

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.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 268
def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end
set_write_firmware_pointer(pointer) click to toggle source

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

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 241
def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end
write_firmware(data) click to toggle source

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

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 255
def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end
write_uid(uid) click to toggle source

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.

# File lib/tinkerforge/bricklet_rgb_led_matrix.rb, line 310
def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end