MATLAB/Octave - LCD 16x2 Bricklet

Dies ist die Beschreibung der MATLAB/Octave 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 MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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.BrickletLCD16x2;

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

    ipcon = IPConnection(); % Create IP connection
    lcd = handle(BrickletLCD16x2(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.BrickletLCD16x2;

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

    ipcon = IPConnection(); % Create IP connection
    lcd = handle(BrickletLCD16x2(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 16x2 Bricklet

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

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

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletLCD16x2(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • lcd16x2 – Typ: BrickletLCD16x2

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

In MATLAB:

import com.tinkerforge.BrickletLCD16x2;

lcd16x2 = BrickletLCD16x2("YOUR_DEVICE_UID", ipcon);

In Octave:

lcd16x2 = java_new("com.tinkerforge.BrickletLCD16x2", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

void BrickletLCD16x2.writeLine(short line, short position, String text)
Parameter:
  • line – Typ: short, Wertebereich: [0 bis 255]
  • position – Typ: short, Wertebereich: [0 bis 255]
  • text – Typ: String, Länge: bis zu 16

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.

void BrickletLCD16x2.clearDisplay()

Löscht alle Zeichen auf dem Display.

void BrickletLCD16x2.backlightOn()

Aktiviert die Hintergrundbeleuchtung.

void BrickletLCD16x2.backlightOff()

Deaktiviert die Hintergrundbeleuchtung.

boolean BrickletLCD16x2.isBacklightOn()
Rückgabe:
  • backlight – Typ: boolean

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

Fortgeschrittene Funktionen

void BrickletLCD16x2.setConfig(boolean cursor, boolean blinking)
Parameter:
  • cursor – Typ: boolean
  • blinking – Typ: boolean

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

BrickletLCD16x2.Config BrickletLCD16x2.getConfig()
Rückgabeobjekt:
  • cursor – Typ: boolean
  • blinking – Typ: boolean

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

boolean BrickletLCD16x2.isButtonPressed(short button)
Parameter:
  • button – Typ: short, Wertebereich: [0 bis 255]
Rückgabe:
  • pressed – Typ: boolean

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 ButtonPressedCallback und ButtonReleasedCallback Callbacks zu nutzen.

void BrickletLCD16x2.setCustomCharacter(short index, short[] character)
Parameter:
  • index – Typ: short, Wertebereich: [0 bis 255]
  • character – Typ: short[], Länge: 8, Wertebereich: [0 bis 255]

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

short[] BrickletLCD16x2.getCustomCharacter(short index)
Parameter:
  • index – Typ: short, Wertebereich: [0 bis 255]
Rückgabe:
  • character – Typ: short[], Länge: 8, Wertebereich: [0 bis 255]

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

Neu in Version 2.0.1 (Plugin).

short[] BrickletLCD16x2.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]

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.

boolean BrickletLCD16x2.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletLCD16x2.FUNCTION_WRITE_LINE = 1
  • BrickletLCD16x2.FUNCTION_CLEAR_DISPLAY = 2
  • BrickletLCD16x2.FUNCTION_BACKLIGHT_ON = 3
  • BrickletLCD16x2.FUNCTION_BACKLIGHT_OFF = 4
  • BrickletLCD16x2.FUNCTION_SET_CONFIG = 6
  • BrickletLCD16x2.FUNCTION_SET_CUSTOM_CHARACTER = 11
void BrickletLCD16x2.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletLCD16x2.FUNCTION_WRITE_LINE = 1
  • BrickletLCD16x2.FUNCTION_CLEAR_DISPLAY = 2
  • BrickletLCD16x2.FUNCTION_BACKLIGHT_ON = 3
  • BrickletLCD16x2.FUNCTION_BACKLIGHT_OFF = 4
  • BrickletLCD16x2.FUNCTION_SET_CONFIG = 6
  • BrickletLCD16x2.FUNCTION_SET_CUSTOM_CHARACTER = 11
void BrickletLCD16x2.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.

BrickletLCD16x2.Identity BrickletLCD16x2.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3, 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 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 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.

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.

callback BrickletLCD16x2.ButtonPressedCallback
Event-Objekt:
  • button – Typ: short, Wertebereich: [0 bis 255]

Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter ist die Nummer der Taste (0 bis 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 werde. Eine hinzugefügter Callback-Function kann mit removeButtonPressedCallback() wieder entfernt werden.

callback BrickletLCD16x2.ButtonReleasedCallback
Event-Objekt:
  • button – Typ: short, Wertebereich: [0 bis 255]

Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter ist die Nummer der Taste (0 bis 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 werde. Eine hinzugefügter Callback-Function kann mit removeButtonReleasedCallback() wieder entfernt werden.

Konstanten

int BrickletLCD16x2.DEVICE_IDENTIFIER

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

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