Ruby - LCD 20x4 Bricklet¶

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_20x4'

include Tinkerforge

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

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

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

# Turn backlight on
lcd.backlight_on

# Write "Hello World"
lcd.write_line 0, 0, 'Hello World'

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

Button Callback¶

Download (example_button_callback.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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_lcd_20x4'

include Tinkerforge

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

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

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

# Register button pressed callback
lcd.register_callback(BrickletLCD20x4::CALLBACK_BUTTON_PRESSED) do |button|
  puts "Button Pressed: #{button}"
end

# Register button released callback
lcd.register_callback(BrickletLCD20x4::CALLBACK_BUTTON_RELEASED) do |button|
  puts "Button Released: #{button}"
end

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

Unicode¶

Download (example_unicode.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
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_lcd_20x4'

include Tinkerforge

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

def unicode_to_ks0066u(string)
  ks0066u = ''

  string.each_codepoint do |codepoint|
    # ASCII subset from JIS X 0201
    if codepoint >= 0x0020 and codepoint <= 0x007e
      # The LCD charset doesn't include '\' and '~', use similar characters instead
      mapping = {
        0x005c => 0xa4.chr, # REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
        0x007e => 0x2d.chr  # TILDE maps to HYPHEN-MINUS
      }

      if mapping.has_key? codepoint
        c = mapping[codepoint]
      else
        c = codepoint.chr
      end
    # Katakana subset from JIS X 0201
    elsif codepoint >= 0xff61 and codepoint <= 0xff9f
      c = (codepoint - 0xfec0).chr
    # Special characters
    else
      mapping = {
        0x00a5 => 0x5c.chr, # YEN SIGN
        0x2192 => 0x7e.chr, # RIGHTWARDS ARROW
        0x2190 => 0x7f.chr, # LEFTWARDS ARROW
        0x00b0 => 0xdf.chr, # DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
        0x03b1 => 0xe0.chr, # GREEK SMALL LETTER ALPHA
        0x00c4 => 0xe1.chr, # LATIN CAPITAL LETTER A WITH DIAERESIS
        0x00e4 => 0xe1.chr, # LATIN SMALL LETTER A WITH DIAERESIS
        0x00df => 0xe2.chr, # LATIN SMALL LETTER SHARP S
        0x03b5 => 0xe3.chr, # GREEK SMALL LETTER EPSILON
        0x00b5 => 0xe4.chr, # MICRO SIGN
        0x03bc => 0xe4.chr, # GREEK SMALL LETTER MU
        0x03c2 => 0xe5.chr, # GREEK SMALL LETTER FINAL SIGMA
        0x03c1 => 0xe6.chr, # GREEK SMALL LETTER RHO
        0x221a => 0xe8.chr, # SQUARE ROOT
        0x00b9 => 0xe9.chr, # SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
        0x00a4 => 0xeb.chr, # CURRENCY SIGN
        0x00a2 => 0xec.chr, # CENT SIGN
        0x2c60 => 0xed.chr, # LATIN CAPITAL LETTER L WITH DOUBLE BAR
        0x00f1 => 0xee.chr, # LATIN SMALL LETTER N WITH TILDE
        0x00d6 => 0xef.chr, # LATIN CAPITAL LETTER O WITH DIAERESIS
        0x00f6 => 0xef.chr, # LATIN SMALL LETTER O WITH DIAERESIS
        0x03f4 => 0xf2.chr, # GREEK CAPITAL THETA SYMBOL
        0x221e => 0xf3.chr, # INFINITY
        0x03a9 => 0xf4.chr, # GREEK CAPITAL LETTER OMEGA
        0x00dc => 0xf5.chr, # LATIN CAPITAL LETTER U WITH DIAERESIS
        0x00fc => 0xf5.chr, # LATIN SMALL LETTER U WITH DIAERESIS
        0x03a3 => 0xf6.chr, # GREEK CAPITAL LETTER SIGMA
        0x03c0 => 0xf7.chr, # GREEK SMALL LETTER PI
        0x0304 => 0xf8.chr, # COMBINING MACRON
        0x00f7 => 0xfd.chr, # DIVISION SIGN
        0x25a0 => 0xff.chr  # BLACK SQUARE
      }

      if mapping.has_key? codepoint
        c = mapping[codepoint]
      else
        c = 0xff.chr # BLACK SQUARE
      end
    end

    # Special handling for 'x' followed by COMBINING MACRON
    if c == 0xf8.chr
      if ks0066u.length == 0 or not ks0066u[-1, 1] == 0x78.chr
        c = 0xff.chr # BLACK SQUARE
      end

      if ks0066u.length > 0
        ks0066u = ks0066u[0..-2]
      end
    end

    ks0066u += c
  end

  ks0066u
end

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

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

# Turn backlight on
lcd.backlight_on

# Write a string using the unicode_to_ks0066u function to map to the LCD charset
lcd.write_line 0, 0, unicode_to_ks0066u('Stromstärke: 17µA')
lcd.write_line 1, 0, unicode_to_ks0066u('Temperatur:  23°C')

# Write a string directly including characters from the LCD charset
lcd.write_line 2, 0, "Drehzahl:   750min\xe9"

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

Grundfunktionen¶

BrickletLCD20x4::new(uid, ipcon) → lcd_20x4¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	lcd_20x4 – Typ: BrickletLCD20x4

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

lcd_20x4 = BrickletLCD20x4.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

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

Parameter:	line – Typ: int, Wertebereich: [0 bis 3] position – Typ: int, Wertebereich: [0 bis 19] text – Typ: str, Länge: bis zu 20

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 20 Zeichen lang sein.

Beispiel: (0, 7, "Hallo") schreibt Hallo in die Mitte der ersten Zeile des Display.

Das Display nutzt einen speziellen Zeichensatz der alle ASCII Zeichen beinhaltet außer Backslash und Tilde. Der Zeichensatz des LCD beinhaltet weiterhin einige Nicht-ASCII Zeichen, siehe die Zeichensatzspezifikation für Details. Das gezeigte Unicode Beispiel verdeutlicht die Verwendung von Nicht-ASCII Zeichen und wie die Wandlung von Unicode in den LCD Zeichensatz möglich ist.

BrickletLCD20x4#clear_display → nil¶

Löscht alle Zeichen auf dem Display.

BrickletLCD20x4#backlight_on → nil¶

Aktiviert die Hintergrundbeleuchtung.

BrickletLCD20x4#backlight_off → nil¶

Deaktiviert die Hintergrundbeleuchtung.

BrickletLCD20x4#is_backlight_on → bool¶

Rückgabe:	backlight – Typ: bool

Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.

Fortgeschrittene Funktionen¶

BrickletLCD20x4#set_config(cursor, blinking) → nil¶

Parameter:	cursor – Typ: bool, Standardwert: false blinking – Typ: bool, Standardwert: false

Konfiguriert ob der Cursor (angezeigt als "_") sichtbar ist und ob er blinkt (angezeigt als blinkender Block). Die Cursor Position ist ein Zeichen hinter dem zuletzt mit #write_line geschriebenen Text.

BrickletLCD20x4#get_config → [bool, bool]¶

Rückgabe-Array:	0: cursor – Typ: bool, Standardwert: false 1: blinking – Typ: bool, Standardwert: false

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

BrickletLCD20x4#is_button_pressed(button) → bool¶

Parameter:	button – Typ: int, Wertebereich: [0 bis 3]
Rückgabe:	pressed – Typ: bool

Gibt true zurück wenn die Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2) gedrückt ist.

Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die ::CALLBACK_BUTTON_PRESSED und ::CALLBACK_BUTTON_RELEASED Callbacks zu nutzen.

BrickletLCD20x4#set_custom_character(index, character) → nil¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 7] character – Typ: [int, ...], Länge: 8, Wertebereich: [0 bis 31]

Das LCD 20x4 Bricklet kann bis zu 8 benutzerdefinierte Buchstaben speichern. Die Buchstaben bestehen aus 5x8 Pixel und sie können über den Index 0-7 adressiert werden. Um die Pixel zu beschreiben, werden die ersten 5 Bit von 8 Bytes verwenden. Zum Beispiel, um den Buchstaben "H" zu erzeugen, sollte das folgende Array gesendet werden:

• character[0] = 0b00010001 (Dezimalwert 17)
• character[1] = 0b00010001 (Dezimalwert 17)
• character[2] = 0b00010001 (Dezimalwert 17)
• character[3] = 0b00011111 (Dezimalwert 31)
• character[4] = 0b00010001 (Dezimalwert 17)
• character[5] = 0b00010001 (Dezimalwert 17)
• character[6] = 0b00010001 (Dezimalwert 17)
• character[7] = 0b00000000 (Dezimalwert 0)

Die Buchstaben können später mit #write_line mit den chars mit den Byterepräsentationen 8 ("\x08" oder "\u0008") bis 15 ("\x0F" oder "\u000F") geschrieben werden.

Es ist möglich die benutzerdefinierten Buchstaben im Brick Viewer ab Version 2.0.1 einzustellen.

Benutzerdefinierte Buchstaben werden vom LCD im RAM gespeichert, daher müssen sie nach jedem Start des LCD 20x4 Bricklets gesetzt werden.

Neu in Version 2.0.1 (Plugin).

BrickletLCD20x4#get_custom_character(index) → [int, ...]¶

Parameter:	index – Typ: int, Wertebereich: [0 bis 7]
Rückgabe:	character – Typ: [int, ...], Länge: 8, Wertebereich: [0 bis 31]

Gibt den benutzerdefinierten Buchstaben für den gegebenen Index zurück, wie von #set_custom_character gesetzt.

Neu in Version 2.0.1 (Plugin).

BrickletLCD20x4#set_default_text(line, text) → nil¶

Parameter:	line – Typ: int, Wertebereich: [0 bis 3] text – Typ: str, Länge: bis zu 20

Setzt den Standard-Text für die Zeilen 0-3. Die maximale Anzahl an Buchstaben pro Zeile ist 20.

Der Standard-Text wird auf dem LCD angezeigt, wenn der Standard-Text-Zähler ausläuft, siehe #set_default_text_counter.

Neu in Version 2.0.2 (Plugin).

BrickletLCD20x4#get_default_text(line) → str¶

Parameter:	line – Typ: int, Wertebereich: [0 bis 3]
Rückgabe:	text – Typ: str, Länge: bis zu 20

Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von #set_default_text gesetzt.

Neu in Version 2.0.2 (Plugin).

BrickletLCD20x4#set_default_text_counter(counter) → nil¶

Parameter:	counter – Typ: int, Einheit: 1 ms, Wertebereich: [-231 bis 231 - 1], Standardwert: -1

Setzt den Standard-Text-Zähler. Der Zähler wird von der LCD Firmware einmal pro ms dekrementiert. Wenn der Zähler 0 erreicht wird der Standard-Text auf dem LCD angezeigt (siehe #set_default_text).

Diese Funktionalität kann genutzt werden um auf dem LCD einen Text anzuzeigen falls das kontrollierende Programm abstürzt oder die Verbindung unterbrochen wird.

Ein möglicher Ansatz dafür ist #set_default_text_counter einmal pro Minute mit dem Parameter 1000*60*2 (zwei Minuten) aufzurufen. In diesem Fall wird dann der Standard-Text nach spätestens zwei Minuten angezeigt wenn das kontrollierende Programm abstürzt.

Ein negativer Zählerwert stellt die Standard-Text Funktionalität aus.

Neu in Version 2.0.2 (Plugin).

BrickletLCD20x4#get_default_text_counter → int¶

Rückgabe:	counter – Typ: int, Einheit: 1 ms, Wertebereich: [-231 bis 231 - 1], Standardwert: -1

Gibt den aktuellen Wert des Standard-Text-Zählers zurück.

Neu in Version 2.0.2 (Plugin).

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

Rückgabe-Array:

0: uid – Typ: str, Länge: bis zu 8 1: connected_uid – Typ: str, Länge: bis zu 8 2: position – Typ: chr, Wertebereich: ['a' bis 'h', 'z'] 3: hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 4: firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 5: device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks¶

BrickletLCD20x4#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameter:	callback_id – Typ: int

Registriert den block für die gegebene callback_id.

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

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_20x4.register_callback BrickletLCD20x4::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

BrickletLCD20x4::CALLBACK_BUTTON_PRESSED¶

Callback-Parameter:	button – Typ: int, Wertebereich: [0 bis 3]

Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter ist die Nummer der Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2).

BrickletLCD20x4::CALLBACK_BUTTON_RELEASED¶

Callback-Parameter:	button – Typ: int, Wertebereich: [0 bis 3]

Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter ist die Nummer der Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2).

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

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

Rückgabe-Array:	0: api_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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.

BrickletLCD20x4#get_response_expected(function_id) → bool¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

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:

Für function_id:

• BrickletLCD20x4::FUNCTION_WRITE_LINE = 1
• BrickletLCD20x4::FUNCTION_CLEAR_DISPLAY = 2
• BrickletLCD20x4::FUNCTION_BACKLIGHT_ON = 3
• BrickletLCD20x4::FUNCTION_BACKLIGHT_OFF = 4
• BrickletLCD20x4::FUNCTION_SET_CONFIG = 6
• BrickletLCD20x4::FUNCTION_SET_CUSTOM_CHARACTER = 11
• BrickletLCD20x4::FUNCTION_SET_DEFAULT_TEXT = 13
• BrickletLCD20x4::FUNCTION_SET_DEFAULT_TEXT_COUNTER = 15

BrickletLCD20x4#set_response_expected(function_id, response_expected) → nil¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: 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:

Für function_id:

• BrickletLCD20x4::FUNCTION_WRITE_LINE = 1
• BrickletLCD20x4::FUNCTION_CLEAR_DISPLAY = 2
• BrickletLCD20x4::FUNCTION_BACKLIGHT_ON = 3
• BrickletLCD20x4::FUNCTION_BACKLIGHT_OFF = 4
• BrickletLCD20x4::FUNCTION_SET_CONFIG = 6
• BrickletLCD20x4::FUNCTION_SET_CUSTOM_CHARACTER = 11
• BrickletLCD20x4::FUNCTION_SET_DEFAULT_TEXT = 13
• BrickletLCD20x4::FUNCTION_SET_DEFAULT_TEXT_COUNTER = 15

BrickletLCD20x4#set_response_expected_all(response_expected) → nil¶

Parameter:	response_expected – Typ: bool

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

Konstanten¶

BrickletLCD20x4::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein LCD 20x4 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.

BrickletLCD20x4::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.