Ruby - OLED 128x64 Bricklet 2.0¶

Hello World¶

Download (example_hello_world.rb)

 1#!/usr/bin/env ruby
 2# -*- ruby encoding: utf-8 -*-
 3
 4require 'tinkerforge/ip_connection'
 5require 'tinkerforge/bricklet_oled_128x64_v2'
 6
 7include Tinkerforge
 8
 9HOST = 'localhost'
10PORT = 4223
11UID = 'XYZ' # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0
12
13ipcon = IPConnection.new # Create IP connection
14oled = BrickletOLED128x64V2.new UID, ipcon # Create device object
15
16ipcon.connect HOST, PORT # Connect to brickd
17# Don't use device before ipcon is connected
18
19# Clear display
20oled.clear_display
21
22# Write "Hello World" starting from upper left corner of the screen
23oled.write_line 0, 0, 'Hello World'
24
25puts 'Press key to exit'
26$stdin.gets
27ipcon.disconnect

Pixel Matrix¶

Download (example_pixel_matrix.rb)

 1#!/usr/bin/env ruby
 2# -*- ruby encoding: utf-8 -*-
 3
 4require 'tinkerforge/ip_connection'
 5require 'tinkerforge/bricklet_oled_128x64_v2'
 6
 7include Tinkerforge
 8
 9HOST = 'localhost'
10PORT = 4223
11UID = 'XYZ' # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0
12WIDTH = 128 # Columns
13HEIGHT = 64 # Rows
14
15ipcon = IPConnection.new # Create IP connection
16oled = BrickletOLED128x64V2.new UID, ipcon # Create device object
17
18ipcon.connect HOST, PORT # Connect to brickd
19# Don't use device before ipcon is connected
20
21# Clear display
22oled.clear_display
23
24# Draw checkerboard pattern
25pixels = []
26
27for row in 0..HEIGHT - 1
28  for column in 0..WIDTH - 1
29    pixels[row * WIDTH + column] = (row / 8) % 2 == (column / 8) % 2
30  end
31end
32
33oled.write_pixels 0, 0, WIDTH-1, HEIGHT-1, pixels
34
35puts 'Press key to exit'
36$stdin.gets
37ipcon.disconnect

Scribble¶

Download (example_scribble.rb)

 1#!/usr/bin/env ruby
 2# -*- ruby encoding: utf-8 -*-
 3
 4require 'rgd'
 5require 'tinkerforge/ip_connection'
 6require 'tinkerforge/bricklet_oled_128x64_v2'
 7
 8include Tinkerforge
 9
10HOST = 'localhost'
11PORT = 4223
12UID = 'XYZ' # Change XYZ to the UID of your OLED 128x64 Bricklet 2.0
13WIDTH = 128 # Columns
14HEIGHT = 64 # Rows
15
16def draw_image(oled, start_column, start_row, column_count, row_count, image)
17  pixels = []
18
19  # Convert image pixels into 8bit pages
20  for row in 0..row_count - 1
21
22    for column in 0..column_count - 1
23      index = image[column, row]
24      rgba = image.rgba index
25      pixels[row*column_count + column] = rgba[0] > 0
26    end
27  end
28
29  oled.write_pixels 0, 0, WIDTH-1, HEIGHT-1, pixels
30end
31
32ipcon = IPConnection.new # Create IP connection
33oled = BrickletOLED128x64V2.new UID, ipcon # Create device object
34
35ipcon.connect HOST, PORT # Connect to brickd
36# Don't use device before ipcon is connected
37
38# Clear display
39oled.clear_display
40
41# Draw checkerboard pattern
42image = RGD::Image.create WIDTH, HEIGHT
43black = image.color_allocate 0, 0, 0
44white = image.color_allocate 255, 255, 255
45origin_x = WIDTH / 2
46origin_y = HEIGHT / 2
47length = HEIGHT / 2 - 2
48angle = 0
49
50puts 'Press key to exit'
51
52Thread.new do
53  $stdin.gets
54  exit
55end
56
57while true
58    radians = Math::PI * angle / 180.0
59    x = (origin_x + length * Math.cos(radians)).to_i
60    y = (origin_y + length * Math.sin(radians)).to_i
61
62    image.filled_rectangle 0, 0, WIDTH, HEIGHT, black
63    image.line origin_x, origin_y, x, y, white
64
65    draw_image oled, 0, 0, WIDTH, HEIGHT, image
66    sleep 0.025
67
68    angle += 1
69end

Basic Functions¶

BrickletOLED128x64V2::new(uid, ipcon) → oled_128x64_v2¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	oled_128x64_v2 – Type: BrickletOLED128x64V2

Creates an object with the unique device ID uid:

oled_128x64_v2 = BrickletOLED128x64V2.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletOLED128x64V2#write_pixels(x_start, y_start, x_end, y_end, pixels) → nil¶

Parameters:	x_start – Type: int, Range: [0 to 127] y_start – Type: int, Range: [0 to 63] x_end – Type: int, Range: [0 to 127] y_end – Type: int, Range: [0 to 63] pixels – Type: [bool, ...], Length: variable

Writes pixels to the specified window.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

If automatic draw is enabled (default) the pixels are directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the pixels are written to an internal buffer and the buffer is transferred to the display only after #draw_buffered_frame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the #set_display_configuration function.

BrickletOLED128x64V2#read_pixels(x_start, y_start, x_end, y_end) → [bool, ...]¶

Parameters:	x_start – Type: int, Range: [0 to 127] y_start – Type: int, Range: [0 to 63] x_end – Type: int, Range: [0 to 127] y_end – Type: int, Range: [0 to 63]
Returns:	pixels – Type: [bool, ...], Length: variable

Reads pixels from the specified window.

The pixels are read from the window line by line top to bottom and each line is read from left to right.

If automatic draw is enabled (default) the pixels that are read are always the same that are shown on the display.

If automatic draw is disabled the pixels are read from the internal buffer (see #draw_buffered_frame).

Automatic draw can be configured with the #set_display_configuration function.

BrickletOLED128x64V2#clear_display → nil¶

Clears the complete content of the display.

If automatic draw is enabled (default) the pixels are directly cleared.

If automatic draw is disabled the the internal buffer is cleared and the buffer is transferred to the display only after #draw_buffered_frame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the #set_display_configuration function.

BrickletOLED128x64V2#write_line(line, position, text) → nil¶

Parameters:	line – Type: int, Range: [0 to 7] position – Type: int, Range: [0 to 21] text – Type: str, Length: up to 22

Note

This function is deprecated and only here for backward compatibility. Since firmware version 2.0.5 we recommend #write_line_2. It has an additional parameter for letter spacing.

Writes text to a specific line with a specific position. The text can have a maximum of 22 characters.

For example: (1, 10, "Hello") will write Hello in the middle of the second line of the display.

The display uses a special 5x7 pixel charset. You can view the characters of the charset in Brick Viewer.

If automatic draw is enabled (default) the text is directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the text is written to an internal buffer and the buffer is transferred to the display only after #draw_buffered_frame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the #set_display_configuration function.

The font conforms to code page 437.

BrickletOLED128x64V2#draw_buffered_frame(force_complete_redraw) → nil¶

Parameters:	force_complete_redraw – Type: bool

Draws the currently buffered frame. Normally each call of #write_pixels and #write_line draws directly onto the display. If you turn automatic draw off (#set_display_configuration), the data is written in an internal buffer and only transferred to the display by calling this function. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Set the force complete redraw to true to redraw the whole display instead of only the changed parts. Normally it should not be necessary to set this to true. It may only become necessary in case of stuck pixels because of errors.

BrickletOLED128x64V2#write_line_2(line, position, letter_spacing, text) → nil¶

Parameters:	line – Type: int, Range: [0 to 7] position – Type: int, Range: [0 to 25] letter_spacing – Type: int, Range: [0 to 1] text – Type: str, Length: up to 26

Writes text to a specific line with a specific position. The text can have a maximum of 26 characters.

With a letter spacing of 0, a maximum of 26 characters can be written and with a letter spacing of 1 a maximum of 22 characters can be written.

For example: (1, 10, "Hello") will write Hello in the middle of the second line of the display.

The display uses a special 5x7 pixel charset. You can view the characters of the charset in Brick Viewer.

If automatic draw is enabled (default) the text is directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the text is written to an internal buffer and the buffer is transferred to the display only after #draw_buffered_frame is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the #set_display_configuration function.

Advanced Functions¶

BrickletOLED128x64V2#set_display_configuration(contrast, invert, automatic_draw) → nil¶

Parameters:	contrast – Type: int, Range: [0 to 255], Default: 143 invert – Type: bool, Default: false automatic_draw – Type: bool, Default: true

Sets the configuration of the display.

You can set a contrast value from 0 to 255 and you can invert the color (white/black) of the display.

If automatic draw is set to true, the display is automatically updated with every call of #write_pixels or #write_line. If it is set to false, the changes are written into an internal buffer and only shown on the display after a call of #draw_buffered_frame.

BrickletOLED128x64V2#get_display_configuration → [int, bool, bool]¶

Return Array:	0: contrast – Type: int, Range: [0 to 255], Default: 143 1: invert – Type: bool, Default: false 2: automatic_draw – Type: bool, Default: true

Returns the configuration as set by #set_display_configuration.

BrickletOLED128x64V2#get_spitfp_error_count → [int, int, int, int]¶

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 232 - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 232 - 1] 2: error_count_frame – Type: int, Range: [0 to 232 - 1] 3: error_count_overflow – Type: int, 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.

BrickletOLED128x64V2#set_status_led_config(config) → nil¶

Parameters:	config – Type: int, 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:

• BrickletOLED128x64V2::STATUS_LED_CONFIG_OFF = 0

• BrickletOLED128x64V2::STATUS_LED_CONFIG_ON = 1

• BrickletOLED128x64V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

• BrickletOLED128x64V2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletOLED128x64V2#get_status_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

For config:

• BrickletOLED128x64V2::STATUS_LED_CONFIG_OFF = 0

• BrickletOLED128x64V2::STATUS_LED_CONFIG_ON = 1

• BrickletOLED128x64V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

• BrickletOLED128x64V2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletOLED128x64V2#get_chip_temperature → int¶

Returns:	temperature – Type: int, 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.

BrickletOLED128x64V2#reset → nil¶

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!

BrickletOLED128x64V2#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 4: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 5: device_identifier – Type: int, 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). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

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.

BrickletOLED128x64V2#get_api_version → [int, ...]¶

Return Array:	0: api_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, 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.

BrickletOLED128x64V2#get_response_expected(function_id) → bool¶

Parameters:	function_id – Type: int, 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 #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:

• BrickletOLED128x64V2::FUNCTION_WRITE_PIXELS = 1

• BrickletOLED128x64V2::FUNCTION_CLEAR_DISPLAY = 3

• BrickletOLED128x64V2::FUNCTION_SET_DISPLAY_CONFIGURATION = 4

• BrickletOLED128x64V2::FUNCTION_WRITE_LINE = 6

• BrickletOLED128x64V2::FUNCTION_DRAW_BUFFERED_FRAME = 7

• BrickletOLED128x64V2::FUNCTION_WRITE_LINE_2 = 8

• BrickletOLED128x64V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

• BrickletOLED128x64V2::FUNCTION_SET_STATUS_LED_CONFIG = 239

• BrickletOLED128x64V2::FUNCTION_RESET = 243

• BrickletOLED128x64V2::FUNCTION_WRITE_UID = 248

BrickletOLED128x64V2#set_response_expected(function_id, response_expected) → nil¶

Parameters:	function_id – Type: int, 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:

• BrickletOLED128x64V2::FUNCTION_WRITE_PIXELS = 1

• BrickletOLED128x64V2::FUNCTION_CLEAR_DISPLAY = 3

• BrickletOLED128x64V2::FUNCTION_SET_DISPLAY_CONFIGURATION = 4

• BrickletOLED128x64V2::FUNCTION_WRITE_LINE = 6

• BrickletOLED128x64V2::FUNCTION_DRAW_BUFFERED_FRAME = 7

• BrickletOLED128x64V2::FUNCTION_WRITE_LINE_2 = 8

• BrickletOLED128x64V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

• BrickletOLED128x64V2::FUNCTION_SET_STATUS_LED_CONFIG = 239

• BrickletOLED128x64V2::FUNCTION_RESET = 243

• BrickletOLED128x64V2::FUNCTION_WRITE_UID = 248

BrickletOLED128x64V2#set_response_expected_all(response_expected) → nil¶

Parameters:	response_expected – Type: bool

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletOLED128x64V2#set_bootloader_mode(mode) → int¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, 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:

• BrickletOLED128x64V2::BOOTLOADER_MODE_BOOTLOADER = 0

• BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE = 1

• BrickletOLED128x64V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

• BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

• BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletOLED128x64V2::BOOTLOADER_STATUS_OK = 0

• BrickletOLED128x64V2::BOOTLOADER_STATUS_INVALID_MODE = 1

• BrickletOLED128x64V2::BOOTLOADER_STATUS_NO_CHANGE = 2

• BrickletOLED128x64V2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3

• BrickletOLED128x64V2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4

• BrickletOLED128x64V2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletOLED128x64V2#get_bootloader_mode → int¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

For mode:

• BrickletOLED128x64V2::BOOTLOADER_MODE_BOOTLOADER = 0

• BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE = 1

• BrickletOLED128x64V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

• BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

• BrickletOLED128x64V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletOLED128x64V2#set_write_firmware_pointer(pointer) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]

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.

BrickletOLED128x64V2#write_firmware(data) → int¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, 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.

BrickletOLED128x64V2#write_uid(uid) → nil¶

Parameters:	uid – Type: int, 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.

BrickletOLED128x64V2#read_uid → int¶

Returns:	uid – Type: int, Range: [0 to 232 - 1]

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

Constants¶

BrickletOLED128x64V2::DEVICE_IDENTIFIER¶

This constant is used to identify a OLED 128x64 Bricklet 2.0.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletOLED128x64V2::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a OLED 128x64 Bricklet 2.0.