Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Current12 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Current12 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.BrickletCurrent12;
4
5 HOST = 'localhost';
6 PORT = 4223;
7 UID = 'XYZ'; % Change XYZ to the UID of your Current12 Bricklet
8
9 ipcon = IPConnection(); % Create IP connection
10 c = handle(BrickletCurrent12(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
16 current = c.getCurrent();
17 fprintf('Current: %g A\n', current/1000.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.BrickletCurrent12;
4
5 HOST = 'localhost';
6 PORT = 4223;
7 UID = 'XYZ'; % Change XYZ to the UID of your Current12 Bricklet
8
9 ipcon = IPConnection(); % Create IP connection
10 c = handle(BrickletCurrent12(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(c, 'CurrentCallback', @(h, e) cb_current(e));
17
18 % Set period for current callback to 1s (1000ms)
19 % Note: The current callback is only called every second
20 % if the current has changed since the last call!
21 c.setCurrentCallbackPeriod(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('Current: %g A\n', e.current/1000.0);
30end
Download (matlab_example_threshold.m)
1function matlab_example_threshold()
2 import com.tinkerforge.IPConnection;
3 import com.tinkerforge.BrickletCurrent12;
4
5 HOST = 'localhost';
6 PORT = 4223;
7 UID = 'XYZ'; % Change XYZ to the UID of your Current12 Bricklet
8
9 ipcon = IPConnection(); % Create IP connection
10 c = handle(BrickletCurrent12(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 c.setDebouncePeriod(10000);
17
18 % Register current reached callback to function cb_current_reached
19 set(c, 'CurrentReachedCallback', @(h, e) cb_current_reached(e));
20
21 % Configure threshold for current "greater than 5 A"
22 c.setCurrentCallbackThreshold('>', 5*1000, 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('Current: %g A\n', e.current/1000.0);
31end
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 Current12 Bricklet
7
8 ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
9 c = javaObject("com.tinkerforge.BrickletCurrent12", 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
15 current = c.getCurrent();
16 fprintf("Current: %g A\n", java2int(current)/1000.0);
17
18 input("Press key to exit\n", "s");
19 ipcon.disconnect();
20end
21
22function int = java2int(value)
23 if compare_versions(version(), "3.8", "<=")
24 int = value.intValue();
25 else
26 int = value;
27 end
28end
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 Current12 Bricklet
7
8 ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
9 c = javaObject("com.tinkerforge.BrickletCurrent12", 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 c.addCurrentCallback(@cb_current);
16
17 % Set period for current callback to 1s (1000ms)
18 % Note: The current callback is only called every second
19 % if the current has changed since the last call!
20 c.setCurrentCallbackPeriod(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("Current: %g A\n", java2int(e.current)/1000.0);
29end
30
31function int = java2int(value)
32 if compare_versions(version(), "3.8", "<=")
33 int = value.intValue();
34 else
35 int = value;
36 end
37end
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 Current12 Bricklet
7
8 ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
9 c = javaObject("com.tinkerforge.BrickletCurrent12", 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 c.setDebouncePeriod(10000);
16
17 % Register current reached callback to function cb_current_reached
18 c.addCurrentReachedCallback(@cb_current_reached);
19
20 % Configure threshold for current "greater than 5 A"
21 c.setCurrentCallbackThreshold(">", 5*1000, 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("Current: %g A\n", java2int(e.current)/1000.0);
30end
31
32function int = java2int(value)
33 if compare_versions(version(), "3.8", "<=")
34 int = value.intValue();
35 else
36 int = value;
37 end
38end
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.BrickletCurrent12;
current12 = BrickletCurrent12("YOUR_DEVICE_UID", ipcon);
In Octave:
current12 = java_new("com.tinkerforge.BrickletCurrent12", "YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Rückgabe: |
|
|---|
Gibt die gemessenen Stromstärke des Sensors zurück.
Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen
den CurrentCallback Callback zu nutzen und die Periode mit
setCurrentCallbackPeriod() vorzugeben.
Kalibriert den Nullwert des Sensors. Diese Funktion muss aufgerufen werden, wenn kein Strom fließt.
Der Nullwert des Stromsensors ist abhängig von den exakten Eigenschaften des Analog-Digital-Wandlers, der Länge des Bricklet Kabels und der Temperatur. Daher ist es, bei Wechsel des Brick oder bei Veränderung der Umgebung in welcher das Bricklet genutzt wird, ratsam erneut zu kalibrieren.
Die resultierende Kalibrierung wird in den EEPROM des Current Bricklet gespeichert.
| Rückgabe: |
|
|---|
Gibt true zurück wenn mehr als 12,5A gemessen wurden.
Bemerkung
Um diesen Wert zurückzusetzen ist ein Aus- und Wiedereinschalten des Bricklet notwendig.
| Rückgabe: |
|
|---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von getCurrent() zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen
den AnalogValueCallback Callback zu nutzen und die Periode mit
setAnalogValueCallbackPeriod() vorzugeben.
| 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 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.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von setCurrentCallbackPeriod() gesetzt.
| Parameter: |
|
|---|
Setzt die Periode mit welcher der AnalogValueCallback Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert seit der
letzten Auslösung geändert hat.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von setAnalogValueCallbackPeriod() gesetzt.
| Parameter: |
|
|---|
Setzt den Schwellwert für den CurrentReachedCallback Callback.
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:
BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'
| Rückgabeobjekt: |
|
|---|
Gibt den Schwellwert zurück, wie von setCurrentCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|
Setzt den Schwellwert für den AnalogValueReachedCallback Callback.
Die folgenden Optionen sind möglich:
Option |
Beschreibung |
|---|---|
'x' |
Callback ist inaktiv |
'o' |
Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist |
'i' |
Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist |
'<' |
Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' |
Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'
| Rückgabeobjekt: |
|
|---|
Gibt den Schwellwert zurück, wie von setAnalogValueCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletCurrent12.THRESHOLD_OPTION_OFF = 'x'
BrickletCurrent12.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletCurrent12.THRESHOLD_OPTION_INSIDE = 'i'
BrickletCurrent12.THRESHOLD_OPTION_SMALLER = '<'
BrickletCurrent12.THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
| 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 mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(),
ausgelöst. Der Parameter ist der Analogwert des Umgebungslichtsensors.
Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert 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 addAnalogValueCallback() eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeAnalogValueCallback() 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.
| Event-Objekt: |
|
|---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
setAnalogValueCallbackThreshold() gesetzt, erreicht wird.
Der Parameter ist der Analogwert 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 addAnalogValueReachedCallback() eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeAnalogValueReachedCallback() wieder entfernt werden.
| Event-Objekt: |
|
|---|
Dieser Callback wird ausgelöst, wenn ein Überstrom gemessen wurde
(siehe isOverCurrent()).
In MATLAB kann die set() Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addOverCurrentCallback() eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeOverCurrentCallback() 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:
BrickletCurrent12.FUNCTION_CALIBRATE = 2
BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
BrickletCurrent12.FUNCTION_SET_DEBOUNCE_PERIOD = 13
| 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:
BrickletCurrent12.FUNCTION_CALIBRATE = 2
BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
BrickletCurrent12.FUNCTION_SET_DEBOUNCE_PERIOD = 13
| 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 Current12 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 Current12 Bricklet dar.