Ruby - LCD 128x64 Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das LCD 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 128x64 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist 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
53
54
55
56
57
58
59
60
61
#!/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|
  if gesture == BrickletLCD128x64::GESTURE_LEFT_TO_RIGHT
    puts "Gesture: Left To Right"
  elsif gesture == BrickletLCD128x64::GESTURE_RIGHT_TO_LEFT
    puts "Gesture: Right To Left"
  elsif gesture == BrickletLCD128x64::GESTURE_TOP_TO_BOTTOM
    puts "Gesture: Top To Bottom"
  elsif gesture == BrickletLCD128x64::GESTURE_BOTTOM_TO_TOP
    puts "Gesture: Bottom To Top"
  end

  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

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

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

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

lcd_128x64 = BrickletLCD128x64.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

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

Schreibt Pixel in das angegebene Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel in einen internen Buffer geschrieben der dann durch einen Aufruf von #draw_buffered_frame auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die #set_display_configuration Funktion eingestellt werden.

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

Liest Pixel aus dem angegebenen Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. Die Pixel werden zeilenweise von oben nach unten und die Zeilen werden jeweils von links nach rechts gelesen.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt vom Display gelesen.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel aus einen internen Buffer gelesen (siehe #draw_buffered_frame).

Automatic Draw kann über die #set_display_configuration Funktion eingestellt werden.

BrickletLCD128x64#clear_display → nil

Löscht den kompletten aktuellen Inhalt des Displays.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt gelöscht.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel im internen Buffer gelöscht der dann durch einen Aufruf von #draw_buffered_frame auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die #set_display_configuration Funktion eingestellt werden.

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

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 21). Der Text kann maximal 22 Zeichen lang sein.

Beispiel: (1, 10, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Wenn Automatic Draw aktiviert ist (Standard), dann wird der Text direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann wird der Text in einen internen Buffer geschrieben der dann durch einen Aufruf von #draw_buffered_frame auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die #set_display_configuration Funktion eingestellt werden.

Diese Funktion ist ein 1:1-Ersatz für die Funktion mit dem gleichen Namen im LCD 20x4 Bricklet. Mit der Funktion #draw_text kann Text Pixelgenau und mit unterschiedlichen Font-Größen gezeichnet werden.

BrickletLCD128x64#draw_buffered_frame(force_complete_redraw) → nil
Parameter:force_complete_redraw -- bool

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von #write_pixels und #write_line direkt auf den Display. Wenn jedoch Automatic Draw deaktiviert ist (#set_display_configuration), dann werden Änderungen in einen internen Buffer anstatt auf den Display geschrieben. Der internen Buffer kann dann durch einen Aufruf dieser Funktion auf den Display geschrieben werden. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Wenn Force Complete Redraw auf true gesetzt ist, dann wird der gesamte Display aktualisiert, anstatt nur die Pixel die sich wirklich verändert haben. Normalerweise sollte dies nicht notwendig sein, außer bei hängenden Pixeln bedingt durch Fehler.

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

Gibt die letzte gültige Touch-Position zurück:

  • Pressure: Anpressdruck des Touches (0-300)
  • X: Touch-Position auf der X-Achse (0-127)
  • Y: Touch-Position auf der Y-Achse (0-63)
  • Age: Alter des Touches in ms (wie lange ist die Erkennung des Touches her)

Das zurückgegebene Array enthält die Werte pressure, x, y und age.

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

Gibt eine der vier Touch-Gesten zurück, die das Bricklet automatisch erkennen kann.

Die Gesten umfassen Wischen von links nach rechts, rechts nach links, oben nach unten und unten nach oben.

Zusätzlich zu Geste wird der Vektor von Start- nach Endposition des Wischens angegeben. Dieser kann genutzt werden um die genaue Position der Geste zu ermitteln (z.B. ob ein Wischen von oben nach unten auf der linken oder rechten des Bildschirms erkannt wurde).

Das Age Parameter gibt das Alter der Geste in ms an (wie lange ist die Erkennung der Geste her).

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Das zurückgegebene Array enthält die Werte gesture, duration, pressure_max, x_start, y_start, x_end, y_end und age.

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

Zeichnet eine weiße oder schwarze Linie von (x, y)-start nach (x, y)-end. Der Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Neu in Version 2.0.2 (Plugin).

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

Zeichnet ein weißes oder schwarzes Rechteck von (x, y)-start nach (x, y)-end. Der Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

Wenn fill auf true gesetzt wird, wird das Rechteck mit der angegebenen Farbe ausgefüllt. Ansonsten wird nur der Umriss gezeichnet.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Neu in Version 2.0.2 (Plugin).

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

Zeichnet einen Text mit bis zu 22 Buchstaben an die Pixelposition (x, y).

Die Wertebereich für die x-Werte ist 0 bis 127 und der Wertebereich für die y-Werte ist 0-63.

Es können 9 unterschiedliche Font-Größen genutzt werden und der Text kann in weiß oder schwarz gezeichnet werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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

Neu in Version 2.0.2 (Plugin).

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

Zeichnet einen klickbaren Button an Position (x, y) mit dem gegebenem Text von bis zu 16 Zeichen.

Es können bis zu 12 Buttons genutzt werden (Index 0-11).

Die x-Position + Width muss im Wertebereich von 1 bis 128 liegen und die y-Position+Height muss im Wertebereich von 1 bis 64 liegen.

Die minimale nützliche Breite/Höhe eines Buttons ist 3.

Der Callback für Button-Events kann mit der Funktion #set_gui_button_pressed_callback_configuration eingestellt werden. Der Callback wird sowohl für gedrückt als auch losgelassen Events ausgelöst.

Der Button wird in einem separaten GUI-Buffer gezeichnet und der Rahmen des Buttons wird immer über den Grafiken bleiben die mit #write_pixels gezeichnet werden. Um einen Button zu entfernen kann die Funktion #remove_gui_button genutzt werden.

Wenn anstatt des Textes ein Icon verwendet werden soll, kann dieses innerhalb des Buttons mit per #write_pixels gezeichnet werden.

Neu in Version 2.0.2 (Plugin).

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

Gibt die Button-Eigenschaften für den gegebenen Index zurück, wie von #set_gui_button gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte active, position_x, position_y, width, height und text.

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

Entfernt den Button mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Buttons zu entfernen.

Neu in Version 2.0.2 (Plugin).

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

Gibt den aktuellen Button-Zustand für einen gegebenen Index zurück.

Der Zustand kann entweder gedrückt (true) oder losgelassen (false) sein.

Neu in Version 2.0.2 (Plugin).

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

Zeichnet einen Slider an Position (x, y) mit der gegebenen Länge.

Es können bis zu 8 Slider genutzt werden (Index 0-7).

Wenn eine horizontale Richtung verwendet wird muss Die x-Position + Länge im Wertebereich von 1 bis 128 und die y-Position im Wertebereich von 0 bis 46 liegen.

Wenn eine vertikale Richtung verwendet wird muss Die y-Position + Länge im Wertebereich von 1 bis 64 und die x-Position im Wertebereich von 0 bis 110 liegen.

Die minimale Länge des Sliders ist 8.

Das Parameter value ist die Startposition des Sliders. Diese kann zwischen 0 und length-8 liegen.

Der Callback für Slider-Events kann mit der Funktion #set_gui_slider_value_callback_configuration eingestellt werden.

Der Slider wird in einem separaten GUI-Buffer gezeichnet und der Rahmen des Buttons wrd immer über den Grafiken bleiben die mit #write_pixels gezeichnet werden. Um einen Button zu entfernen kann die Funktion #remove_gui_slider genutzt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Neu in Version 2.0.2 (Plugin).

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

Gibt die Slider-Eigenschaften für den gegebenen Index zurück, wie von #set_gui_slider gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte active, position_x, position_y, length, direction und value.

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

Entfernt den Slider mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Slider zu entfernen.

Neu in Version 2.0.2 (Plugin).

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

Gibt den aktuellen Wert des Slider mit dem gegebenen Index zurück.

Neu in Version 2.0.2 (Plugin).

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

Setzt die generelle Konfiguration für Tabs. Tabs können auf klicken, wischen (links/rechts und rechts/links) oder beides reagieren.

Zusätzlich kann Clear GUI auf true gesetzt werden. In diesem Fall werden bei einem wechsel der Tabs automatisch alle GUI Elemente (Buttons, Slider, Graphen) gelöscht.

Standardmäßig ist klicken und wischen sowie das automatische löschen der GUI aktiviert.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_tab_configuration → [int, bool]

Gibt die Tab-Konfiguration zurück, wie von #set_gui_tab_configuration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte change_tab_config und clear_gui.

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

Fügt einen Text-Tab mit dem gegebenen Index hinzu. Der Text kann eine Länge von bis zu 5 Buchstaben haben.

Es können bis zu 10 Tabs verwendet werden (Index 0-9).

Ein Text-Tab mit dem gleichen Index wie ein Icon-Tab überschreibt diesen.

Neu in Version 2.0.2 (Plugin).

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

Gibt den Text für den gegebenen Index zurück, wie von #set_gui_tab_text gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Tab aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte active und text.

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

Fügt einen Icon-Tab mit dem gegebenen Index hinzu. Das Icon kann eine Breite von 28 Pixel bei einer Höhe von 6 Pixel haben. Es wird Zeile für Zeile von links nach rechts gezeichnet.

Es können bis zu 10 Tabs verwendet werden (Index 0-9).

Ein Icon-Tab mit dem gleichen Index wie ein Text-Tab überschreibt diesen.

Neu in Version 2.0.2 (Plugin).

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

Gibt das Icon für den gegebenen Index zurück, wie von #set_gui_tab_icon gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Tab aktuell aktiv/sichtbar ist oder nicht.

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte active und icon.

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

Entfernt den Tab mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Tabs zu entfernen.

Neu in Version 2.0.2 (Plugin).

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

Setzt den Tab mit dem gegebenen Index als "selected" (wird auf dem Display als ausgewählt gezeichnet)

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_tab_selected → int

Gibt den Index des aktuell ausgewählten Tabs zurück. Wenn es keine Tabs gibt, wird -1 als Index zurückgegeben.

Neu 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
Parameter:
  • index -- int
  • graph_type -- int
  • position_x -- int
  • position_y -- int
  • width -- int
  • height -- int
  • text_x -- str
  • text_y -- str

Setzt die Konfiguration für bis zu vier Graphen (Index 0-3).

Der Graph kann vom Typ Dot-, Line- oder Bar-Graph sein.

Die x- und y-Positionen sind Pixel-Positionen. Diese sind im Wertebereich von (0, 0) bis (127, 63). Die Maximale Breite (width) ist 118 und die maximale Höhe (height) ist 63.

Es können bis zu 4 Buchstaben Text zur Beschreibung der x- und y-Achse genutzt werden. Der Text wird auf die Innenseite des Graphen gezeichnet und er kann Datenpunkte des Graphen überschreiben. Wenn der Text außerhalb des Graphen benötigt wird kann die Beschriftung hier leer gelassen werden. Der Text kann im Nachhinein mit #draw_text hinzugefügt werden.

Die Datenpunkte des Graphen können mit der Funktion #set_gui_graph_data gesetzt und aktualisiert werden.

Der Graph wird in einem separaten GUI-Buffer gezeichnet und der Rahmen sowie die Datenpunkte des Graphen werden immer über den Grafiken bleiben die mit #write_pixels gezeichnet werden. Um einen Graphen zu entfernen kann die Funktion #remove_gui_graph genutzt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Neu in Version 2.0.2 (Plugin).

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

Gibt die Graph-Eigenschaften für den gegebenen Index zurück, wie von #set_gui_graph_configuration gesetzt.

Zusätzlich gibt der Active-Parameter an ob der Button aktuell aktiv/sichtbar ist oder nicht.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte active, graph_type, position_x, position_y, width, height, text_x und text_y.

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

Setzt die Datenpukte für den Graph mit dem gegebenen Index. Der Graph muss mit #set_gui_graph_configuration konfiguriert werden bevor die ersten Daten gesetzt werden können.

Der Graph zeigt die ersten n Werte der gesetzten Daten an, wobei n die Breite (width) ist die mit #set_gui_graph_configuration gesetzt wurde. Wenn weniger als n Werte gesetzt werden, werden die restlichen Datenpunkte als 0 angezeigt.

Die maximale Anzahl an Datenpunkte die gesetzt werden kann ist 118 (dies entspricht auch der maximalen Breite des Graphen).

Die gesetzten Werte müssen zwischen 0 und 255 skaliert werden. 0 wird unten und 255 wird oben im Graph gezeichnet.

Neu in Version 2.0.2 (Plugin).

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

Gibt die Datenpunkte des Graphen mit dem gegebenen Index zurück, wie von #set_gui_graph_data gesetzt.

Neu in Version 2.0.2 (Plugin).

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

Entfernt den Graph mit dem gegebenen Index.

Index 255 kann genutzt werden um alle Graphen zu entfernen.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64#remove_all_gui → nil

Entfernt alle GUI-Elemente (Buttons, Slider, Graphen, Tabs).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

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

Setzt die Konfiguration des Displays.

Der Kontrast kann zwischen 0 und 63, die Backlight-Intensität zwischen 0 und 100 und das Farbschema invertiert (weiß/schwarz) eingestellt werden.

Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem Aufruf von #write_pixels und #write_line aktualisiert. Wenn Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen internen Buffer geschrieben, der dann bei bei einem Aufruf von #draw_buffered_frame auf dem Display angezeigt wird.

Standardwerte: Kontrast 14, Backlight-Intensität 100, Invertierung aus und Automatic Draw aktiviert.

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

Gibt die Konfiguration zurück, wie von #set_display_configuration gesetzt.

Das zurückgegebene Array enthält die Werte contrast, backlight, invert und automatic_draw.

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

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig ist die LED an wenn das LCD berührt wird.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64#get_touch_led_config → int

Gibt die Konfiguration zurück, wie von #set_touch_led_config gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64#get_api_version → [int, int, int]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

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

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels #set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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
Parameter:response_expected -- bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

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

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Das zurückgegebene Array enthält die Werte error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

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

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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
Parameter:pointer -- int

Setzt den Firmware-Pointer für #write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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

Gibt die Konfiguration zurück, wie von #set_status_led_config gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletLCD128x64#reset → nil

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

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

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletLCD128x64#read_uid → int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene Array enthält die Werte uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

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

Registriert den block für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

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

Die Periode in ms ist die Periode mit der der ::CALLBACK_TOUCH_POSITION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

BrickletLCD128x64#get_touch_position_callback_configuration → [int, bool]

Gibt die Callback-Konfiguration zurück, wie mittels #set_touch_position_callback_configuration gesetzt.

Das zurückgegebene Array enthält die Werte period und value_has_to_change.

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

Die Periode in ms ist die Periode mit der der ::CALLBACK_TOUCH_GESTURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

BrickletLCD128x64#get_touch_gesture_callback_configuration → [int, bool]

Gibt die Callback-Konfiguration zurück, wie mittels #set_touch_gesture_callback_configuration gesetzt.

Das zurückgegebene Array enthält die Werte period und value_has_to_change.

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

Die Periode in ms ist die Periode mit der der ::CALLBACK_GUI_BUTTON_PRESSED Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_button_pressed_callback_configuration → [int, bool]

Gibt die Callback-Konfiguration zurück, wie mittels #set_gui_button_pressed_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte period und value_has_to_change.

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

Die Periode in ms ist die Periode mit der der ::CALLBACK_GUI_SLIDER_VALUE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_slider_value_callback_configuration → [int, bool]

Gibt die Callback-Konfiguration zurück, wie mittels #set_gui_slider_value_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte period und value_has_to_change.

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

Die Periode in ms ist die Periode mit der der ::CALLBACK_GUI_TAB_SELECTED Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64#get_gui_tab_selected_callback_configuration → [int, bool]

Gibt die Callback-Konfiguration zurück, wie mittels #set_gui_tab_selected_callback_configuration gesetzt.

Neu in Version 2.0.2 (Plugin).

Das zurückgegebene Array enthält die Werte period und value_has_to_change.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

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

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

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

Dieser Callback wird mit der Periode, wie gesetzt mit #set_touch_position_callback_configuration, ausgelöst. Die Parameter sind die gleichen wie die von #get_touch_position.

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

Dieser Callback wird mit der Periode, wie gesetzt mit #set_touch_gesture_callback_configuration, ausgelöst. Die Parameter sind die gleichen wie die von #get_touch_gesture.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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
Parameter:
  • index -- int
  • pressed -- bool

Dieser Callback wird mit der Periode, wie gesetzt mit #set_gui_button_pressed_callback_configuration, ausgelöst. Die Parameter sind die gleichen wie die von #get_gui_button_pressed.

Neu in Version 2.0.2 (Plugin).

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

Dieser Callback wird mit der Periode, wie gesetzt mit #set_gui_slider_value_callback_configuration, ausgelöst. Die Parameter sind die gleichen wie die von #get_gui_slider_value.

Neu in Version 2.0.2 (Plugin).

BrickletLCD128x64::CALLBACK_GUI_TAB_SELECTED
Parameter:index -- int

Dieser Callback wird mit der Periode, wie gesetzt mit #set_gui_tab_selected_callback_configuration, ausgelöst. Die Parameter sind die gleichen wie die von #get_gui_tab_selected.

Neu in Version 2.0.2 (Plugin).

Konstanten

BrickletLCD128x64::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein LCD 128x64 Bricklet zu identifizieren.

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletLCD128x64::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LCD 128x64 Bricklet dar.