Class: Tinkerforge::BrickletRGBLEDMatrix

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_rgb_led_matrix.rb

Overview

RGB LED Matrix with 8x8 pixel

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

272
DEVICE_DISPLAY_NAME =

:nodoc:

'RGB LED Matrix Bricklet'
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.

11
FUNCTION_SET_RED =

:nodoc:

1
FUNCTION_GET_RED =

:nodoc:

2
FUNCTION_SET_GREEN =

:nodoc:

3
FUNCTION_GET_GREEN =

:nodoc:

4
FUNCTION_SET_BLUE =

:nodoc:

5
FUNCTION_GET_BLUE =

:nodoc:

6
FUNCTION_SET_FRAME_DURATION =

:nodoc:

7
FUNCTION_GET_FRAME_DURATION =

:nodoc:

8
FUNCTION_DRAW_FRAME =

:nodoc:

9
FUNCTION_GET_SUPPLY_VOLTAGE =

:nodoc:

10
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
FUNCTION_GET_IDENTITY =

:nodoc:

255
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletRGBLEDMatrix

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 66

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

Instance Method Details

#draw_frame ⇒ Object

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:

  • Call BrickletRGBLEDMatrix#set_frame_duration with 0.

  • Set LED values for first frame with BrickletRGBLEDMatrix#set_red, BrickletRGBLEDMatrix#set_green, BrickletRGBLEDMatrix#set_blue.

  • Call BrickletRGBLEDMatrix#draw_frame.

  • Wait for CALLBACK_FRAME_STARTED callback.

  • Set LED values for second frame with BrickletRGBLEDMatrix#set_red, BrickletRGBLEDMatrix#set_green, BrickletRGBLEDMatrix#set_blue.

  • Call BrickletRGBLEDMatrix#draw_frame.

  • Wait for CALLBACK_FRAME_STARTED callback.

  • and so on.



184
185
186
187
188
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 184

def draw_frame
  check_validity

  send_request FUNCTION_DRAW_FRAME, [], '', 8, ''
end

#get_blue ⇒ Object

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



135
136
137
138
139
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 135

def get_blue
  check_validity

  send_request FUNCTION_GET_BLUE, [], '', 72, 'C64'
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletRGBLEDMatrix#set_bootloader_mode.



230
231
232
233
234
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 230

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_chip_temperature ⇒ Object

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.



288
289
290
291
292
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 288

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_frame_duration ⇒ Object

Returns the frame duration as set by BrickletRGBLEDMatrix#set_frame_duration.



165
166
167
168
169
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 165

def get_frame_duration
  check_validity

  send_request FUNCTION_GET_FRAME_DURATION, [], '', 10, 'S'
end

#get_green ⇒ Object

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



121
122
123
124
125
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 121

def get_green
  check_validity

  send_request FUNCTION_GET_GREEN, [], '', 72, 'C64'
end

#get_identity ⇒ Object

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|



335
336
337
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 335

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_red ⇒ Object

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



107
108
109
110
111
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 107

def get_red
  check_validity

  send_request FUNCTION_GET_RED, [], '', 72, 'C64'
end

#get_spitfp_error_count ⇒ Object

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.



208
209
210
211
212
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 208

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletRGBLEDMatrix#set_status_led_config



276
277
278
279
280
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 276

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#get_supply_voltage ⇒ Object

Returns the current supply voltage of the Bricklet.



191
192
193
194
195
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 191

def get_supply_voltage
  check_validity

  send_request FUNCTION_GET_SUPPLY_VOLTAGE, [], '', 10, 'S'
end

#read_uid ⇒ Object

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



319
320
321
322
323
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 319

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



340
341
342
343
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 340

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#reset ⇒ Object

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!



300
301
302
303
304
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 300

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_blue(blue) ⇒ Object

Sets the 64 blue LED values of the matrix.



128
129
130
131
132
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 128

def set_blue(blue)
  check_validity

  send_request FUNCTION_SET_BLUE, [blue], 'C64', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

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.



223
224
225
226
227
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 223

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_frame_duration(frame_duration) ⇒ Object

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:

  • Call BrickletRGBLEDMatrix#set_frame_duration with value > 0.

  • Set LED values for first frame with BrickletRGBLEDMatrix#set_red, BrickletRGBLEDMatrix#set_green, BrickletRGBLEDMatrix#set_blue.

  • Wait for CALLBACK_FRAME_STARTED callback.

  • Set LED values for second frame with BrickletRGBLEDMatrix#set_red, BrickletRGBLEDMatrix#set_green, BrickletRGBLEDMatrix#set_blue.

  • Wait for CALLBACK_FRAME_STARTED callback.

  • and so on.

For frame duration of 0 see BrickletRGBLEDMatrix#draw_frame.



158
159
160
161
162
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 158

def set_frame_duration(frame_duration)
  check_validity

  send_request FUNCTION_SET_FRAME_DURATION, [frame_duration], 'S', 8, ''
end

#set_green(green) ⇒ Object

Sets the 64 green LED values of the matrix.



114
115
116
117
118
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 114

def set_green(green)
  check_validity

  send_request FUNCTION_SET_GREEN, [green], 'C64', 8, ''
end

#set_red(red) ⇒ Object

Sets the 64 red LED values of the matrix.



100
101
102
103
104
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 100

def set_red(red)
  check_validity

  send_request FUNCTION_SET_RED, [red], 'C64', 8, ''
end

#set_status_led_config(config) ⇒ Object

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.



269
270
271
272
273
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 269

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

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.



242
243
244
245
246
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 242

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#write_firmware(data) ⇒ Object

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.



256
257
258
259
260
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 256

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

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.



311
312
313
314
315
 
# File 'lib/tinkerforge/bricklet_rgb_led_matrix.rb', line 311

def write_uid(uid)
  check_validity

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