MATLAB/Octave - IO-4 Bricklet 2.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
22
23
24
25

function matlab_example_input()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletIO4V2;

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

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

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

    % Get current value
    value = io.getValue();

    fprintf('Channel 0: %i\n', value(1));
    fprintf('Channel 1: %i\n', value(2));
    fprintf('Channel 2: %i\n', value(3));
    fprintf('Channel 3: %i\n', value(4));

    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
24
25
26
27
28

function matlab_example_output()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletIO4V2;

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

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

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

    % Configure channel 3 as output low
    io.setConfiguration(3, 'o', false);

    % Set channel 3 alternating high/low 10 times with 100 ms delay
    for i = 0:9
        pause(0.1);
        io.setSelectedValue(3, true);
        pause(0.1);
        io.setSelectedValue(3, false);
    end

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

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

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

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

    % Register input value callback to function cb_input_value
    set(io, 'InputValueCallback', @(h, e) cb_input_value(e));

    % Set period for input value (channel 1) callback to 0.5s (500ms)
    io.setInputValueCallbackConfiguration(1, 500, false);

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

% Callback function for input value callback
function cb_input_value(e)
    fprintf('Channel: %i\n', e.channel);
    fprintf('Changed: %i\n', e.changed);
    fprintf('Value: %i\n', e.value);
    fprintf('\n');
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

function octave_example_input()
    more off;

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

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

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

    % Get current value
    value = io.getValue();

    fprintf("Channel 0: %d\n", value(1));
    fprintf("Channel 1: %d\n", value(2));
    fprintf("Channel 2: %d\n", value(3));
    fprintf("Channel 3: %d\n", value(4));

    input("Press key to exit\n", "s");
    ipcon.disconnect();
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
23
24
25
26
27

function octave_example_output()
    more off;

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

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

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

    % Configure channel 3 as output low
    io.setConfiguration(3, "o", false);

    % Set channel 3 alternating high/low 10 times with 100 ms delay
    for i = 0:9
        pause(0.1);
        io.setSelectedValue(3, true);
        pause(0.1);
        io.setSelectedValue(3, false);
    end

    input("Press key to exit\n", "s");
    ipcon.disconnect();
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

function octave_example_interrupt()
    more off;

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

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

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

    % Register input value callback to function cb_input_value
    io.addInputValueCallback(@cb_input_value);

    % Set period for input value (channel 1) callback to 0.5s (500ms)
    io.setInputValueCallbackConfiguration(1, 500, false);

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

% Callback function for input value callback
function cb_input_value(e)
    fprintf("Channel: %d\n", e.channel);
    fprintf("Changed: %d\n", e.changed);
    fprintf("Value: %d\n", e.value);
    fprintf("\n");
end

Grundfunktionen¶

class BrickletIO4V2(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	io4V2 – Typ: BrickletIO4V2

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

In MATLAB:

import com.tinkerforge.BrickletIO4V2;

io4V2 = BrickletIO4V2("YOUR_DEVICE_UID", ipcon);

In Octave:

io4V2 = java_new("com.tinkerforge.BrickletIO4V2", "YOUR_DEVICE_UID", ipcon);

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

void BrickletIO4V2.setValue(boolean[] value)¶

Parameter:	value – Typ: boolean[], Länge: 4

Setzt den Zustand aller vier Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.

Mit der Funktionen setSelectedValue() können einzelnen Kanäle gesetzt werden.

Beispiel: (True, True, False, False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-3 auf logisch 0.

Alle laufenden Monoflop Timer und PWMs werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

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

boolean[] BrickletIO4V2.getValue()¶

Rückgabe:	value – Typ: boolean[], Länge: 4

Gibt die aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Kanäle zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

void BrickletIO4V2.setSelectedValue(int channel, boolean value)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3] value – Typ: boolean

Setzt den Ausgabewert des ausgewählte Kanals ohne die anderen Kanäle zu beeinflussen.

Ein laufender Monoflop Timer oder PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

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

void BrickletIO4V2.setConfiguration(int channel, char direction, boolean value)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3] direction – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'i' value – Typ: boolean, Standardwert: true

Konfiguriert den Zustand und die Richtung eines angegebenen Kanals. 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:

• (0, 'i', true) setzt Kanal 0 als Eingang mit Pull-Up.
• (1, 'i', false) setzt Kanal 1 als Standard Eingang (potentialfrei wenn nicht verbunden).
• (2, 'o', true) setzt Kanal 2 als Ausgang im Zustand logisch 1.
• (3, 'o', false) setzt Kanal 3 als Ausgang im Zustand logisch 0.

Ein laufender Monoflop Timer oder PWM für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

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

Für direction:

• BrickletIO4V2.DIRECTION_IN = 'i'
• BrickletIO4V2.DIRECTION_OUT = 'o'

BrickletIO4V2.Configuration BrickletIO4V2.getConfiguration(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3]
Rückgabeobjekt:	direction – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'i' value – Typ: boolean, Standardwert: true

Gibt die Kanal-Konfiguration zurück, wie von setConfiguration() gesetzt.

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

Für direction:

• BrickletIO4V2.DIRECTION_IN = 'i'
• BrickletIO4V2.DIRECTION_OUT = 'o'

Fortgeschrittene Funktionen¶

void BrickletIO4V2.setMonoflop(int channel, boolean value, long time)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3] value – Typ: boolean time – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit dar, in welcher der Kanal den Zustand halten soll.

Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Der Kanal wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-4 Bricklet 2.0 ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Kanal wird die gesamte Zeit eingeschaltet sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden ausschalten.

BrickletIO4V2.Monoflop BrickletIO4V2.getMonoflop(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3]
Rückgabeobjekt:	value – Typ: boolean time – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] timeRemaining – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

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

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

long BrickletIO4V2.getEdgeCount(int channel, boolean resetCounter)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3] 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 Kanal zurück. Die zu zählenden Flanken können mit setEdgeCountConfiguration() konfiguriert werden.

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

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

void BrickletIO4V2.setEdgeCountConfiguration(int channel, int edgeType, int debounce)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3] edgeType – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

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

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

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.

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

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

Für edgeType:

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

BrickletIO4V2.EdgeCountConfiguration BrickletIO4V2.getEdgeCountConfiguration(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3]
Rückgabeobjekt:	edgeType – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanal zurück, wie von setEdgeCountConfiguration() gesetzt.

Bemerkung

Aufrufen dieser Funktion ist nur für Kanäle erlaubt, die als Eingang konfiguriert sind.

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

Für edgeType:

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

void BrickletIO4V2.setPWMConfiguration(int channel, long frequency, int dutyCycle)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3] frequency – Typ: long, Einheit: 1/10 Hz, Wertebereich: [0 bis 320000000], Standardwert: 0 dutyCycle – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 10000], Standardwert: 0

Aktiviert ein PWM auf dem angegebenen Kanal.

Bevor diese Funktion aufgerufen wird, muss der Kanal als Ausgabe konfiguriert werden, ansonsten wird ein "invalid parameter"-Fehler gemeldet. Um die PWM wieder auszustellen, kann die Frequenz auf 0 gesetzt werden oder eine andere Funktion aufgerufen werden die Einstellungen am Kanal verändert (z.B. setSelectedValue()).

Ein laufender Monoflop Timer für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

BrickletIO4V2.PWMConfiguration BrickletIO4V2.getPWMConfiguration(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3]
Rückgabeobjekt:	frequency – Typ: long, Einheit: 1/10 Hz, Wertebereich: [0 bis 320000000], Standardwert: 0 dutyCycle – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 10000], Standardwert: 0

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

BrickletIO4V2.SPITFPErrorCount BrickletIO4V2.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.

void BrickletIO4V2.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:

• BrickletIO4V2.STATUS_LED_CONFIG_OFF = 0
• BrickletIO4V2.STATUS_LED_CONFIG_ON = 1
• BrickletIO4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIO4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletIO4V2.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:

• BrickletIO4V2.STATUS_LED_CONFIG_OFF = 0
• BrickletIO4V2.STATUS_LED_CONFIG_ON = 1
• BrickletIO4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIO4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletIO4V2.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 BrickletIO4V2.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.

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

Konfigurationsfunktionen für Callbacks¶

void BrickletIO4V2.setInputValueCallbackConfiguration(int channel, long period, boolean valueHasToChange)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3] period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der InputValueCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIO4V2.InputValueCallbackConfiguration BrickletIO4V2.getInputValueCallbackConfiguration(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 3]
Rückgabeobjekt:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels setInputValueCallbackConfiguration() gesetzt.

void BrickletIO4V2.setAllInputValueCallbackConfiguration(long period, boolean valueHasToChange)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

Die Periode ist die Periode mit der der AllInputValueCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIO4V2.AllInputValueCallbackConfiguration BrickletIO4V2.getAllInputValueCallbackConfiguration()¶

Rückgabeobjekt:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels setAllInputValueCallbackConfiguration() 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.

callback BrickletIO4V2.InputValueCallback¶

Event-Objekt:	channel – Typ: int, Wertebereich: [0 bis 3] changed – Typ: boolean value – Typ: boolean

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setInputValueCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

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

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

callback BrickletIO4V2.AllInputValueCallback¶

Event-Objekt:	changed – Typ: boolean[], Länge: 4 value – Typ: boolean[], Länge: 4

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setAllInputValueCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der gleiche wie getValue(). Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

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

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

callback BrickletIO4V2.MonoflopDoneCallback¶

Event-Objekt:	channel – Typ: int, Wertebereich: [0 bis 3] value – Typ: boolean

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Kanal und den aktuellen Zustand des Kanals (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 werden. Eine hinzugefügter Callback-Function kann mit removeMonoflopDoneCallback() 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[] BrickletIO4V2.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 BrickletIO4V2.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:

• BrickletIO4V2.FUNCTION_SET_VALUE = 1
• BrickletIO4V2.FUNCTION_SET_SELECTED_VALUE = 3
• BrickletIO4V2.FUNCTION_SET_CONFIGURATION = 4
• BrickletIO4V2.FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
• BrickletIO4V2.FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
• BrickletIO4V2.FUNCTION_SET_MONOFLOP = 10
• BrickletIO4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
• BrickletIO4V2.FUNCTION_SET_PWM_CONFIGURATION = 15
• BrickletIO4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIO4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIO4V2.FUNCTION_RESET = 243
• BrickletIO4V2.FUNCTION_WRITE_UID = 248

void BrickletIO4V2.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:

• BrickletIO4V2.FUNCTION_SET_VALUE = 1
• BrickletIO4V2.FUNCTION_SET_SELECTED_VALUE = 3
• BrickletIO4V2.FUNCTION_SET_CONFIGURATION = 4
• BrickletIO4V2.FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
• BrickletIO4V2.FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
• BrickletIO4V2.FUNCTION_SET_MONOFLOP = 10
• BrickletIO4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
• BrickletIO4V2.FUNCTION_SET_PWM_CONFIGURATION = 15
• BrickletIO4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIO4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIO4V2.FUNCTION_RESET = 243
• BrickletIO4V2.FUNCTION_WRITE_UID = 248

void BrickletIO4V2.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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int BrickletIO4V2.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:

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

Für status:

• BrickletIO4V2.BOOTLOADER_STATUS_OK = 0
• BrickletIO4V2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletIO4V2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletIO4V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletIO4V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletIO4V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletIO4V2.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:

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

void BrickletIO4V2.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 BrickletIO4V2.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 BrickletIO4V2.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 BrickletIO4V2.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.

Konstanten¶

int BrickletIO4V2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein IO-4 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 BrickletIO4V2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines IO-4 Bricklet 2.0 dar.