MATLAB/Octave - OLED 128x64 Bricklet 2.0

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

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

    ipcon = IPConnection(); % Create IP connection
    oled = handle(BrickletOLED128x64V2(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
function matlab_example_pixel_matrix()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletOLED128x64V2;

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

    ipcon = IPConnection(); % Create IP connection
    oled = handle(BrickletOLED128x64V2(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
    for h = 0:SCREEN_HEIGHT-1
        for w = 0:SCREEN_WIDTH-1
            pixels(h*SCREEN_WIDTH + w + 1) = mod(floor(h / 8), 2) == mod(floor(w / 8), 2);
        end
    end

    oled.writePixels(0, 0, SCREEN_WIDTH-1, SCREEN_HEIGHT-1, pixels);

    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 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    oled = javaObject("com.tinkerforge.BrickletOLED128x64V2", 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
function octave_example_pixel_matrix()
    more off;

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

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    oled = javaObject("com.tinkerforge.BrickletOLED128x64V2", 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
    for h = 0:SCREEN_HEIGHT-1
        for w = 0:SCREEN_WIDTH-1
            pixels(h*SCREEN_WIDTH + w + 1) = mod(floor(h / 8), 2) == mod(floor(w / 8), 2);
        end
    end

    oled.writePixels(0, 0, SCREEN_WIDTH-1, SCREEN_HEIGHT-1, pixels);

    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 BrickletOLED128x64V2(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • oled128x64V2 – Typ: BrickletOLED128x64V2

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

In MATLAB:

import com.tinkerforge.BrickletOLED128x64V2;

oled128x64V2 = BrickletOLED128x64V2("YOUR_DEVICE_UID", ipcon);

In Octave:

oled128x64V2 = java_new("com.tinkerforge.BrickletOLED128x64V2", "YOUR_DEVICE_UID", ipcon);

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

void BrickletOLED128x64V2.writePixels(int xStart, int yStart, int xEnd, int yEnd, boolean[] pixels)
Parameter:
  • xStart – Typ: int, Wertebereich: [0 bis 127]
  • yStart – Typ: int, Wertebereich: [0 bis 63]
  • xEnd – Typ: int, Wertebereich: [0 bis 127]
  • yEnd – Typ: int, Wertebereich: [0 bis 63]
  • pixels – Typ: boolean[], Länge: variabel

Schreibt Pixel in das angegebene Fenster.

Die Pixel werden zeilenweise von oben nach unten die Zeilen werden jeweils von links nach rechts geschrieben.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel in einen internen Buffer geschrieben der dann durch einen Aufruf von drawBufferedFrame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die setDisplayConfiguration() Funktion eingestellt werden.

boolean[] BrickletOLED128x64V2.readPixels(int xStart, int yStart, int xEnd, int yEnd)
Parameter:
  • xStart – Typ: int, Wertebereich: [0 bis 127]
  • yStart – Typ: int, Wertebereich: [0 bis 63]
  • xEnd – Typ: int, Wertebereich: [0 bis 127]
  • yEnd – Typ: int, Wertebereich: [0 bis 63]
Rückgabe:
  • pixels – Typ: boolean[], Länge: variabel

Liest Pixel aus dem angegebenen Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. Die Pixel werden zeilenweise von oben nach unten und die Zeilen werden jeweils von links nach rechts gelesen.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt vom Display gelesen.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel aus einen internen Buffer gelesen (siehe drawBufferedFrame()).

Automatic Draw kann über die setDisplayConfiguration() Funktion eingestellt werden.

void BrickletOLED128x64V2.clearDisplay()

Löscht den kompletten aktuellen Inhalt des Displays.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt gelöscht.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel im internen Buffer gelöscht der dann durch einen Aufruf von drawBufferedFrame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die setDisplayConfiguration() Funktion eingestellt werden.

void BrickletOLED128x64V2.writeLine(int line, int position, String text)
Parameter:
  • line – Typ: int, Wertebereich: [0 bis 7]
  • position – Typ: int, Wertebereich: [0 bis 21]
  • text – Typ: String, Länge: bis zu 22

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 22 Zeichen lang sein.

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

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

Wenn Automatic Draw aktiviert ist (Standard), dann wird der Text direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann wird der Text in einen internen Buffer geschrieben der dann durch einen Aufruf von drawBufferedFrame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die setDisplayConfiguration() Funktion eingestellt werden.

void BrickletOLED128x64V2.drawBufferedFrame(boolean forceCompleteRedraw)
Parameter:
  • forceCompleteRedraw – Typ: boolean

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von writePixels() und writeLine() direkt auf den Display. Wenn jedoch Automatic Draw deaktiviert ist (setDisplayConfiguration()), dann werden Änderungen in einen internen Buffer anstatt auf den Display geschrieben. Der internen Buffer kann dann durch einen Aufruf dieser Funktion auf den Display geschrieben werden. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Wenn Force Complete Redraw auf true gesetzt ist, dann wird der gesamte Display aktualisiert, anstatt nur die Pixel die sich wirklich verändert haben. Normalerweise sollte dies nicht notwendig sein, außer bei hängenden Pixeln bedingt durch Fehler.

Fortgeschrittene Funktionen

void BrickletOLED128x64V2.setDisplayConfiguration(int contrast, boolean invert, boolean automaticDraw)
Parameter:
  • contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143
  • invert – Typ: boolean, Standardwert: false
  • automaticDraw – Typ: boolean, Standardwert: true

Setzt die Konfiguration des Displays.

Der Kontrast kann zwischen 0 und 255 und das Farbschema invertiert (weiß/schwarz) eingestellt werden.

Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem Aufruf von writePixels() und writeLine() aktualisiert. Wenn Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen internen Buffer geschrieben, der dann bei bei einem Aufruf von drawBufferedFrame() auf dem Display angezeigt wird.

BrickletOLED128x64V2.DisplayConfiguration BrickletOLED128x64V2.getDisplayConfiguration()
Rückgabeobjekt:
  • contrast – Typ: int, Wertebereich: [0 bis 255], Standardwert: 143
  • invert – Typ: boolean, Standardwert: false
  • automaticDraw – Typ: boolean, Standardwert: true

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

BrickletOLED128x64V2.SPITFPErrorCount BrickletOLED128x64V2.getSPITFPErrorCount()
Rückgabeobjekt:
  • errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int BrickletOLED128x64V2.setBootloaderMode(int mode)
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

  • BrickletOLED128x64V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletOLED128x64V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletOLED128x64V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletOLED128x64V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletOLED128x64V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletOLED128x64V2.BOOTLOADER_STATUS_OK = 0
  • BrickletOLED128x64V2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletOLED128x64V2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletOLED128x64V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletOLED128x64V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletOLED128x64V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletOLED128x64V2.getBootloaderMode()
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

  • BrickletOLED128x64V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletOLED128x64V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletOLED128x64V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletOLED128x64V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletOLED128x64V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletOLED128x64V2.setWriteFirmwarePointer(long pointer)
Parameter:
  • pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int BrickletOLED128x64V2.writeFirmware(int[] data)
Parameter:
  • data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

void BrickletOLED128x64V2.setStatusLEDConfig(int config)
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

  • BrickletOLED128x64V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletOLED128x64V2.STATUS_LED_CONFIG_ON = 1
  • BrickletOLED128x64V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletOLED128x64V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletOLED128x64V2.getStatusLEDConfig()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

  • BrickletOLED128x64V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletOLED128x64V2.STATUS_LED_CONFIG_ON = 1
  • BrickletOLED128x64V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletOLED128x64V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletOLED128x64V2.getChipTemperature()
Rückgabe:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletOLED128x64V2.reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

void BrickletOLED128x64V2.writeUID(long uid)
Parameter:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

long BrickletOLED128x64V2.readUID()
Rückgabe:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletOLED128x64V2.Identity BrickletOLED128x64V2.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', 'i', 'z']
  • hardwareVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: revision – Typ: int, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

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.

int[] BrickletOLED128x64V2.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: revision – Typ: int, 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 BrickletOLED128x64V2.getResponseExpected(int functionId)
Parameter:
  • functionId – Typ: int, 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:

  • BrickletOLED128x64V2.FUNCTION_WRITE_PIXELS = 1
  • BrickletOLED128x64V2.FUNCTION_CLEAR_DISPLAY = 3
  • BrickletOLED128x64V2.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletOLED128x64V2.FUNCTION_WRITE_LINE = 6
  • BrickletOLED128x64V2.FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BrickletOLED128x64V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOLED128x64V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOLED128x64V2.FUNCTION_RESET = 243
  • BrickletOLED128x64V2.FUNCTION_WRITE_UID = 248
void BrickletOLED128x64V2.setResponseExpected(int functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: int, 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:

  • BrickletOLED128x64V2.FUNCTION_WRITE_PIXELS = 1
  • BrickletOLED128x64V2.FUNCTION_CLEAR_DISPLAY = 3
  • BrickletOLED128x64V2.FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletOLED128x64V2.FUNCTION_WRITE_LINE = 6
  • BrickletOLED128x64V2.FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BrickletOLED128x64V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOLED128x64V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOLED128x64V2.FUNCTION_RESET = 243
  • BrickletOLED128x64V2.FUNCTION_WRITE_UID = 248
void BrickletOLED128x64V2.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 BrickletOLED128x64V2.DEVICE_IDENTIFIER

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

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