Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Humidity Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Humidity 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)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | function matlab_example_simple()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletHumidity;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Humidity Bricklet
ipcon = IPConnection(); % Create IP connection
h = handle(BrickletHumidity(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current humidity
humidity = h.getHumidity();
fprintf('Humidity: %g %%RH\n', humidity/10.0);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
|
Download (matlab_example_callback.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 matlab_example_callback()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletHumidity;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Humidity Bricklet
ipcon = IPConnection(); % Create IP connection
h = handle(BrickletHumidity(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register humidity callback to function cb_humidity
set(h, 'HumidityCallback', @(h, e) cb_humidity(e));
% Set period for humidity callback to 1s (1000ms)
% Note: The humidity callback is only called every second
% if the humidity has changed since the last call!
h.setHumidityCallbackPeriod(1000);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for humidity callback
function cb_humidity(e)
fprintf('Humidity: %g %%RH\n', e.humidity/10.0);
end
|
Download (matlab_example_threshold.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 | function matlab_example_threshold()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletHumidity;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Humidity Bricklet
ipcon = IPConnection(); % Create IP connection
h = handle(BrickletHumidity(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get threshold callbacks with a debounce time of 10 seconds (10000ms)
h.setDebouncePeriod(10000);
% Register humidity reached callback to function cb_humidity_reached
set(h, 'HumidityReachedCallback', @(h, e) cb_humidity_reached(e));
% Configure threshold for humidity "outside of 30 to 60 %RH"
h.setHumidityCallbackThreshold('o', 30*10, 60*10);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for humidity reached callback
function cb_humidity_reached(e)
fprintf('Humidity: %g %%RH\n', e.humidity/10.0);
fprintf('Recommended humidity for human comfort is 30 to 60 %%RH.\n');
end
|
Download (octave_example_simple.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | function octave_example_simple()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Humidity Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
h = javaObject("com.tinkerforge.BrickletHumidity", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current humidity
humidity = h.getHumidity();
fprintf("Humidity: %g %%RH\n", humidity/10.0);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
|
Download (octave_example_callback.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 | function octave_example_callback()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Humidity Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
h = javaObject("com.tinkerforge.BrickletHumidity", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register humidity callback to function cb_humidity
h.addHumidityCallback(@cb_humidity);
% Set period for humidity callback to 1s (1000ms)
% Note: The humidity callback is only called every second
% if the humidity has changed since the last call!
h.setHumidityCallbackPeriod(1000);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for humidity callback
function cb_humidity(e)
fprintf("Humidity: %g %%RH\n", e.humidity/10.0);
end
|
Download (octave_example_threshold.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 octave_example_threshold()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Humidity Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
h = javaObject("com.tinkerforge.BrickletHumidity", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get threshold callbacks with a debounce time of 10 seconds (10000ms)
h.setDebouncePeriod(10000);
% Register humidity reached callback to function cb_humidity_reached
h.addHumidityReachedCallback(@cb_humidity_reached);
% Configure threshold for humidity "outside of 30 to 60 %RH"
h.setHumidityCallbackThreshold("o", 30*10, 60*10);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for humidity reached callback
function cb_humidity_reached(e)
fprintf("Humidity: %g %%RH\n", e.humidity/10.0);
fprintf("Recommended humidity for human comfort is 30 to 60 %%RH.\n");
end
|
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.BrickletHumidity;
humidity = BrickletHumidity("YOUR_DEVICE_UID", ipcon);
In Octave:
humidity = java_new("com.tinkerforge.BrickletHumidity", "YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).
Rückgabe: |
|
---|
Gibt die gemessene Luftfeuchtigkeit des Sensors zurück.
Wenn die Luftfeuchtigkeit periodisch abgefragt werden soll, wird empfohlen den HumidityCallback Callback zu nutzen und die Periode mit setHumidityCallbackPeriod() vorzugeben.
Rückgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von getHumidity() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der zurückgegebene Luftfeuchtigkeitswert ist auf Raumtemperatur kalibriert, d.h. wenn der Sensor in sehr kalten oder warmen Umgebungen verwendet wird, ist es ratsam den Luftfeuchtigkeitswert direkt aus den Analogwerten zu berechnen. Siehe hierzu das HIH 5030 Datenblatt.
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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
Parameter: |
|
---|
Setzt die Periode mit welcher der HumidityCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der HumidityCallback Callback wird nur ausgelöst, wenn sich die Luftfeuchtigkeit seit der letzten Auslösung geändert hat.
Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setHumidityCallbackPeriod() 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 HumidityReachedCallback Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Luftfeuchtigkeit außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Luftfeuchtigkeit innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Luftfeuchtigkeit kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Luftfeuchtigkeit größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setHumidityCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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:
Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setAnalogValueCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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 setHumidityCallbackPeriod(), ausgelöst. Der Parameter ist die Luftfeuchtigkeit des Sensors.
Der HumidityCallback Callback wird nur ausgelöst, wenn sich die Luftfeuchtigkeit 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 addHumidityCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeHumidityCallback() wieder entfernt werden.
Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Sensors.
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 werde. Eine hinzugefügter Callback-Function kann mit removeAnalogValueCallback() wieder entfernt werden.
Event-Objekt: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setHumidityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Luftfeuchtigkeit 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 addHumidityReachedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeHumidityReachedCallback() 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 werde. Eine hinzugefügter Callback-Function kann mit removeAnalogValueReachedCallback() 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:
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:
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 Humidity 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 Humidity Bricklet dar.