Ruby - LCD 128x64 Bricklet

This is the description of the Ruby API bindings for the LCD 128x64 Bricklet. General information and technical specifications for the LCD 128x64 Bricklet are summarized in its hardware description.

An installation guide for the Ruby API bindings is part of their general description.

Examples

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

Hello World

Download (example_hello_world.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_lcd_128x64'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your LCD 128x64 Bricklet

ipcon = IPConnection.new # Create IP connection
lcd = BrickletLCD128x64.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
lcd.clear_display

# Write "Hello World" starting from upper left corner of the screen
lcd.write_line 0, 0, 'Hello World'

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Big Font

Download (example_big_font.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_lcd_128x64'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your LCD 128x64 Bricklet

ipcon = IPConnection.new # Create IP connection
lcd = BrickletLCD128x64.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
lcd.clear_display

# Write "Hello World" with big 24x32 font
lcd.draw_text 0, 0, BrickletLCD128x64::FONT_24X32, BrickletLCD128x64::COLOR_BLACK, \
              '24x32'

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Pixel Matrix

Download (example_pixel_matrix.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_lcd_128x64'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your LCD 128x64 Bricklet
WIDTH = 128 # Columns
HEIGHT = 64 # Rows

ipcon = IPConnection.new # Create IP connection
lcd = BrickletLCD128x64.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
lcd.clear_display

# Draw checkerboard pattern
pixels = []

for row in 0..HEIGHT - 1
  for column in 0..WIDTH - 1
    pixels[row * WIDTH + column] = (row / 8) % 2 == (column / 8) % 2
  end
end

lcd.write_pixels 0, 0, WIDTH-1, HEIGHT-1, pixels

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Touch

Download (example_touch.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_lcd_128x64'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your LCD 128x64 Bricklet

ipcon = IPConnection.new # Create IP connection
lcd = BrickletLCD128x64.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register touch position callback
lcd.register_callback(BrickletLCD128x64::CALLBACK_TOUCH_POSITION) do |pressure, x, y, age|
  puts "Pressure: #{pressure}"
  puts "X: #{x}"
  puts "Y: #{y}"
  puts "Age: #{age}"
  puts ''
end

# Register touch gesture callback
lcd.register_callback(BrickletLCD128x64::CALLBACK_TOUCH_GESTURE) do |gesture, duration,
                                                                     pressure_max,
                                                                     x_start, x_end,
                                                                     y_start, y_end, age|
  puts "Gesture: #{gesture}"
  puts "Duration: #{duration}"
  puts "Pressure Max: #{pressure_max}"
  puts "X Start: #{x_start}"
  puts "X End: #{x_end}"
  puts "Y Start: #{y_start}"
  puts "Y End: #{y_end}"
  puts "Age: #{age}"
  puts ''
end

# Set period for touch position callback to 0.1s (100ms)
lcd.set_touch_position_callback_configuration 100, true

# Set period for touch gesture callback to 0.1s (100ms)
lcd.set_touch_gesture_callback_configuration 100, true

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Scribble

Download (example_scribble.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'rgd'
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_lcd_128x64'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change to your UID
WIDTH = 128 # Columns
HEIGHT = 64 # Rows

def draw_image(lcd, start_column, start_row, column_count, row_count, image)
  pixels = []

  # Convert image pixels into 8bit pages
  for row in 0..row_count - 1

    for column in 0..column_count - 1
      index = image[column, row]
      rgba = image.rgba index
      pixels[row*column_count + column] = rgba[0] > 0
    end
  end

  lcd.write_pixels 0, 0, WIDTH-1, HEIGHT-1, pixels
end

ipcon = IPConnection.new # Create IP connection
lcd = BrickletLCD128x64.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Clear display
lcd.clear_display

# Draw checkerboard pattern
image = RGD::Image.create WIDTH, HEIGHT
black = image.color_allocate 0, 0, 0
white = image.color_allocate 255, 255, 255
origin_x = WIDTH / 2
origin_y = HEIGHT / 2
length = HEIGHT / 2 - 2
angle = 0

puts 'Press key to exit'

Thread.new do
  $stdin.gets
  exit
end

while true
    radians = Math::PI * angle / 180.0
    x = (origin_x + length * Math.cos(radians)).to_i
    y = (origin_y + length * Math.sin(radians)).to_i

    image.filled_rectangle 0, 0, WIDTH, HEIGHT, black
    image.line origin_x, origin_y, x, y, white

    draw_image lcd, 0, 0, WIDTH, HEIGHT, image
    sleep 0.025

    angle += 1
end

Gui

Download (example_gui.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_lcd_128x64'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your LCD 128x64 Bricklet

ipcon = IPConnection.new # Create IP connection
lcd = BrickletLCD128x64.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register gui button pressed callback
lcd.register_callback(BrickletLCD128x64::CALLBACK_GUI_BUTTON_PRESSED) do |index, pressed|
  puts "Index: #{index}"
  puts "Pressed: #{pressed}"
  puts ''
end

# Register gui slider value callback
lcd.register_callback(BrickletLCD128x64::CALLBACK_GUI_SLIDER_VALUE) do |index, value|
  puts "Index: #{index}"
  puts "Value: #{value}"
  puts ''
end

# Register gui tab selected callback
lcd.register_callback(BrickletLCD128x64::CALLBACK_GUI_TAB_SELECTED) do |index|
  puts "Index: #{index}"
end

# Clear display
lcd.clear_display
lcd.remove_all_gui

# Add GUI elements: Button, Slider and Graph with 60 data points
lcd.set_gui_button 0, 0, 0, 60, 20, 'button'
lcd.set_gui_slider 0, 0, 30, 60, BrickletLCD128x64::DIRECTION_HORIZONTAL, 50
lcd.set_gui_graph_configuration 0, BrickletLCD128x64::GRAPH_TYPE_LINE, 62, 0, 60, 52, \
                                'X', 'Y'

# Add a few data points (the remaining points will be 0)
lcd.set_gui_graph_data 0, [20, 40, 60, 80, 100, 120, 140, 160, 180, 200, 220, 240]

# Add 5 text tabs without and configure it for click and swipe without auto-redraw
lcd.set_gui_tab_configuration BrickletLCD128x64::CHANGE_TAB_ON_CLICK_AND_SWIPE, false
lcd.set_gui_tab_text 0, 'Tab A'
lcd.set_gui_tab_text 1, 'Tab B'
lcd.set_gui_tab_text 2, 'Tab C'
lcd.set_gui_tab_text 3, 'Tab D'
lcd.set_gui_tab_text 4, 'Tab E'

# Set period for gui button pressed callback to 0.1s (100ms)
lcd.set_gui_button_pressed_callback_configuration 100, true

# Set period for gui slider value callback to 0.1s (100ms)
lcd.set_gui_slider_value_callback_configuration 100, true

# Set period for gui tab selected callback to 0.1s (100ms)
lcd.set_gui_tab_selected_callback_configuration 100, true

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All methods listed below are thread-safe.

Basic Functions

BrickletLCD128x64::new(uid, ipcon) → lcd_128x64
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

lcd_128x64 = BrickletLCD128x64.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected (see examples above).

BrickletLCD128x64#write_pixels(x_start, y_start, x_end, y_end, pixels) → nil
Parameters:
  • x_start -- int
  • y_start -- int
  • x_end -- int
  • y_end -- int
  • pixels -- [bool, bool, ...]

Writes pixels to the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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.

BrickletLCD128x64#read_pixels(x_start, y_start, x_end, y_end) → [bool, bool, ...]
Parameters:
  • x_start -- int
  • y_start -- int
  • x_end -- int
  • y_end -- int

Reads pixels from the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. 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.

BrickletLCD128x64#clear_display → nil

Clears the complete content of the display.

BrickletLCD128x64#write_line(line, position, text) → nil
Parameters:
  • line -- int
  • position -- int
  • text -- str

Writes text to a specific line (0 to 7) with a specific position (0 to 21). 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.

This function is a 1:1 replacement for the function with the same name in the LCD 20x4 Bricklet. You can draw text at a specific pixel position and with different font sizes with the #draw_text function.

BrickletLCD128x64#draw_buffered_frame(force_complete_redraw) → nil
Parameters:force_complete_redraw -- 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.

BrickletLCD128x64#get_touch_position → [int, int, int, int]

Returns the last valid touch position:

  • Pressure: Amount of pressure applied by the user (0-300)
  • X: Touch position on x-axis (0-127)
  • Y: Touch position on y-axis (0-63)
  • Age: Age of touch press in ms (how long ago it was)

The returned array has the values pressure, x, y and age.

BrickletLCD128x64#get_touch_gesture → [int, int, int, int, int, int, int, int]

Returns one of four touch gestures that can be automatically detected by the Bricklet.

The gestures are swipes from left to right, right to left, top to bottom and bottom to top.

Additionally to the gestures a vector with a start and end position of the gesture is provided. You can use this vector do determine a more exact location of the gesture (e.g. the swipe from top to bottom was on the left or right part of the screen).

The age parameter corresponds to the age of gesture in ms (how long ago it was).

The following constants are available for this function:

  • BrickletLCD128x64::GESTURE_LEFT_TO_RIGHT = 0
  • BrickletLCD128x64::GESTURE_RIGHT_TO_LEFT = 1
  • BrickletLCD128x64::GESTURE_TOP_TO_BOTTOM = 2
  • BrickletLCD128x64::GESTURE_BOTTOM_TO_TOP = 3

The returned array has the values gesture, duration, pressure_max, x_start, y_start, x_end, y_end and age.

BrickletLCD128x64#draw_line(position_x_start, position_y_start, position_x_end, position_y_end, color) → nil
Parameters:
  • position_x_start -- int
  • position_y_start -- int
  • position_x_end -- int
  • position_y_end -- int
  • color -- bool

Draws a white or black line from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have t be within the range of 0 to 63.

The following constants are available for this function:

  • BrickletLCD128x64::COLOR_WHITE = false
  • BrickletLCD128x64::COLOR_BLACK = true

New in version 2.0.2 (Plugin).

BrickletLCD128x64#draw_box(position_x_start, position_y_start, position_x_end, position_y_end, fill, color) → nil
Parameters:
  • position_x_start -- int
  • position_y_start -- int
  • position_x_end -- int
  • position_y_end -- int
  • fill -- bool
  • color -- bool

Draws a white or black box from (x, y)-start to (x, y)-end. The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

If you set fill to true, the box will be filled with the color. Otherwise only the outline will be drawn.

The following constants are available for this function:

  • BrickletLCD128x64::COLOR_WHITE = false
  • BrickletLCD128x64::COLOR_BLACK = true

New in version 2.0.2 (Plugin).

BrickletLCD128x64#draw_text(position_x, position_y, font, color, text) → nil
Parameters:
  • position_x -- int
  • position_y -- int
  • font -- int
  • color -- bool
  • text -- str

Draws a text with up to 22 characters at the pixel position (x, y).

The x values have to be within the range of 0 to 127 and the y values have to be within the range of 0 to 63.

You can use one of 9 different font sizes and draw the text in white or black.

The following constants are available for this function:

  • BrickletLCD128x64::FONT_6X8 = 0
  • BrickletLCD128x64::FONT_6X16 = 1
  • BrickletLCD128x64::FONT_6X24 = 2
  • BrickletLCD128x64::FONT_6X32 = 3
  • BrickletLCD128x64::FONT_12X16 = 4
  • BrickletLCD128x64::FONT_12X24 = 5
  • BrickletLCD128x64::FONT_12X32 = 6
  • BrickletLCD128x64::FONT_18X24 = 7
  • BrickletLCD128x64::FONT_18X32 = 8
  • BrickletLCD128x64::FONT_24X32 = 9
  • BrickletLCD128x64::COLOR_WHITE = false
  • BrickletLCD128x64::COLOR_BLACK = true

New in version 2.0.2 (Plugin).

BrickletLCD128x64#set_gui_button(index, position_x, position_y, width, height, text) → nil
Parameters:
  • index -- int
  • position_x -- int
  • position_y -- int
  • width -- int
  • height -- int
  • text -- str

Draws a clickable button at position (x, y) with the given text of up to 16 characters.

You can use up to 12 buttons (index 0-11).

The x position + width has to be within the range of 1 to 128 and the y position + height has to be within the range of 1 to 64.

The minimum useful width/height of a button is 3.

You can enable a callback for a button press with #set_gui_button_pressed_callback_configuration. The callback will be triggered for press and release-events.

The button is drawn in a separate GUI buffer and the button-frame will always stay on top of the graphics drawn with #write_pixels. To remove the button use #remove_gui_button.

If you want an icon instead of text, you can draw the icon inside of the button with #write_pixels.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_button(index) → [bool, int, int, int, int, str]
Parameters:index -- int

Returns the button properties for a given Index as set by #set_gui_button.

Additionally the Active parameter shows if a button is currently active/visible or not.

New in version 2.0.2 (Plugin).

The returned array has the values active, position_x, position_y, width, height and text.

BrickletLCD128x64#remove_gui_button(index) → nil
Parameters:index -- int

Removes the button with the given index.

You can use index 255 to remove all buttons.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_button_pressed(index) → bool
Parameters:index -- int

Returns the state of the button for the given index.

The state can either be pressed (true) or released (false).

New in version 2.0.2 (Plugin).

BrickletLCD128x64#set_gui_slider(index, position_x, position_y, length, direction, value) → nil
Parameters:
  • index -- int
  • position_x -- int
  • position_y -- int
  • length -- int
  • direction -- int
  • value -- int

Draws a slider at position (x, y) with the given length.

You can use up to 6 sliders (index 0-5).

If you use the horizontal direction, the x position + length has to be within the range of 1 to 128 and the y position has to be within the range of 0 to 46.

If you use the vertical direction, the y position + length has to be within the range of 1 to 64 and the x position has to be within the range of 0 to 110.

The minimum length of a slider is 8.

The parameter value is the start-position of the slider, it can be between 0 and length-8.

You can enable a callback for the slider value with #set_gui_slider_value_callback_configuration.

The slider is drawn in a separate GUI buffer and it will always stay on top of the graphics drawn with #write_pixels. To remove the button use #remove_gui_slider.

The following constants are available for this function:

  • BrickletLCD128x64::DIRECTION_HORIZONTAL = 0
  • BrickletLCD128x64::DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_slider(index) → [bool, int, int, int, int, int]
Parameters:index -- int

Returns the slider properties for a given Index as set by #set_gui_slider.

Additionally the Active parameter shows if a button is currently active/visible or not.

The following constants are available for this function:

  • BrickletLCD128x64::DIRECTION_HORIZONTAL = 0
  • BrickletLCD128x64::DIRECTION_VERTICAL = 1

New in version 2.0.2 (Plugin).

The returned array has the values active, position_x, position_y, length, direction and value.

BrickletLCD128x64#remove_gui_slider(index) → nil
Parameters:index -- int

Removes the slider with the given index.

You can use index 255 to remove all slider.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_slider_value(index) → int
Parameters:index -- int

Returns the current slider value for the given index.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#set_gui_tab_configuration(change_tab_config, clear_gui) → nil
Parameters:
  • change_tab_config -- int
  • clear_gui -- bool

Sets the general configuration for tabs. You can configure the tabs to only accept clicks or only swipes (gesture left/right and right/left) or both.

Additionally, if you set Clear GUI to true, all of the GUI elements (buttons, slider, graphs) will automatically be removed on every tab change.

By default click and swipe as well as automatic GUI clear is enabled.

The following constants are available for this function:

  • BrickletLCD128x64::CHANGE_TAB_ON_CLICK = 1
  • BrickletLCD128x64::CHANGE_TAB_ON_SWIPE = 2
  • BrickletLCD128x64::CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_tab_configuration → [int, bool]

Returns the tab configuration as set by #set_gui_tab_configuration.

The following constants are available for this function:

  • BrickletLCD128x64::CHANGE_TAB_ON_CLICK = 1
  • BrickletLCD128x64::CHANGE_TAB_ON_SWIPE = 2
  • BrickletLCD128x64::CHANGE_TAB_ON_CLICK_AND_SWIPE = 3

New in version 2.0.2 (Plugin).

The returned array has the values change_tab_config and clear_gui.

BrickletLCD128x64#set_gui_tab_text(index, text) → nil
Parameters:
  • index -- int
  • text -- str

Adds a text-tab with the given index. The text can have a length of up to 5 characters.

You can use up to 10 tabs (index 0-9).

A text-tab with the same index as a icon-tab will overwrite the icon-tab.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_tab_text(index) → [bool, str]
Parameters:index -- int

Returns the text for a given index as set by #set_gui_tab_text.

Additionally the Active parameter shows if the tab is currently active/visible or not.

New in version 2.0.2 (Plugin).

The returned array has the values active and text.

BrickletLCD128x64#set_gui_tab_icon(index, icon) → nil
Parameters:
  • index -- int
  • icon -- [bool, bool, ..165x.., bool]

Adds a icon-tab with the given index. The icon can have a width of 28 pixels with a height of 6 pixels. It is drawn line-by-line from left to right.

You can use up to 10 tabs (index 0-9).

A icon-tab with the same index as a text-tab will overwrite the text-tab.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_tab_icon(index) → [bool, [bool, bool, ..165x.., bool]]
Parameters:index -- int

Returns the icon for a given index as set by #set_gui_tab_icon.

Additionally the Active parameter shows if the tab is currently active/visible or not.

New in version 2.0.2 (Plugin).

The returned array has the values active and icon.

BrickletLCD128x64#remove_gui_tab(index) → nil
Parameters:index -- int

Removes the tab with the given index.

You can use index 255 to remove all tabs.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#set_gui_tab_selected(index) → nil
Parameters:index -- int

Sets the tab with the given index as selected (drawn as selected on the display).

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_tab_selected → int

Returns the index of the currently selected tab.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#set_gui_graph_configuration(index, graph_type, position_x, position_y, width, height, text_x, text_y) → nil
Parameters:
  • index -- int
  • graph_type -- int
  • position_x -- int
  • position_y -- int
  • width -- int
  • height -- int
  • text_x -- str
  • text_y -- str

Sets the configuration for up to four graphs (index 0-3).

The graph type can be dot-, line- or bar-graph.

The x and y position are pixel positions. They have to be within the range of (0, 0) to (127, 63). The maximum width is 118 and the maximum height is 63.

You can add a text for the x and y axis with at most 4 characters each. The text is drawn at the inside of the graph and it can overwrite some of the graph data. If you need the text outside of the graph you can leave this text here empty and use #draw_text to draw the caption outside of the graph.

The data of the graph can be set and updated with #set_gui_graph_data.

The graph is drawn in a separate GUI buffer and the graph-frame and data will always stay on top of the graphics drawn with #write_pixels. To remove the graph use #remove_gui_graph.

The following constants are available for this function:

  • BrickletLCD128x64::GRAPH_TYPE_DOT = 0
  • BrickletLCD128x64::GRAPH_TYPE_LINE = 1
  • BrickletLCD128x64::GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_graph_configuration(index) → [bool, int, int, int, int, int, str, str]
Parameters:index -- int

Returns the graph properties for a given Index as set by #set_gui_graph_configuration.

Additionally the Active parameter shows if a graph is currently active/visible or not.

The following constants are available for this function:

  • BrickletLCD128x64::GRAPH_TYPE_DOT = 0
  • BrickletLCD128x64::GRAPH_TYPE_LINE = 1
  • BrickletLCD128x64::GRAPH_TYPE_BAR = 2

New in version 2.0.2 (Plugin).

The returned array has the values active, graph_type, position_x, position_y, width, height, text_x and text_y.

BrickletLCD128x64#set_gui_graph_data(index, data) → nil
Parameters:
  • index -- int
  • data -- [int, int, ...]

Sets the data for a graph with the given index. You have to configure the graph with #set_gui_graph_configuration before you can set the first data.

The graph will show the first n values of the data that you set, where n is the width set with #set_gui_graph_configuration. If you set less then n values it will show the rest of the values as zero.

The maximum number of data-points you can set is 118 (which also corresponds to the maximum width of the graph).

You have to scale your values to be between 0 and 255. 0 will be shown at the bottom of the graph and 255 at the top.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_graph_data(index) → [int, int, ...]
Parameters:index -- int

Returns the graph data for a given index as set by #set_gui_graph_data.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#remove_gui_graph(index) → nil
Parameters:index -- int

Removes the graph with the given index.

You can use index 255 to remove all graphs.

New in version 2.0.2 (Plugin).

BrickletLCD128x64#remove_all_gui → nil

Removes all GUI elements (buttons, slider, graphs, tabs).

New in version 2.0.2 (Plugin).

Advanced Functions

BrickletLCD128x64#set_display_configuration(contrast, backlight, invert, automatic_draw) → nil
Parameters:
  • contrast -- int
  • backlight -- int
  • invert -- bool
  • automatic_draw -- bool

Sets the configuration of the display.

You can set a contrast value from 0 to 63, a backlight intensity value from 0 to 100 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 and #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.

The default values are contrast 14, backlight intensity 100, inverting off and automatic draw on.

BrickletLCD128x64#get_display_configuration → [int, int, bool, bool]

Returns the configuration as set by #set_display_configuration.

The returned array has the values contrast, backlight, invert and automatic_draw.

BrickletLCD128x64#set_touch_led_config(config) → nil
Parameters:config -- int

Sets the touch LED configuration. By default the LED is on if the LCD is touched.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

  • BrickletLCD128x64::TOUCH_LED_CONFIG_OFF = 0
  • BrickletLCD128x64::TOUCH_LED_CONFIG_ON = 1
  • BrickletLCD128x64::TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64::TOUCH_LED_CONFIG_SHOW_TOUCH = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_touch_led_config → int

Returns the configuration as set by #set_touch_led_config

The following constants are available for this function:

  • BrickletLCD128x64::TOUCH_LED_CONFIG_OFF = 0
  • BrickletLCD128x64::TOUCH_LED_CONFIG_ON = 1
  • BrickletLCD128x64::TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64::TOUCH_LED_CONFIG_SHOW_TOUCH = 3

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_api_version → [int, int, int]

Returns the version of the API definition (major, minor, revision) 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.

BrickletLCD128x64#get_response_expected(function_id) → bool
Parameters:function_id -- int

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 send and errors are silently ignored, because they cannot be detected.

See #set_response_expected for the list of function ID constants available for this function.

BrickletLCD128x64#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id -- int
  • response_expected -- 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletLCD128x64::FUNCTION_WRITE_PIXELS = 1
  • BrickletLCD128x64::FUNCTION_CLEAR_DISPLAY = 3
  • BrickletLCD128x64::FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletLCD128x64::FUNCTION_WRITE_LINE = 6
  • BrickletLCD128x64::FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BrickletLCD128x64::FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION = 9
  • BrickletLCD128x64::FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION = 13
  • BrickletLCD128x64::FUNCTION_DRAW_LINE = 16
  • BrickletLCD128x64::FUNCTION_DRAW_BOX = 17
  • BrickletLCD128x64::FUNCTION_DRAW_TEXT = 18
  • BrickletLCD128x64::FUNCTION_SET_GUI_BUTTON = 19
  • BrickletLCD128x64::FUNCTION_REMOVE_GUI_BUTTON = 21
  • BrickletLCD128x64::FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION = 22
  • BrickletLCD128x64::FUNCTION_SET_GUI_SLIDER = 26
  • BrickletLCD128x64::FUNCTION_REMOVE_GUI_SLIDER = 28
  • BrickletLCD128x64::FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION = 29
  • BrickletLCD128x64::FUNCTION_SET_GUI_TAB_CONFIGURATION = 33
  • BrickletLCD128x64::FUNCTION_SET_GUI_TAB_TEXT = 35
  • BrickletLCD128x64::FUNCTION_SET_GUI_TAB_ICON = 37
  • BrickletLCD128x64::FUNCTION_REMOVE_GUI_TAB = 39
  • BrickletLCD128x64::FUNCTION_SET_GUI_TAB_SELECTED = 40
  • BrickletLCD128x64::FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION = 41
  • BrickletLCD128x64::FUNCTION_SET_GUI_GRAPH_CONFIGURATION = 45
  • BrickletLCD128x64::FUNCTION_SET_GUI_GRAPH_DATA = 47
  • BrickletLCD128x64::FUNCTION_REMOVE_GUI_GRAPH = 49
  • BrickletLCD128x64::FUNCTION_REMOVE_ALL_GUI = 50
  • BrickletLCD128x64::FUNCTION_SET_TOUCH_LED_CONFIG = 51
  • BrickletLCD128x64::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLCD128x64::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLCD128x64::FUNCTION_RESET = 243
  • BrickletLCD128x64::FUNCTION_WRITE_UID = 248
BrickletLCD128x64#set_response_expected_all(response_expected) → nil
Parameters:response_expected -- bool

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

BrickletLCD128x64#get_spitfp_error_count → [int, int, int, int]

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.

The returned array has the values error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

BrickletLCD128x64#set_bootloader_mode(mode) → int
Parameters:mode -- int

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:

  • BrickletLCD128x64::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLCD128x64::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLCD128x64::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLCD128x64::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLCD128x64::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletLCD128x64::BOOTLOADER_STATUS_OK = 0
  • BrickletLCD128x64::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletLCD128x64::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletLCD128x64::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletLCD128x64::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletLCD128x64::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletLCD128x64#get_bootloader_mode → int

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

  • BrickletLCD128x64::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLCD128x64::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLCD128x64::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLCD128x64::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLCD128x64::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletLCD128x64#set_write_firmware_pointer(pointer) → nil
Parameters:pointer -- int

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.

BrickletLCD128x64#write_firmware(data) → int
Parameters:data -- [int, int, ..61x.., int]

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.

BrickletLCD128x64#set_status_led_config(config) → nil
Parameters:config -- int

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:

  • BrickletLCD128x64::STATUS_LED_CONFIG_OFF = 0
  • BrickletLCD128x64::STATUS_LED_CONFIG_ON = 1
  • BrickletLCD128x64::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletLCD128x64#get_status_led_config → int

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

  • BrickletLCD128x64::STATUS_LED_CONFIG_OFF = 0
  • BrickletLCD128x64::STATUS_LED_CONFIG_ON = 1
  • BrickletLCD128x64::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLCD128x64::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletLCD128x64#get_chip_temperature → int

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.

BrickletLCD128x64#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!

BrickletLCD128x64#write_uid(uid) → nil
Parameters:uid -- int

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.

BrickletLCD128x64#read_uid → int

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

BrickletLCD128x64#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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. There is also a constant for the device identifier of this Bricklet.

The returned array has the values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletLCD128x64#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:callback_id -- int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletLCD128x64#set_touch_position_callback_configuration(period, value_has_to_change) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool

The period in ms is the period with which the ::CALLBACK_TOUCH_POSITION callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

BrickletLCD128x64#get_touch_position_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_touch_position_callback_configuration.

The returned array has the values period and value_has_to_change.

BrickletLCD128x64#set_touch_gesture_callback_configuration(period, value_has_to_change) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool

The period in ms is the period with which the ::CALLBACK_TOUCH_GESTURE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

BrickletLCD128x64#get_touch_gesture_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_touch_gesture_callback_configuration.

The returned array has the values period and value_has_to_change.

BrickletLCD128x64#set_gui_button_pressed_callback_configuration(period, value_has_to_change) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool

The period in ms is the period with which the ::CALLBACK_GUI_BUTTON_PRESSED callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_button_pressed_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_gui_button_pressed_callback_configuration.

New in version 2.0.2 (Plugin).

The returned array has the values period and value_has_to_change.

BrickletLCD128x64#set_gui_slider_value_callback_configuration(period, value_has_to_change) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool

The period in ms is the period with which the ::CALLBACK_GUI_SLIDER_VALUE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_slider_value_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_gui_slider_value_callback_configuration.

New in version 2.0.2 (Plugin).

The returned array has the values period and value_has_to_change.

BrickletLCD128x64#set_gui_tab_selected_callback_configuration(period, value_has_to_change) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool

The period in ms is the period with which the ::CALLBACK_GUI_TAB_SELECTED callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

New in version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_tab_selected_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_gui_tab_selected_callback_configuration.

New in version 2.0.2 (Plugin).

The returned array has the values period and value_has_to_change.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

lcd_128x64.register_callback BrickletLCD128x64::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

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.

BrickletLCD128x64::CALLBACK_TOUCH_POSITION
Parameters:
  • pressure -- int
  • x -- int
  • y -- int
  • age -- int

This callback is triggered periodically with the period that is set by #set_touch_position_callback_configuration. The parameters are the same as for #get_touch_position.

BrickletLCD128x64::CALLBACK_TOUCH_GESTURE
Parameters:
  • gesture -- int
  • duration -- int
  • pressure_max -- int
  • x_start -- int
  • y_start -- int
  • x_end -- int
  • y_end -- int
  • age -- int

This callback is triggered periodically with the period that is set by #set_touch_gesture_callback_configuration. The parameters are the same as for #get_touch_gesture.

The following constants are available for this function:

  • BrickletLCD128x64::GESTURE_LEFT_TO_RIGHT = 0
  • BrickletLCD128x64::GESTURE_RIGHT_TO_LEFT = 1
  • BrickletLCD128x64::GESTURE_TOP_TO_BOTTOM = 2
  • BrickletLCD128x64::GESTURE_BOTTOM_TO_TOP = 3
BrickletLCD128x64::CALLBACK_GUI_BUTTON_PRESSED
Parameters:
  • index -- int
  • pressed -- bool

This callback is triggered periodically with the period that is set by #set_gui_button_pressed_callback_configuration. The parameters are the same as for #get_gui_button_pressed.

New in version 2.0.2 (Plugin).

BrickletLCD128x64::CALLBACK_GUI_SLIDER_VALUE
Parameters:
  • index -- int
  • value -- int

This callback is triggered periodically with the period that is set by #set_gui_slider_value_callback_configuration. The parameters are the same as for #get_gui_slider_value.

New in version 2.0.2 (Plugin).

BrickletLCD128x64::CALLBACK_GUI_TAB_SELECTED
Parameters:index -- int

This callback is triggered periodically with the period that is set by #set_gui_tab_selected_callback_configuration. The parameters are the same as for #get_gui_tab_selected.

New in version 2.0.2 (Plugin).

Constants

BrickletLCD128x64::DEVICE_IDENTIFIER

This constant is used to identify a LCD 128x64 Bricklet.

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

BrickletLCD128x64::DEVICE_DISPLAY_NAME

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