C# - LCD 20x4 Bricklet¶

Hello World¶

Download (ExampleHelloWorld.cs)

 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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your LCD 20x4 Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD20x4 lcd = new BrickletLCD20x4(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Turn backlight on
        lcd.BacklightOn();

        // Write "Hello World"
        lcd.WriteLine(0, 0, "Hello World");

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Button Callback¶

Download (ExampleButtonCallback.cs)

 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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your LCD 20x4 Bricklet

    // Callback function for button pressed callback
    static void ButtonPressedCB(BrickletLCD20x4 sender, byte button)
    {
        Console.WriteLine("Button Pressed: " + button);
    }

    // Callback function for button released callback
    static void ButtonReleasedCB(BrickletLCD20x4 sender, byte button)
    {
        Console.WriteLine("Button Released: " + button);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD20x4 lcd = new BrickletLCD20x4(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Register button pressed callback to function ButtonPressedCB
        lcd.ButtonPressedCallback += ButtonPressedCB;

        // Register button released callback to function ButtonReleasedCB
        lcd.ButtonReleasedCallback += ButtonReleasedCB;

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Unicode¶

Download (ExampleUnicode.cs)

  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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your LCD 20x4 Bricklet

    // Maps a normal UTF-16 encoded string to the LCD charset
    static string UTF16ToKS0066U(string utf16)
    {
        string ks0066u = "";
        char c;

        for (int i = 0; i < utf16.Length; i++) {
            int codePoint = Char.ConvertToUtf32(utf16, i);

            if (Char.IsSurrogate(utf16, i)) {
                // Skip low surrogate
                i++;
            }

            // ASCII subset from JIS X 0201
            if (codePoint >= 0x0020 && codePoint <= 0x007e) {
                // The LCD charset doesn't include '\' and '~', use similar characters instead
                switch (codePoint) {
                case 0x005c: c = (char)0xa4; break; // REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
                case 0x007e: c = (char)0x2d; break; // TILDE maps to HYPHEN-MINUS
                default: c = (char)codePoint; break;
                }
            }
            // Katakana subset from JIS X 0201
            else if (codePoint >= 0xff61 && codePoint <= 0xff9f) {
                c = (char)(codePoint - 0xfec0);
            }
            // Special characters
            else {
                switch (codePoint) {
                case 0x00a5: c = (char)0x5c; break; // YEN SIGN
                case 0x2192: c = (char)0x7e; break; // RIGHTWARDS ARROW
                case 0x2190: c = (char)0x7f; break; // LEFTWARDS ARROW
                case 0x00b0: c = (char)0xdf; break; // DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
                case 0x03b1: c = (char)0xe0; break; // GREEK SMALL LETTER ALPHA
                case 0x00c4: c = (char)0xe1; break; // LATIN CAPITAL LETTER A WITH DIAERESIS
                case 0x00e4: c = (char)0xe1; break; // LATIN SMALL LETTER A WITH DIAERESIS
                case 0x00df: c = (char)0xe2; break; // LATIN SMALL LETTER SHARP S
                case 0x03b5: c = (char)0xe3; break; // GREEK SMALL LETTER EPSILON
                case 0x00b5: c = (char)0xe4; break; // MICRO SIGN
                case 0x03bc: c = (char)0xe4; break; // GREEK SMALL LETTER MU
                case 0x03c2: c = (char)0xe5; break; // GREEK SMALL LETTER FINAL SIGMA
                case 0x03c1: c = (char)0xe6; break; // GREEK SMALL LETTER RHO
                case 0x221a: c = (char)0xe8; break; // SQUARE ROOT
                case 0x00b9: c = (char)0xe9; break; // SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
                case 0x00a4: c = (char)0xeb; break; // CURRENCY SIGN
                case 0x00a2: c = (char)0xec; break; // CENT SIGN
                case 0x2c60: c = (char)0xed; break; // LATIN CAPITAL LETTER L WITH DOUBLE BAR
                case 0x00f1: c = (char)0xee; break; // LATIN SMALL LETTER N WITH TILDE
                case 0x00d6: c = (char)0xef; break; // LATIN CAPITAL LETTER O WITH DIAERESIS
                case 0x00f6: c = (char)0xef; break; // LATIN SMALL LETTER O WITH DIAERESIS
                case 0x03f4: c = (char)0xf2; break; // GREEK CAPITAL THETA SYMBOL
                case 0x221e: c = (char)0xf3; break; // INFINITY
                case 0x03a9: c = (char)0xf4; break; // GREEK CAPITAL LETTER OMEGA
                case 0x00dc: c = (char)0xf5; break; // LATIN CAPITAL LETTER U WITH DIAERESIS
                case 0x00fc: c = (char)0xf5; break; // LATIN SMALL LETTER U WITH DIAERESIS
                case 0x03a3: c = (char)0xf6; break; // GREEK CAPITAL LETTER SIGMA
                case 0x03c0: c = (char)0xf7; break; // GREEK SMALL LETTER PI
                case 0x0304: c = (char)0xf8; break; // COMBINING MACRON
                case 0x00f7: c = (char)0xfd; break; // DIVISION SIGN

                default:
                case 0x25a0: c = (char)0xff; break; // BLACK SQUARE
                }
            }

            // Special handling for 'x' followed by COMBINING MACRON
            if (c == (char)0xf8) {
                if (!ks0066u.EndsWith("x")) {
                    c = (char)0xff; // BLACK SQUARE
                }

                if (ks0066u.Length > 0) {
                    ks0066u = ks0066u.Remove(ks0066u.Length - 1, 1);
                }
            }

            ks0066u += c;
        }

        return ks0066u;
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLCD20x4 lcd = new BrickletLCD20x4(UID, ipcon); // Create device object

        ipcon.Connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Turn backlight on
        lcd.BacklightOn();

        // Write some strings using the UTF16ToKS0066U function to map to the LCD charset
        lcd.WriteLine(0, 0, UTF16ToKS0066U("Stromstärke: 17µA"));
        lcd.WriteLine(1, 0, UTF16ToKS0066U("Temperatur:  23°C"));

        // Write a string directly including characters from the LCD charset
        lcd.WriteLine(2, 0, "Drehzahl:   750min\xe9");

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Grundfunktionen¶

class BrickletLCD20x4(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	lcd20x4 – Typ: BrickletLCD20x4

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

BrickletLCD20x4 lcd20x4 = new BrickletLCD20x4("YOUR_DEVICE_UID", ipcon);

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

void BrickletLCD20x4.WriteLine(byte line, byte position, string text)¶

Parameter:	line – Typ: byte, Wertebereich: [0 bis 3] position – Typ: byte, Wertebereich: [0 bis 19] text – Typ: string, 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.

void BrickletLCD20x4.ClearDisplay()¶

Löscht alle Zeichen auf dem Display.

void BrickletLCD20x4.BacklightOn()¶

Aktiviert die Hintergrundbeleuchtung.

void BrickletLCD20x4.BacklightOff()¶

Deaktiviert die Hintergrundbeleuchtung.

bool BrickletLCD20x4.IsBacklightOn()¶

Rückgabe:	backlight – Typ: bool

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

Fortgeschrittene Funktionen¶

void BrickletLCD20x4.SetConfig(bool cursor, bool blinking)¶

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 WriteLine() geschriebenen Text.

void BrickletLCD20x4.GetConfig(out bool cursor, out bool blinking)¶

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

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

bool BrickletLCD20x4.IsButtonPressed(byte button)¶

Parameter:	button – Typ: byte, 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 ButtonPressedCallback und ButtonReleasedCallback Callbacks zu nutzen.

void BrickletLCD20x4.SetCustomCharacter(byte index, byte[] character)¶

Parameter:	index – Typ: byte, Wertebereich: [0 bis 7] character – Typ: byte[], 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 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).

byte[] BrickletLCD20x4.GetCustomCharacter(byte index)¶

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

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

Neu in Version 2.0.1 (Plugin).

void BrickletLCD20x4.SetDefaultText(byte line, string text)¶

Parameter:	line – Typ: byte, Wertebereich: [0 bis 3] text – Typ: string, 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 SetDefaultTextCounter().

Neu in Version 2.0.2 (Plugin).

string BrickletLCD20x4.GetDefaultText(byte line)¶

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

Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von SetDefaultText() gesetzt.

Neu in Version 2.0.2 (Plugin).

void BrickletLCD20x4.SetDefaultTextCounter(int counter)¶

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

int BrickletLCD20x4.GetDefaultTextCounter()¶

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

void BrickletLCD20x4.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Ausgabeparameter:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] deviceIdentifier – 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.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletLCD20x4 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

lcd20x4.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickletLCD20x4.ButtonPressedCallback(BrickletLCD20x4 sender, byte button)¶

Callback-Parameter:	sender – Typ: BrickletLCD20x4 button – Typ: byte, 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).

event BrickletLCD20x4.ButtonReleasedCallback(BrickletLCD20x4 sender, byte button)¶

Callback-Parameter:	sender – Typ: BrickletLCD20x4 button – Typ: byte, 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.

byte[] BrickletLCD20x4.GetAPIVersion()¶

Ausgabeparameter:	apiVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, 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.

bool BrickletLCD20x4.GetResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – 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 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:

• 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

void BrickletLCD20x4.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – 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 functionId:

• 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

void BrickletLCD20x4.SetResponseExpectedAll(bool responseExpected)¶

Parameter:	responseExpected – Typ: bool

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

Konstanten¶

int BrickletLCD20x4.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein LCD 20x4 Bricklet zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletLCD20x4.DEVICE_DISPLAY_NAME¶

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