Go - LCD 16x2 Bricklet

Dies ist die Beschreibung der Go API Bindings für das LCD 16x2 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 16x2 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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

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_16x2_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 16x2 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lcd, _ := lcd_16x2_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()
}

Button Callback

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_16x2_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 16x2 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lcd, _ := lcd_16x2_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()
}

Unicode

Download (example_unicode.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
 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/lcd_16x2_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your LCD 16x2 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_16x2_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 a string using the UTF8ToKS0066U function to map to the LCD charset
    lcd.WriteLine(0, 0, UTF8ToKS0066U("Stromstärke: 5µA"))

    // Write a string directly including characters from the LCD charset
    lcd.WriteLine(1, 0, "Drehzahl: 1000s\u00e9")

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des LCD 16x2 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/lcd_16x2_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:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func lcd_16x2_bricklet.New(uid string, ipcon *IPConnection) (device LCD16x2Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: LCD16x2Bricklet
  • err – Typ: error

Erzeugt ein neues LCD16x2Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := lcd_16x2_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*LCD16x2Bricklet) WriteLine(line uint8, position uint8, text string) (err error)
Parameter:
  • line – Typ: uint8, Wertebereich: [0 bis 255]
  • position – Typ: uint8, Wertebereich: [0 bis 255]
  • text – Typ: string, Länge: bis zu 16
Rückgabe:
  • err – Typ: error

Schreibt einen Text in die angegebene Zeile (0 bis 1) mit einer vorgegebenen Position (0 bis 15). Der Text kann maximal 16 Zeichen lang sein.

Beispiel: (0, 5, "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.

func (*LCD16x2Bricklet) ClearDisplay() (err error)
Rückgabe:
  • err – Typ: error

Löscht alle Zeichen auf dem Display.

func (*LCD16x2Bricklet) BacklightOn() (err error)
Rückgabe:
  • err – Typ: error

Aktiviert die Hintergrundbeleuchtung.

func (*LCD16x2Bricklet) BacklightOff() (err error)
Rückgabe:
  • err – Typ: error

Deaktiviert die Hintergrundbeleuchtung.

func (*LCD16x2Bricklet) IsBacklightOn() (backlight bool, err error)
Rückgabe:
  • backlight – Typ: bool
  • err – Typ: error

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

Fortgeschrittene Funktionen

func (*LCD16x2Bricklet) SetConfig(cursor bool, blinking bool) (err error)
Parameter:
  • cursor – Typ: bool
  • blinking – Typ: bool
Rückgabe:
  • err – Typ: error

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.

Der Standardwert ist (false, false).

func (*LCD16x2Bricklet) GetConfig() (cursor bool, blinking bool, err error)
Rückgabe:
  • cursor – Typ: bool
  • blinking – Typ: bool
  • err – Typ: error

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

func (*LCD16x2Bricklet) IsButtonPressed(button uint8) (pressed bool, err error)
Parameter:
  • button – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • pressed – Typ: bool
  • err – Typ: error

Gibt true zurück wenn die Taste (0 bis 2) gedrückt ist.

Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die RegisterButtonPressedCallback und RegisterButtonReleasedCallback Callbacks zu nutzen.

func (*LCD16x2Bricklet) SetCustomCharacter(index uint8, character [8]uint8) (err error)
Parameter:
  • index – Typ: uint8, Wertebereich: [0 bis 255]
  • character – Typ: [8]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Das LCD 16x2 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 bis 15 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 16x2 Bricklets gesetzt werden.

Neu in Version 2.0.1 (Plugin).

func (*LCD16x2Bricklet) GetCustomCharacter(index uint8) (character [8]uint8, err error)
Parameter:
  • index – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • character – Typ: [8]uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Gibt den benutzerdefinierten Buchstaben für den gegebenen Index zurück, wie von GetCustomCharacter() gesetzt.

Neu in Version 2.0.1 (Plugin).

func (*LCD16x2Bricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*LCD16x2Bricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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:

  • lcd_16x2_bricklet.FunctionWriteLine = 1
  • lcd_16x2_bricklet.FunctionClearDisplay = 2
  • lcd_16x2_bricklet.FunctionBacklightOn = 3
  • lcd_16x2_bricklet.FunctionBacklightOff = 4
  • lcd_16x2_bricklet.FunctionSetConfig = 6
  • lcd_16x2_bricklet.FunctionSetCustomCharacter = 11
func (*LCD16x2Bricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

  • lcd_16x2_bricklet.FunctionWriteLine = 1
  • lcd_16x2_bricklet.FunctionClearDisplay = 2
  • lcd_16x2_bricklet.FunctionBacklightOn = 3
  • lcd_16x2_bricklet.FunctionBacklightOff = 4
  • lcd_16x2_bricklet.FunctionSetConfig = 6
  • lcd_16x2_bricklet.FunctionSetCustomCharacter = 11
func (*LCD16x2Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

func (*LCD16x2Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune
  • hardwareVersion – Typ: [3]uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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.

Callbacks

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.

func (*LCD16x2Bricklet) RegisterButtonPressedCallback(func(button uint8)) (registrationId uint64)
Callback-Parameter:
  • button – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter des Callbacks ist die Nummer der Taste (0 bis 2).

func (*LCD16x2Bricklet) RegisterButtonReleasedCallback(func(button uint8)) (registrationId uint64)
Callback-Parameter:
  • button – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter des Callbacks ist die Nummer der Taste (0 bis 2).

Konstanten

lcd_16x2_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein LCD 16x2 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_16x2_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines LCD 16x2 Bricklet dar.