Dies ist die Beschreibung der Go API Bindings für das LCD 20x4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 20x4 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_hello_world.go)
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/lcd_20x4_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 20x4 Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
lcd, _ := lcd_20x4_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Turn backlight on
lcd.BacklightOn()
// Write "Hello World"
lcd.WriteLine(0, 0, "Hello World")
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_button_callback.go)
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/lcd_20x4_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 20x4 Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
lcd, _ := lcd_20x4_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
lcd.RegisterButtonPressedCallback(func(button uint8) {
fmt.Printf("Button Pressed: %d\n", button)
})
lcd.RegisterButtonReleasedCallback(func(button uint8) {
fmt.Printf("Button Released: %d\n", button)
})
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/lcd_20x4_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 20x4 Bricklet.
func UTF8ToKS0066U(utf8 string) string {
var result []rune
for _, r := range utf8 {
var replacement rune
switch {
// ASCII subset from JIS X 0201
// The LCD charset doesn't include '\' and '~', use similar characters instead
case r == 0x005c:
replacement = 0xa4 // REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
case r == 0x007e:
replacement = 0x2d // TILDE maps to HYPHEN-MINUS
case r >= 0x0020 && r <= 0x007e:
replacement = r
// Katakana subset from JIS X 0201
case r >= 0xff61 && r <= 0xff9f:
replacement = r - 0xfec0
// Special characters
case r == 0x00a5:
replacement = 0x5c // YEN SIGN
case r == 0x2192:
replacement = 0x7e // RIGHTWARDS ARROW
case r == 0x2190:
replacement = 0x7f // LEFTWARDS ARROW
case r == 0x00b0:
replacement = 0xdf // DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
case r == 0x03b1:
replacement = 0xe0 // GREEK SMALL LETTER ALPHA
case r == 0x00c4:
replacement = 0xe1 // LATIN CAPITAL LETTER A WITH DIAERESIS
case r == 0x00e4:
replacement = 0xe1 // LATIN SMALL LETTER A WITH DIAERESIS
case r == 0x00df:
replacement = 0xe2 // LATIN SMALL LETTER SHARP S
case r == 0x03b5:
replacement = 0xe3 // GREEK SMALL LETTER EPSILON
case r == 0x00b5:
replacement = 0xe4 // MICRO SIGN
case r == 0x03bc:
replacement = 0xe4 // GREEK SMALL LETTER MU
case r == 0x03c2:
replacement = 0xe5 // GREEK SMALL LETTER FINAL SIGMA
case r == 0x03c1:
replacement = 0xe6 // GREEK SMALL LETTER RHO
case r == 0x221a:
replacement = 0xe8 // SQUARE ROOT
case r == 0x00b9:
replacement = 0xe9 // SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
case r == 0x00a4:
replacement = 0xeb // CURRENCY SIGN
case r == 0x00a2:
replacement = 0xec // CENT SIGN
case r == 0x2c60:
replacement = 0xed // LATIN CAPITAL LETTER L WITH DOUBLE BAR
case r == 0x00f1:
replacement = 0xee // LATIN SMALL LETTER N WITH TILDE
case r == 0x00d6:
replacement = 0xef // LATIN CAPITAL LETTER O WITH DIAERESIS
case r == 0x00f6:
replacement = 0xef // LATIN SMALL LETTER O WITH DIAERESIS
case r == 0x03f4:
replacement = 0xf2 // GREEK CAPITAL THETA SYMBOL
case r == 0x221e:
replacement = 0xf3 // INFINITY
case r == 0x03a9:
replacement = 0xf4 // GREEK CAPITAL LETTER OMEGA
case r == 0x00dc:
replacement = 0xf5 // LATIN CAPITAL LETTER U WITH DIAERESIS
case r == 0x00fc:
replacement = 0xf5 // LATIN SMALL LETTER U WITH DIAERESIS
case r == 0x03a3:
replacement = 0xf6 // GREEK CAPITAL LETTER SIGMA
case r == 0x03c0:
replacement = 0xf7 // GREEK SMALL LETTER PI
case r == 0x0304:
replacement = 0xf8 // COMBINING MACRON
case r == 0x00f7:
replacement = 0xfd // DIVISION SIGN
default:
replacement = 0xff // BLACK SQUARE
}
// Special handling for 'x' followed by COMBINING MACRON
if replacement == 0xf8 {
if result[len(result)-1] != 'x' {
replacement = 0xff // BLACK SQUARE
}
if len(result) > 0 {
result = result[:len(result)-1]
}
}
result = append(result, replacement)
}
return string(result)
}
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
lcd, _ := lcd_20x4_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Turn backlight on
lcd.BacklightOn()
// Write some strings using the UTF8ToKS0066U function to map to the LCD charset
lcd.WriteLine(0, 0, UTF8ToKS0066U("Stromstärke: 17µA"))
lcd.WriteLine(1, 0, UTF8ToKS0066U("Temperatur: 23°C"))
// Write a string directly including characters from the LCD charset
lcd.WriteLine(2, 0, "Drehzahl: 750min\u00e9")
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des LCD 20x4 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/lcd_20x4_bricklet
definiert.
Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError
, der das error-Interface implementiert,
zurückgeben. Dieser kann folgende Werte annehmen:
welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
lcd_20x4_bricklet.
New
(uid string, ipcon *IPConnection) (device LCD20x4Bricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues LCD20x4Bricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := lcd_20x4_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*LCD20x4Bricklet)
WriteLine
(line uint8, position uint8, text string) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*LCD20x4Bricklet)
ClearDisplay
() (err error)¶Rückgabe: |
|
---|
Löscht alle Zeichen auf dem Display.
(*LCD20x4Bricklet)
BacklightOn
() (err error)¶Rückgabe: |
|
---|
Aktiviert die Hintergrundbeleuchtung.
(*LCD20x4Bricklet)
BacklightOff
() (err error)¶Rückgabe: |
|
---|
Deaktiviert die Hintergrundbeleuchtung.
(*LCD20x4Bricklet)
IsBacklightOn
() (backlight bool, err error)¶Rückgabe: |
|
---|
Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.
(*LCD20x4Bricklet)
SetConfig
(cursor bool, blinking bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 WriteLine()
geschriebenen Text.
(*LCD20x4Bricklet)
GetConfig
() (cursor bool, blinking bool, err error)¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfig()
gesetzt.
(*LCD20x4Bricklet)
IsButtonPressed
(button uint8) (pressed bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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
ButtonPressedCallback
und ButtonReleasedCallback
Callbacks zu nutzen.
(*LCD20x4Bricklet)
SetCustomCharacter
(index uint8, character [8]uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 WriteLine()
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).
(*LCD20x4Bricklet)
GetCustomCharacter
(index uint8) (character [8]uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den benutzerdefinierten Buchstaben für den gegebenen
Index zurück, wie von SetCustomCharacter()
gesetzt.
Neu in Version 2.0.1 (Plugin).
(*LCD20x4Bricklet)
SetDefaultText
(line uint8, text string) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 SetDefaultTextCounter()
.
Neu in Version 2.0.2 (Plugin).
(*LCD20x4Bricklet)
GetDefaultText
(line uint8) (text string, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von
SetDefaultText()
gesetzt.
Neu in Version 2.0.2 (Plugin).
(*LCD20x4Bricklet)
SetDefaultTextCounter
(counter int32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 SetDefaultText()
).
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 SetDefaultTextCounter()
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).
(*LCD20x4Bricklet)
GetDefaultTextCounter
() (counter int32, err error)¶Rückgabe: |
|
---|
Gibt den aktuellen Wert des Standard-Text-Zählers zurück.
Neu in Version 2.0.2 (Plugin).
(*LCD20x4Bricklet)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Rückgabe: |
|
---|
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.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der entsprechenden Register*Callback
-Function durchgeführt werden,
welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback
später deregistriert werden.
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.
(*LCD20x4Bricklet)
RegisterButtonPressedCallback
(func(button uint8)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter des Callbacks ist die Nummer der Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2).
(*LCD20x4Bricklet)
RegisterButtonReleasedCallback
(func(button uint8)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter des Callbacks ist die Nummer der Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2).
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.
(*LCD20x4Bricklet)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Rückgabe: |
|
---|
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.
(*LCD20x4Bricklet)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 SetResponseExpected()
. 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 functionId:
(*LCD20x4Bricklet)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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 functionId:
(*LCD20x4Bricklet)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
lcd_20x4_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein LCD 20x4 Bricklet zu identifizieren.
Die GetIdentity()
Funktion und
der (*IPConnection) RegisterEnumerateCallback
Callback der IPConnection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
lcd_20x4_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.