MATLAB/Octave - IO-16 Bricklet

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

Input (MATLAB)

Download (matlab_example_input.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
function matlab_example_input()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletIO16;

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

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

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

    % Get current value from port A as bitmask
    valueMask = io.getPort('a');
    fprintf('Value Mask (Port A): %s\n', dec2bin(valueMask));

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

Output (MATLAB)

Download (matlab_example_output.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_output()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletIO16;

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

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

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

    % Set pin 0 on port A to output low
    io.setPortConfiguration('a', bitshift(1, 0), 'o', false);

    % Set pin 0 and 7 on port B to output high
    io.setPortConfiguration('b', bitor(bitshift(1, 0), bitshift(1, 7)), 'o', true);

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

Interrupt (MATLAB)

Download (matlab_example_interrupt.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_interrupt()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletIO16;

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

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

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

    % Register interrupt callback to function cb_interrupt
    set(io, 'InterruptCallback', @(h, e) cb_interrupt(e));

    % Enable interrupt on pin 2 of port A
    io.setPortInterrupt('a', bitshift(1, 2));

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

% Callback function for interrupt callback
function cb_interrupt(e)
    fprintf('Port: %s\n', e.port);
    fprintf('Interrupt Mask: %s\n', dec2bin(e.interruptMask));
    fprintf('Value Mask: %s\n', dec2bin(e.valueMask));
    fprintf('\n');
end

Output (Octave)

Download (octave_example_output.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_output()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your IO-16 Bricklet

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

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

    % Set pin 0 on port A to output low
    io.setPortConfiguration("a", bitshift(1, 0), "o", false);

    % Set pin 0 and 7 on port B to output high
    io.setPortConfiguration("b", bitor(bitshift(1, 0), bitshift(1, 7)), "o", true);

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

Input (Octave)

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

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your IO-16 Bricklet

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

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

    % Get current value from port A as bitmask
    valueMask = io.getPort("a");
    fprintf("Value Mask (Port A): %s\n", dec2bin(java2int(valueMask)));

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

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

Interrupt (Octave)

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

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your IO-16 Bricklet

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

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

    % Register interrupt callback to function cb_interrupt
    io.addInterruptCallback(@cb_interrupt);

    % Enable interrupt on pin 2 of port A
    io.setPortInterrupt("a", bitshift(1, 2));

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

% Callback function for interrupt callback
function cb_interrupt(e)
    fprintf("Port: %s\n", e.port);
    fprintf("Interrupt Mask: %s\n", dec2bin(java2int(e.interruptMask)));
    fprintf("Value Mask: %s\n", dec2bin(java2int(e.valueMask)));
    fprintf("\n");
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 BrickletIO16(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • io16 – Typ: BrickletIO16

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

In MATLAB:

import com.tinkerforge.BrickletIO16;

io16 = BrickletIO16("YOUR_DEVICE_UID", ipcon);

In Octave:

io16 = java_new("com.tinkerforge.BrickletIO16", "YOUR_DEVICE_UID", ipcon);

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

void BrickletIO16.setPort(char port, short valueMask)
Parameter:
  • port – Typ: char
  • valueMask – Typ: short, Wertebereich: [0 bis 255]

Setzt den Ausgangszustand (logisch 1 oder logisch 0) für einen Port ("a" oder "b") mittels einer Bitmaske (8Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 15 bzw. 0b00001111 setzt die Pins 0-3 auf logisch 1 und die Pins 4-7 auf logisch 0.

Alle laufenden Monoflop Timer für den angegebenen Port werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind. Pull-Up Widerstände können mit setPortConfiguration() zugeschaltet werden.

short BrickletIO16.getPort(char port)
Parameter:
  • port – Typ: char
Rückgabe:
  • valueMask – Typ: short, Wertebereich: [0 bis 255]

Gibt eine Bitmaske der aktuell gemessenen Zustände des gewählten Ports zurück. Diese Funktion gibt die Zustände aller Pins zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

void BrickletIO16.setPortConfiguration(char port, short selectionMask, char direction, boolean value)
Parameter:
  • port – Typ: char
  • selectionMask – Typ: short, Wertebereich: [0 bis 255]
  • direction – Typ: char, Wertebereich: Siehe Konstanten
  • value – Typ: boolean

Konfiguriert den Zustand und die Richtung des angegebenen Ports. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.

Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).

Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).

Beispiele:

  • ('a', 255, 'i', true) bzw. ('a', 0b11111111, 'i', true) setzt alle Pins des Ports a als Eingang mit Pull-Up.
  • ('a', 128, 'i', false) bzw. ('a', 0b10000000, 'i', false) setzt Pin 7 des Ports A als Standard Eingang (potentialfrei wenn nicht verbunden).
  • ('b', 3, 'o', false) bzw. ('b', 0b00000011, 'o', false) setzt die Pins 0 und 1 des Ports B als Ausgang im Zustand logisch 0.
  • ('b', 4, 'o', true) bzw. ('b', 0b00000100, 'o', true) setzt Pin 2 des Ports B als Ausgang im Zustand logisch 1.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Die Standardkonfiguration ist Eingang mit Pull-Up.

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

Für direction:

  • BrickletIO16.DIRECTION_IN = 'i'
  • BrickletIO16.DIRECTION_OUT = 'o'
BrickletIO16.PortConfiguration BrickletIO16.getPortConfiguration(char port)
Parameter:
  • port – Typ: char
Rückgabeobjekt:
  • directionMask – Typ: short, Wertebereich: [0 bis 255]
  • valueMask – Typ: short, Wertebereich: [0 bis 255]

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins des gewählten Ports zurück. Eine 1 in der Bitmaske für die Richtung bedeutet Eingang und eine 0 in der Bitmaske bedeutet Ausgang.

Beispiel: Ein Rückgabewert von (15, 51) bzw. (0b00001111, 0b00110011) für Richtung und Zustand bedeutet:

  • Pin 0 und 1 sind als Eingang mit Pull-Up konfiguriert,
  • Pin 2 und 3 sind als Standard Eingang konfiguriert,
  • Pin 4 und 5 sind als Ausgang im Zustand logisch 1 konfiguriert
  • und Pin 6 und 7 sind als Ausgang im Zustand logisch 0 konfiguriert.
long BrickletIO16.getEdgeCount(short pin, boolean resetCounter)
Parameter:
  • pin – Typ: short, Wertebereich: [0 bis 255]
  • resetCounter – Typ: boolean
Rückgabe:
  • count – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin von Port A zurück. Die zu zählenden Flanken können mit setEdgeCountConfig() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

void BrickletIO16.setPortMonoflop(char port, short selectionMask, short valueMask, long time)
Parameter:
  • port – Typ: char
  • selectionMask – Typ: short, Wertebereich: [0 bis 255]
  • valueMask – Typ: short, Wertebereich: [0 bis 255]
  • time – Typ: long, Wertebereich: [0 bis 232 - 1]

Konfiguriert einen Monoflop für die Pins, wie mittels der 8 Bit langen Bitmaske des zweiten Parameters festgelegt. Die festgelegten Pins müssen als Ausgänge konfiguriert sein. Als Eingänge konfigurierte Pins werden ignoriert.

Der dritte Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der vierte Parameter stellt die Zeit (in ms) dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern ('a', 9, 1, 1500) bzw. ('a', 0b00001001, 0b00000001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 am Port 'a' gesetzt. Nach 1,5s wird Pin 0 wieder logisch 0 und Pin 3 logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-16 Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.

BrickletIO16.PortMonoflop BrickletIO16.getPortMonoflop(char port, short pin)
Parameter:
  • port – Typ: char
  • pin – Typ: short, Wertebereich: [0 bis 255]
Rückgabeobjekt:
  • value – Typ: short, Wertebereich: [0 bis 255]
  • time – Typ: long, Wertebereich: [0 bis 232 - 1]
  • timeRemaining – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von setPortMonoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

void BrickletIO16.setSelectedValues(char port, short selectionMask, short valueMask)
Parameter:
  • port – Typ: char
  • selectionMask – Typ: short, Wertebereich: [0 bis 255]
  • valueMask – Typ: short, Wertebereich: [0 bis 255]

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske hat eine Länge von 8 Bit und eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Die Parameter ('a', 192, 128) bzw. ('a', 0b11000000, 0b10000000) setzen den Pin 7 auf logisch 1 und den Pin 6 auf logisch 0 an Port A. Die Pins 0-6 bleiben unangetastet.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind. Pull-Up Widerstände können mit setPortConfiguration() zugeschaltet werden.

void BrickletIO16.setEdgeCountConfig(short pin, short edgeType, short debounce)
Parameter:
  • pin – Typ: short, Wertebereich: [0 bis 255]
  • edgeType – Typ: short, Wertebereich: Siehe Konstanten
  • debounce – Typ: short, Wertebereich: [0 bis 255]

Konfiguriert den Flankenzähler für den ausgewählten Pin von Port A. Der Flankenzähler steht für Pins 0 und 1 zur Verfügung.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Die Entprellzeit (debounce) wird in ms angegeben.

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

Für edgeType:

  • BrickletIO16.EDGE_TYPE_RISING = 0
  • BrickletIO16.EDGE_TYPE_FALLING = 1
  • BrickletIO16.EDGE_TYPE_BOTH = 2

Neu in Version 2.0.3 (Plugin).

BrickletIO16.EdgeCountConfig BrickletIO16.getEdgeCountConfig(short pin)
Parameter:
  • pin – Typ: short, Wertebereich: [0 bis 255]
Rückgabeobjekt:
  • edgeType – Typ: short, Wertebereich: Siehe Konstanten
  • debounce – Typ: short, Wertebereich: [0 bis 255]

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin von Port A zurück, wie von setEdgeCountConfig() gesetzt.

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

Für edgeType:

  • BrickletIO16.EDGE_TYPE_RISING = 0
  • BrickletIO16.EDGE_TYPE_FALLING = 1
  • BrickletIO16.EDGE_TYPE_BOTH = 2

Neu in Version 2.0.3 (Plugin).

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

  • BrickletIO16.FUNCTION_SET_PORT = 1
  • BrickletIO16.FUNCTION_SET_PORT_CONFIGURATION = 3
  • BrickletIO16.FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIO16.FUNCTION_SET_PORT_INTERRUPT = 7
  • BrickletIO16.FUNCTION_SET_PORT_MONOFLOP = 10
  • BrickletIO16.FUNCTION_SET_SELECTED_VALUES = 13
  • BrickletIO16.FUNCTION_SET_EDGE_COUNT_CONFIG = 15
void BrickletIO16.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:

  • BrickletIO16.FUNCTION_SET_PORT = 1
  • BrickletIO16.FUNCTION_SET_PORT_CONFIGURATION = 3
  • BrickletIO16.FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIO16.FUNCTION_SET_PORT_INTERRUPT = 7
  • BrickletIO16.FUNCTION_SET_PORT_MONOFLOP = 10
  • BrickletIO16.FUNCTION_SET_SELECTED_VALUES = 13
  • BrickletIO16.FUNCTION_SET_EDGE_COUNT_CONFIG = 15
void BrickletIO16.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.

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

Konfigurationsfunktionen für Callbacks

void BrickletIO16.setDebouncePeriod(long debounce)
Parameter:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Entprellperiode der InterruptCallback Callback.

Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das IO-16 Bricklet angeschlossen ist, wie z.B. eine Taste.

long BrickletIO16.getDebouncePeriod()
Rückgabe:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

void BrickletIO16.setPortInterrupt(char port, short interruptMask)
Parameter:
  • port – Typ: char
  • interruptMask – Typ: short, Wertebereich: [0 bis 255]

Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.

Beispiel: ('a', 129) bzw. ('a', 0b10000001) aktiviert den Interrupt für die Pins 0 und 7 des Ports a.

Der Interrupt wird mit dem InterruptCallback Callback zugestellt.

short BrickletIO16.getPortInterrupt(char port)
Parameter:
  • port – Typ: char
Rückgabe:
  • interruptMask – Typ: short, Wertebereich: [0 bis 255]

Gibt die Interrupt Bitmaske für den angegebenen Port zurück, wie von setPortInterrupt() gesetzt.

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 BrickletIO16.InterruptCallback
Event-Objekt:
  • port – Typ: char
  • interruptMask – Typ: short, Wertebereich: [0 bis 255]
  • valueMask – Typ: short, Wertebereich: [0 bis 255]

Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit setPortInterrupt() aktiviert wurde.

Die Rückgabewerte sind der Port, eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände des Ports.

Beispiele:

  • ('a', 1, 1) bzw. ('a', 0b00000001, 0b00000001) bedeutet, dass an Port A ein Interrupt am Pin 0 aufgetreten ist und aktuell ist Pin 0 logisch 1 und die Pins 1-7 sind logisch 0.
  • ('b', 129, 254) bzw. ('b', 0b10000001, 0b11111110) bedeutet, dass an Port B Interrupts an den Pins 0 und 7 aufgetreten sind und aktuell ist Pin 0 logisch 0 und die Pins 1-7 sind logisch 1.

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

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

callback BrickletIO16.MonoflopDoneCallback
Event-Objekt:
  • port – Typ: char
  • selectionMask – Typ: short, Wertebereich: [0 bis 255]
  • valueMask – Typ: short, Wertebereich: [0 bis 255]

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Port, die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).

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

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

Konstanten

int BrickletIO16.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein IO-16 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 BrickletIO16.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IO-16 Bricklet dar.