MATLAB/Octave - OLED 128x64 Bricklet

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das OLED 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 128x64 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.BrickletOLED128x64;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your OLED 128x64 Bricklet

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

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

    % Clear display
    oled.clearDisplay();

    % Write "Hello World" starting from upper left corner of the screen
    oled.writeLine(0, 0, 'Hello World');

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

Pixel Matrix (MATLAB)

Download (matlab_example_pixel_matrix.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
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
function matlab_example_pixel_matrix()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletOLED128x64;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your OLED 128x64 Bricklet
    SCREEN_WIDTH = 128;
    SCREEN_HEIGHT = 64;

    function draw_matrix(oled, pixels)
        column = cell(1, SCREEN_HEIGHT/8);
        column_write = [];

        for i = 1:(SCREEN_HEIGHT/8) - 1
            column{i} = zeros(1, 64);

            for j = 1:SCREEN_WIDTH
                page = 0;

                for k = 0:7
                    if pixels(i*8 + k, j) == true
                        page = bitor(page, bitshift(1, k));
                    end
                end

                column{i}(j) = page;
            end
        end

        oled.newWindow(0, SCREEN_WIDTH-1, 0, 7);

        for i = 1:(SCREEN_HEIGHT/8) - 1
            l = 1;
            for j = 1:SCREEN_WIDTH/2
                column_write(l) = column{i}(j);
                l = l + 1;
            end

            oled.write(column_write);

            l = 1;
            for k = (SCREEN_WIDTH/2) + 1:SCREEN_WIDTH
                column_write(l) = column{i}(k);
                l = l + 1;
            end

            oled.write(column_write);
        end
    end

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

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

    % Clear display
    oled.clearDisplay();

    % Draw checkerboard pattern
    pixel_matrix = false(SCREEN_HEIGHT, SCREEN_WIDTH);

    for h = 1:SCREEN_HEIGHT
        for w = 1:SCREEN_WIDTH
            pixel_matrix(h, w) = mod(floor(h / 8), 2) == mod(floor(w / 8), 2);
        end
    end

    draw_matrix(oled, pixel_matrix);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
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 OLED 128x64 Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    oled = javaObject("com.tinkerforge.BrickletOLED128x64", UID, ipcon); % Create device object

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

    % Clear display
    oled.clearDisplay();

    % Write "Hello World" starting from upper left corner of the screen
    oled.writeLine(0, 0, "Hello World");

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

Pixel Matrix (Octave)

Download (octave_example_pixel_matrix.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
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
function octave_example_pixel_matrix()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your OLED 128x64 Bricklet
    SCREEN_WIDTH = 128;
    SCREEN_HEIGHT = 64;

    function draw_matrix(oled, pixels)
        column = cell(1, SCREEN_HEIGHT/8);

        for i = 1:(SCREEN_HEIGHT/8) - 1
            column{i} = zeros(1, 64);

            for j = 1:SCREEN_WIDTH
                page = 0;

                for k = 0:7
                    if pixels(i*8 + k, j) == true
                        page = bitor(page, bitshift(1, k));
                    end
                end

                column{i}(j) = page;
            end
        end

        oled.newWindow(0, SCREEN_WIDTH-1, 0, 7);

        for i = 1:(SCREEN_HEIGHT/8) - 1
            l = 1;
            for j = 1:SCREEN_WIDTH/2
                column_write(l) = column{i}(j);
                l = l + 1;
            end

            oled.write(column_write);

            l = 1;
            for k = (SCREEN_WIDTH/2) + 1:SCREEN_WIDTH
                column_write(l) = column{i}(k);
                l = l + 1;
            end

            oled.write(column_write);
        end
    end

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    oled = javaObject("com.tinkerforge.BrickletOLED128x64", UID, ipcon); % Create device object

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

    % Clear display
    oled.clearDisplay();

    % Draw checkerboard pattern
    pixel_matrix = false(SCREEN_HEIGHT, SCREEN_WIDTH);

    for h = 1:SCREEN_HEIGHT
        for w = 1:SCREEN_WIDTH
            pixel_matrix(h, w) = mod(floor(h / 8), 2) == mod(floor(w / 8), 2);
        end
    end

    draw_matrix(oled, pixel_matrix);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
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 BrickletOLED128x64(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • oled128x64 – Typ: BrickletOLED128x64

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

In MATLAB:

import com.tinkerforge.BrickletOLED128x64;

oled128x64 = BrickletOLED128x64("YOUR_DEVICE_UID", ipcon);

In Octave:

oled128x64 = java_new("com.tinkerforge.BrickletOLED128x64", "YOUR_DEVICE_UID", ipcon);

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

void BrickletOLED128x64.write(short[] data)
Parameter:
  • data – Typ: short[], Länge: 64, Wertebereich: [0 bis 255]

Fügt 64 Byte Daten zu dem mit newWindow() gesetztem Fenster hinzu.

Jede Zeile hat eine Höhe von 8 Pixeln welche einem Byte Daten entsprechen.

Beispiel: Wenn newWindow() mit Spalte (Column) von 0 bis 127 und Zeile (Row) von 0 bis 7 (das ganze Display) aufgerufen wird, schreibt jedes write() (roter Pfeil) eine halbe Zeile.

Display Pixel Reihenfolge

Das LSB (D0) von jedem Daten-Byte ist in der Zeile oben und das MSB (D7) ist in der Zeile unten.

Der nächste Aufruf von write() schreibt die zweite Hälfte der erste Zeile, und die nächsten beiden Aufrufe die zweite Zeile usw. Um das ganze Display zu füllen muss write() 16 mal aufgerufen werden.

void BrickletOLED128x64.newWindow(short columnFrom, short columnTo, short rowFrom, short rowTo)
Parameter:
  • columnFrom – Typ: short, Wertebereich: [0 bis 255]
  • columnTo – Typ: short, Wertebereich: [0 bis 255]
  • rowFrom – Typ: short, Wertebereich: [0 bis 255]
  • rowTo – Typ: short, Wertebereich: [0 bis 255]

Setzt das Fenster in welches mit write() geschrieben werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.

Die Spalten haben einen Wertebereich von 0 bis 127 und die Zeilen haben einen Wertebereich von 0 bis 7.

void BrickletOLED128x64.clearDisplay()

Löscht den aktuellen Inhalt des mit newWindow() gesetztem Fensters.

void BrickletOLED128x64.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 26

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 25). Der Text kann maximal 26 Zeichen lang sein.

Beispiel: (1, 10, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Es ist möglich zuerst auf das Display mit write() zu malen und danach Text hinzuzufügen.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Fortgeschrittene Funktionen

void BrickletOLED128x64.setDisplayConfiguration(short contrast, boolean invert)
Parameter:
  • contrast – Typ: short, Wertebereich: [0 bis 255]
  • invert – Typ: boolean

Setzt die Konfiguration des Displays

Es können der Kontrast mit einem Wertebereich von 0 bis 255 gesetzt, sowie die Farben (schwarz/weiß) des Displays invertiert werden.

Die Standardwerte sind ein Kontrast von 143 und die Invertierung ist aus.

BrickletOLED128x64.DisplayConfiguration BrickletOLED128x64.getDisplayConfiguration()
Rückgabeobjekt:
  • contrast – Typ: short, Wertebereich: [0 bis 255]
  • invert – Typ: boolean

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

short[] BrickletOLED128x64.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 BrickletOLED128x64.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:

  • BrickletOLED128x64.FUNCTION_WRITE = 1
  • BrickletOLED128x64.FUNCTION_NEW_WINDOW = 2
  • BrickletOLED128x64.FUNCTION_CLEAR_DISPLAY = 3
  • BrickletOLED128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletOLED128x64.FUNCTION_WRITE_LINE = 6
void BrickletOLED128x64.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:

  • BrickletOLED128x64.FUNCTION_WRITE = 1
  • BrickletOLED128x64.FUNCTION_NEW_WINDOW = 2
  • BrickletOLED128x64.FUNCTION_CLEAR_DISPLAY = 3
  • BrickletOLED128x64.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletOLED128x64.FUNCTION_WRITE_LINE = 6
void BrickletOLED128x64.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.

BrickletOLED128x64.Identity BrickletOLED128x64.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.

Konstanten

int BrickletOLED128x64.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein OLED 128x64 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 BrickletOLED128x64.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet dar.