MATLAB/Octave - LCD 20x4 Bricklet¶

Hello World (MATLAB)¶

Download (matlab_example_hello_world.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

function matlab_example_hello_world()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLCD20x4;

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

    ipcon = IPConnection(); % Create IP connection
    lcd = handle(BrickletLCD20x4(UID, ipcon), 'CallbackProperties'); % 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');

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Button Callback (MATLAB)¶

Download (matlab_example_button_callback.m)

 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

function matlab_example_button_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLCD20x4;

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

    ipcon = IPConnection(); % Create IP connection
    lcd = handle(BrickletLCD20x4(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Register button pressed callback to function cb_button_pressed
    set(lcd, 'ButtonPressedCallback', @(h, e) cb_button_pressed(e));

    % Register button released callback to function cb_button_released
    set(lcd, 'ButtonReleasedCallback', @(h, e) cb_button_released(e));

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for button pressed callback
function cb_button_pressed(e)
    fprintf('Button Pressed: %i\n', e.button);
end

% Callback function for button released callback
function cb_button_released(e)
    fprintf('Button Released: %i\n', e.button);
end

Hello World (Octave)¶

Download (octave_example_hello_world.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

function octave_example_hello_world()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your LCD 20x4 Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lcd = javaObject("com.tinkerforge.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");

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Button Callback (Octave)¶

Download (octave_example_button_callback.m)

 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

function octave_example_button_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your LCD 20x4 Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lcd = javaObject("com.tinkerforge.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 cb_button_pressed
    lcd.addButtonPressedCallback(@cb_button_pressed);

    % Register button released callback to function cb_button_released
    lcd.addButtonReleasedCallback(@cb_button_released);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for button pressed callback
function cb_button_pressed(e)
    fprintf("Button Pressed: %d\n", java2int(e.button));
end

% Callback function for button released callback
function cb_button_released(e)
    fprintf("Button Released: %d\n", java2int(e.button));
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

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.

In MATLAB:

import com.tinkerforge.BrickletLCD20x4;

lcd20x4 = BrickletLCD20x4("YOUR_DEVICE_UID", ipcon);

In Octave:

lcd20x4 = java_new("com.tinkerforge.BrickletLCD20x4", "YOUR_DEVICE_UID", ipcon);

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

void BrickletLCD20x4.writeLine(short line, short position, String text)¶

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

boolean BrickletLCD20x4.isBacklightOn()¶

Rückgabe:	backlight – Typ: boolean

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

Fortgeschrittene Funktionen¶

void BrickletLCD20x4.setConfig(boolean cursor, boolean blinking)¶

Parameter:	cursor – Typ: boolean, Standardwert: false blinking – Typ: boolean, 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.

BrickletLCD20x4.Config BrickletLCD20x4.getConfig()¶

Rückgabeobjekt:	cursor – Typ: boolean, Standardwert: false blinking – Typ: boolean, Standardwert: false

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

boolean BrickletLCD20x4.isButtonPressed(short button)¶

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

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(short index, short[] character)¶

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

short[] BrickletLCD20x4.getCustomCharacter(short index)¶

Parameter:	index – Typ: short, Wertebereich: [0 bis 7]
Rückgabe:	character – Typ: short[], 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(short line, String text)¶

Parameter:	line – Typ: short, 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(short line)¶

Parameter:	line – Typ: short, 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).

BrickletLCD20x4.Identity BrickletLCD20x4.getIdentity()¶

Rückgabeobjekt:

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: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, 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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb beschrieben.

callback BrickletLCD20x4.ButtonPressedCallback¶

Event-Objekt:	button – Typ: short, 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).

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addButtonPressedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeButtonPressedCallback() wieder entfernt werden.

callback BrickletLCD20x4.ButtonReleasedCallback¶

Event-Objekt:	button – Typ: short, 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).

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addButtonReleasedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeButtonReleasedCallback() wieder entfernt werden.

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.

short[] BrickletLCD20x4.getAPIVersion()¶

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

boolean BrickletLCD20x4.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: boolean

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, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

Ä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(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

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