Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Industrial Dual 0-20mA Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (matlab_example_simple.m)
1function matlab_example_simple()
2 import com.tinkerforge.IPConnection;
3 import com.tinkerforge.BrickletIndustrialDual020mA;
4
5 HOST = 'localhost';
6 PORT = 4223;
7 UID = 'XYZ'; % Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
8
9 ipcon = IPConnection(); % Create IP connection
10 id020 = handle(BrickletIndustrialDual020mA(UID, ipcon), 'CallbackProperties'); % Create device object
11
12 ipcon.connect(HOST, PORT); % Connect to brickd
13 % Don't use device before ipcon is connected
14
15 % Get current current from sensor 1
16 current = id020.getCurrent(1);
17 fprintf('Current (Sensor 1): %g mA\n', current/1000000.0);
18
19 input('Press key to exit\n', 's');
20 ipcon.disconnect();
21end
Download (matlab_example_callback.m)
1function matlab_example_callback()
2 import com.tinkerforge.IPConnection;
3 import com.tinkerforge.BrickletIndustrialDual020mA;
4
5 HOST = 'localhost';
6 PORT = 4223;
7 UID = 'XYZ'; % Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
8
9 ipcon = IPConnection(); % Create IP connection
10 id020 = handle(BrickletIndustrialDual020mA(UID, ipcon), 'CallbackProperties'); % Create device object
11
12 ipcon.connect(HOST, PORT); % Connect to brickd
13 % Don't use device before ipcon is connected
14
15 % Register current callback to function cb_current
16 set(id020, 'CurrentCallback', @(h, e) cb_current(e));
17
18 % Set period for current (sensor 1) callback to 1s (1000ms)
19 % Note: The current (sensor 1) callback is only called every second
20 % if the current (sensor 1) has changed since the last call!
21 id020.setCurrentCallbackPeriod(1, 1000);
22
23 input('Press key to exit\n', 's');
24 ipcon.disconnect();
25end
26
27% Callback function for current callback
28function cb_current(e)
29 fprintf('Sensor: %i\n', e.sensor);
30 fprintf('Current: %g mA\n', e.current/1000000.0);
31 fprintf('\n');
32end
Download (matlab_example_threshold.m)
1function matlab_example_threshold()
2 import com.tinkerforge.IPConnection;
3 import com.tinkerforge.BrickletIndustrialDual020mA;
4
5 HOST = 'localhost';
6 PORT = 4223;
7 UID = 'XYZ'; % Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
8
9 ipcon = IPConnection(); % Create IP connection
10 id020 = handle(BrickletIndustrialDual020mA(UID, ipcon), 'CallbackProperties'); % Create device object
11
12 ipcon.connect(HOST, PORT); % Connect to brickd
13 % Don't use device before ipcon is connected
14
15 % Get threshold callbacks with a debounce time of 10 seconds (10000ms)
16 id020.setDebouncePeriod(10000);
17
18 % Register current reached callback to function cb_current_reached
19 set(id020, 'CurrentReachedCallback', @(h, e) cb_current_reached(e));
20
21 % Configure threshold for current (sensor 1) "greater than 10 mA"
22 id020.setCurrentCallbackThreshold(1, '>', 10*1000000, 0);
23
24 input('Press key to exit\n', 's');
25 ipcon.disconnect();
26end
27
28% Callback function for current reached callback
29function cb_current_reached(e)
30 fprintf('Sensor: %i\n', e.sensor);
31 fprintf('Current: %g mA\n', e.current/1000000.0);
32 fprintf('\n');
33end
Download (octave_example_simple.m)
1function octave_example_simple()
2 more off;
3
4 HOST = "localhost";
5 PORT = 4223;
6 UID = "XYZ"; % Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
7
8 ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
9 id020 = javaObject("com.tinkerforge.BrickletIndustrialDual020mA", UID, ipcon); % Create device object
10
11 ipcon.connect(HOST, PORT); % Connect to brickd
12 % Don't use device before ipcon is connected
13
14 % Get current current from sensor 1
15 current = id020.getCurrent(1);
16 fprintf("Current (Sensor 1): %g mA\n", current/1000000.0);
17
18 input("Press key to exit\n", "s");
19 ipcon.disconnect();
20end
Download (octave_example_callback.m)
1function octave_example_callback()
2 more off;
3
4 HOST = "localhost";
5 PORT = 4223;
6 UID = "XYZ"; % Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
7
8 ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
9 id020 = javaObject("com.tinkerforge.BrickletIndustrialDual020mA", UID, ipcon); % Create device object
10
11 ipcon.connect(HOST, PORT); % Connect to brickd
12 % Don't use device before ipcon is connected
13
14 % Register current callback to function cb_current
15 id020.addCurrentCallback(@cb_current);
16
17 % Set period for current (sensor 1) callback to 1s (1000ms)
18 % Note: The current (sensor 1) callback is only called every second
19 % if the current (sensor 1) has changed since the last call!
20 id020.setCurrentCallbackPeriod(1, 1000);
21
22 input("Press key to exit\n", "s");
23 ipcon.disconnect();
24end
25
26% Callback function for current callback
27function cb_current(e)
28 fprintf("Sensor: %d\n", java2int(e.sensor));
29 fprintf("Current: %g mA\n", e.current/1000000.0);
30 fprintf("\n");
31end
32
33function int = java2int(value)
34 if compare_versions(version(), "3.8", "<=")
35 int = value.intValue();
36 else
37 int = value;
38 end
39end
Download (octave_example_threshold.m)
1function octave_example_threshold()
2 more off;
3
4 HOST = "localhost";
5 PORT = 4223;
6 UID = "XYZ"; % Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet
7
8 ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
9 id020 = javaObject("com.tinkerforge.BrickletIndustrialDual020mA", UID, ipcon); % Create device object
10
11 ipcon.connect(HOST, PORT); % Connect to brickd
12 % Don't use device before ipcon is connected
13
14 % Get threshold callbacks with a debounce time of 10 seconds (10000ms)
15 id020.setDebouncePeriod(10000);
16
17 % Register current reached callback to function cb_current_reached
18 id020.addCurrentReachedCallback(@cb_current_reached);
19
20 % Configure threshold for current (sensor 1) "greater than 10 mA"
21 id020.setCurrentCallbackThreshold(1, ">", 10*1000000, 0);
22
23 input("Press key to exit\n", "s");
24 ipcon.disconnect();
25end
26
27% Callback function for current reached callback
28function cb_current_reached(e)
29 fprintf("Sensor: %d\n", java2int(e.sensor));
30 fprintf("Current: %g mA\n", e.current/1000000.0);
31 fprintf("\n");
32end
33
34function int = java2int(value)
35 if compare_versions(version(), "3.8", "<=")
36 int = value.intValue();
37 else
38 int = value;
39 end
40end
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.
In MATLAB:
import com.tinkerforge.BrickletIndustrialDual020mA;
industrialDual020mA = BrickletIndustrialDual020mA("YOUR_DEVICE_UID", ipcon);
In Octave:
industrialDual020mA = java_new("com.tinkerforge.BrickletIndustrialDual020mA", "YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt die gemessenen Stromstärke des angegebenen Sensors zurück.
Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.
Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.
Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen
den CurrentCallback Callback zu nutzen und die Periode mit
setCurrentCallbackPeriod() vorzugeben.
| Parameter: |
|
|---|
Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.
Wert |
Beschreibung |
|---|---|
0 |
240 Samples pro Sekunde, 12 Bit Auflösung |
1 |
60 Samples pro Sekunde, 14 Bit Auflösung |
2 |
15 Samples pro Sekunde, 16 Bit Auflösung |
3 |
4 Samples pro Sekunde, 18 Bit Auflösung |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3
| Rückgabe: |
|
|---|
Gibt die Abtastrate zurück, wie von setSampleRate() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3
| Rückgabeobjekt: |
|
|---|
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.
| Parameter: |
|
|---|
Setzt die Periode mit welcher der CurrentCallback Callback für den
übergebenen Sensor ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der CurrentCallback Callback wird nur ausgelöst, wenn sich die Stromstärke seit der
letzten Auslösung geändert hat.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt die Periode zurück, wie von setCurrentCallbackPeriod() gesetzt.
| Parameter: |
|
|---|
Setzt den Schwellwert des CurrentReachedCallback Callbacks für den übergebenen
Sensor.
Die folgenden Optionen sind möglich:
Option |
Beschreibung |
|---|---|
'x' |
Callback ist inaktiv |
'o' |
Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist |
'i' |
Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist |
'<' |
Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert) |
'>' |
Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletIndustrialDual020mA.THRESHOLD_OPTION_OFF = 'x'
BrickletIndustrialDual020mA.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletIndustrialDual020mA.THRESHOLD_OPTION_INSIDE = 'i'
BrickletIndustrialDual020mA.THRESHOLD_OPTION_SMALLER = '<'
BrickletIndustrialDual020mA.THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|---|
| Rückgabeobjekt: |
|
Gibt den Schwellwert zurück, wie von setCurrentCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletIndustrialDual020mA.THRESHOLD_OPTION_OFF = 'x'
BrickletIndustrialDual020mA.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletIndustrialDual020mA.THRESHOLD_OPTION_INSIDE = 'i'
BrickletIndustrialDual020mA.THRESHOLD_OPTION_SMALLER = '<'
BrickletIndustrialDual020mA.THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|
Setzt die Periode mit welcher der Schwellwert Callback
ausgelöst werden, wenn der Schwellwert
weiterhin erreicht bleibt.
| Rückgabe: |
|
|---|
Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.
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.
| Event-Objekt: |
|
|---|
Dieser Callback wird mit der Periode, wie gesetzt mit setCurrentCallbackPeriod(),
ausgelöst. Der Parameter ist die Stromstärke des Sensors.
Der CurrentCallback Callback wird nur ausgelöst, wenn sich die Stromstärke seit der
letzten Auslösung geändert hat.
In MATLAB kann die set() Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addCurrentCallback() eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeCurrentCallback() wieder entfernt werden.
| Event-Objekt: |
|
|---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
setCurrentCallbackThreshold() gesetzt, erreicht wird.
Der Parameter ist die Stromstärke des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit setDebouncePeriod() gesetzt, ausgelöst.
In MATLAB kann die set() Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addCurrentReachedCallback() eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeCurrentReachedCallback() wieder entfernt werden.
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.
| Rückgabeobjekt: |
|
|---|
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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:
BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8
| Parameter: |
|
|---|
Ä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:
BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein Industrial Dual 0-20mA 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.
Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet dar.