Python - LCD 20x4 Bricklet¶

Hello World¶

Download (example_hello_world.py)

 1#!/usr/bin/env python
 2# -*- coding: utf-8 -*-
 3
 4HOST = "localhost"
 5PORT = 4223
 6UID = "XYZ" # Change XYZ to the UID of your LCD 20x4 Bricklet
 7
 8from tinkerforge.ip_connection import IPConnection
 9from tinkerforge.bricklet_lcd_20x4 import BrickletLCD20x4
10
11if __name__ == "__main__":
12    ipcon = IPConnection() # Create IP connection
13    lcd = BrickletLCD20x4(UID, ipcon) # Create device object
14
15    ipcon.connect(HOST, PORT) # Connect to brickd
16    # Don't use device before ipcon is connected
17
18    # Turn backlight on
19    lcd.backlight_on()
20
21    # Write "Hello World"
22    lcd.write_line(0, 0, "Hello World")
23
24    input("Press key to exit\n") # Use raw_input() in Python 2
25    ipcon.disconnect()

Button Callback¶

Download (example_button_callback.py)

 1#!/usr/bin/env python
 2# -*- coding: utf-8 -*-
 3
 4HOST = "localhost"
 5PORT = 4223
 6UID = "XYZ" # Change XYZ to the UID of your LCD 20x4 Bricklet
 7
 8from tinkerforge.ip_connection import IPConnection
 9from tinkerforge.bricklet_lcd_20x4 import BrickletLCD20x4
10
11# Callback function for button pressed callback
12def cb_button_pressed(button):
13    print("Button Pressed: " + str(button))
14
15# Callback function for button released callback
16def cb_button_released(button):
17    print("Button Released: " + str(button))
18
19if __name__ == "__main__":
20    ipcon = IPConnection() # Create IP connection
21    lcd = BrickletLCD20x4(UID, ipcon) # Create device object
22
23    ipcon.connect(HOST, PORT) # Connect to brickd
24    # Don't use device before ipcon is connected
25
26    # Register button pressed callback to function cb_button_pressed
27    lcd.register_callback(lcd.CALLBACK_BUTTON_PRESSED, cb_button_pressed)
28
29    # Register button released callback to function cb_button_released
30    lcd.register_callback(lcd.CALLBACK_BUTTON_RELEASED, cb_button_released)
31
32    input("Press key to exit\n") # Use raw_input() in Python 2
33    ipcon.disconnect()

Unicode¶

Download (example_unicode.py)

  1#!/usr/bin/env python
  2# -*- coding: utf-8 -*-
  3
  4HOST = "localhost"
  5PORT = 4223
  6UID = "XYZ" # Change XYZ to the UID of your LCD 20x4 Bricklet
  7
  8import sys
  9from tinkerforge.ip_connection import IPConnection
 10from tinkerforge.bricklet_lcd_20x4 import BrickletLCD20x4
 11
 12# Maps a Python string to the LCD charset
 13def unicode_to_ks0066u(string):
 14    if sys.hexversion < 0x03000000:
 15        byte = lambda x: chr(x)
 16        ks0066u = ''
 17
 18        if not isinstance(string, unicode): # pylint: disable=undefined-variable
 19            code_points = unicode(string, 'UTF-8') # pylint: disable=undefined-variable
 20        else:
 21            code_points = string
 22    else:
 23        byte = lambda x: bytes([x])
 24        ks0066u = bytes()
 25        code_points = string
 26
 27    for code_point in code_points:
 28        code_point = ord(code_point)
 29
 30        # ASCII subset from JIS X 0201
 31        if code_point >= 0x0020 and code_point <= 0x007e:
 32            # The LCD charset doesn't include '\' and '~', use similar characters instead
 33            mapping = {
 34                0x005c : byte(0xa4), # REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
 35                0x007e : byte(0x2d)  # TILDE maps to HYPHEN-MINUS
 36            }
 37
 38            try:
 39                c = mapping[code_point]
 40            except KeyError:
 41                c = byte(code_point)
 42        # Katakana subset from JIS X 0201
 43        elif code_point >= 0xff61 and code_point <= 0xff9f:
 44            c = byte(code_point - 0xfec0)
 45        # Special characters
 46        else:
 47            mapping = {
 48                0x00a5 : byte(0x5c), # YEN SIGN
 49                0x2192 : byte(0x7e), # RIGHTWARDS ARROW
 50                0x2190 : byte(0x7f), # LEFTWARDS ARROW
 51                0x00b0 : byte(0xdf), # DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
 52                0x03b1 : byte(0xe0), # GREEK SMALL LETTER ALPHA
 53                0x00c4 : byte(0xe1), # LATIN CAPITAL LETTER A WITH DIAERESIS
 54                0x00e4 : byte(0xe1), # LATIN SMALL LETTER A WITH DIAERESIS
 55                0x00df : byte(0xe2), # LATIN SMALL LETTER SHARP S
 56                0x03b5 : byte(0xe3), # GREEK SMALL LETTER EPSILON
 57                0x00b5 : byte(0xe4), # MICRO SIGN
 58                0x03bc : byte(0xe4), # GREEK SMALL LETTER MU
 59                0x03c2 : byte(0xe5), # GREEK SMALL LETTER FINAL SIGMA
 60                0x03c1 : byte(0xe6), # GREEK SMALL LETTER RHO
 61                0x221a : byte(0xe8), # SQUARE ROOT
 62                0x00b9 : byte(0xe9), # SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
 63                0x00a4 : byte(0xeb), # CURRENCY SIGN
 64                0x00a2 : byte(0xec), # CENT SIGN
 65                0x2c60 : byte(0xed), # LATIN CAPITAL LETTER L WITH DOUBLE BAR
 66                0x00f1 : byte(0xee), # LATIN SMALL LETTER N WITH TILDE
 67                0x00d6 : byte(0xef), # LATIN CAPITAL LETTER O WITH DIAERESIS
 68                0x00f6 : byte(0xef), # LATIN SMALL LETTER O WITH DIAERESIS
 69                0x03f4 : byte(0xf2), # GREEK CAPITAL THETA SYMBOL
 70                0x221e : byte(0xf3), # INFINITY
 71                0x03a9 : byte(0xf4), # GREEK CAPITAL LETTER OMEGA
 72                0x00dc : byte(0xf5), # LATIN CAPITAL LETTER U WITH DIAERESIS
 73                0x00fc : byte(0xf5), # LATIN SMALL LETTER U WITH DIAERESIS
 74                0x03a3 : byte(0xf6), # GREEK CAPITAL LETTER SIGMA
 75                0x03c0 : byte(0xf7), # GREEK SMALL LETTER PI
 76                0x0304 : byte(0xf8), # COMBINING MACRON
 77                0x00f7 : byte(0xfd), # DIVISION SIGN
 78                0x25a0 : byte(0xff)  # BLACK SQUARE
 79            }
 80
 81            try:
 82                c = mapping[code_point]
 83            except KeyError:
 84                c = byte(0xff) # BLACK SQUARE
 85
 86        # Special handling for 'x' followed by COMBINING MACRON
 87        if c == byte(0xf8):
 88            if len(ks0066u) == 0 or not ks0066u.endswith(byte(0x78)):
 89                c = byte(0xff) # BLACK SQUARE
 90
 91            if len(ks0066u) > 0:
 92                ks0066u = ks0066u[:-1]
 93
 94        ks0066u += c
 95
 96    return ks0066u
 97
 98if __name__ == "__main__":
 99    ipcon = IPConnection() # Create IP connection
100    lcd = BrickletLCD20x4(UID, ipcon) # Create device object
101
102    ipcon.connect(HOST, PORT) # Connect to brickd
103    # Don't use device before ipcon is connected
104
105    # Turn backlight on
106    lcd.backlight_on()
107
108    # Write some strings using the unicode_to_ks0066u function to map to the LCD charset
109    lcd.write_line(0, 0, unicode_to_ks0066u('Stromstärke: 17µA'))
110    lcd.write_line(1, 0, unicode_to_ks0066u('Temperatur:  23°C'))
111
112    # Write a string directly including characters from the LCD charset
113    lcd.write_line(2, 0, b'Drehzahl:   750min\xe9')
114
115    input("Press key to exit\n") # Use raw_input() in Python 2
116    ipcon.disconnect()

Grundfunktionen¶

BrickletLCD20x4(uid, ipcon)¶

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("YOUR_DEVICE_UID", ipcon)

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

BrickletLCD20x4.write_line(line, position, text)¶

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

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()¶

Rückgabe:	None

Löscht alle Zeichen auf dem Display.

BrickletLCD20x4.backlight_on()¶

Rückgabe:	None

Aktiviert die Hintergrundbeleuchtung.

BrickletLCD20x4.backlight_off()¶

Rückgabe:	None

Deaktiviert die Hintergrundbeleuchtung.

BrickletLCD20x4.is_backlight_on()¶

Rückgabe:	backlight – Typ: bool

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

Fortgeschrittene Funktionen¶

BrickletLCD20x4.set_config(cursor, blinking)¶

Parameter:	cursor – Typ: bool, Standardwert: False blinking – Typ: bool, Standardwert: False
Rückgabe:	None

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()¶

Rückgabeobjekt:	cursor – Typ: bool, Standardwert: False blinking – Typ: bool, Standardwert: False

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

BrickletLCD20x4.is_button_pressed(button)¶

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)¶

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

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.

Added in version 2.0.1$nbsp;(Plugin).

BrickletLCD20x4.get_custom_character(index)¶

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.

Added in version 2.0.1$nbsp;(Plugin).

BrickletLCD20x4.set_default_text(line, text)¶

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

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().

Added in version 2.0.2$nbsp;(Plugin).

BrickletLCD20x4.get_default_text(line)¶

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.

Added in version 2.0.2$nbsp;(Plugin).

BrickletLCD20x4.set_default_text_counter(counter)¶

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

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.

Added in version 2.0.2$nbsp;(Plugin).

BrickletLCD20x4.get_default_text_counter()¶

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.

Added in version 2.0.2$nbsp;(Plugin).

BrickletLCD20x4.get_identity()¶

Rückgabeobjekt:

uid – Typ: str, Länge: bis zu 8 connected_uid – Typ: str, Länge: bis zu 8 position – Typ: chr, Wertebereich: ["a" bis "h", "z"] 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] 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] 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, function)¶

Parameter:	callback_id – Typ: int function – Typ: callable
Rückgabe:	None

Registriert die function 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 die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

lcd_20x4.register_callback(BrickletLCD20x4.CALLBACK_EXAMPLE, my_callback)

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()¶

Rückgabeobjekt:	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)¶

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)¶

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

Ä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)¶

Parameter:	response_expected – Typ: bool
Rückgabe:	None

Ä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.