Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Particulate Matter Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Particulate Matter 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 22 23 24 | function matlab_example_simple()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletParticulateMatter;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Particulate Matter Bricklet
ipcon = IPConnection(); % Create IP connection
pm = handle(BrickletParticulateMatter(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current PM concentration
pmConcentration = pm.getPMConcentration();
fprintf('PM 1.0: %i µg/m³\n', pmConcentration.pm10);
fprintf('PM 2.5: %i µg/m³\n', pmConcentration.pm25);
fprintf('PM 10.0: %i µg/m³\n', pmConcentration.pm100);
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 31 | function matlab_example_callback()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletParticulateMatter;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Particulate Matter Bricklet
ipcon = IPConnection(); % Create IP connection
pm = handle(BrickletParticulateMatter(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register PM concentration callback to function cb_pm_concentration
set(pm, 'PMConcentrationCallback', @(h, e) cb_pm_concentration(e));
% Set period for PM concentration callback to 1s (1000ms)
pm.setPMConcentrationCallbackConfiguration(1000, false);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for PM concentration callback
function cb_pm_concentration(e)
fprintf('PM 1.0: %i µg/m³\n', e.pm10);
fprintf('PM 2.5: %i µg/m³\n', e.pm25);
fprintf('PM 10.0: %i µg/m³\n', e.pm100);
fprintf('\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 21 22 23 | function octave_example_simple()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Particulate Matter Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
pm = javaObject("com.tinkerforge.BrickletParticulateMatter", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current PM concentration
pmConcentration = pm.getPMConcentration();
fprintf("PM 1.0: %d µg/m³\n", pmConcentration.pm10);
fprintf("PM 2.5: %d µg/m³\n", pmConcentration.pm25);
fprintf("PM 10.0: %d µg/m³\n", pmConcentration.pm100);
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 30 | function octave_example_callback()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Particulate Matter Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
pm = javaObject("com.tinkerforge.BrickletParticulateMatter", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register PM concentration callback to function cb_pm_concentration
pm.addPMConcentrationCallback(@cb_pm_concentration);
% Set period for PM concentration callback to 1s (1000ms)
pm.setPMConcentrationCallbackConfiguration(1000, false);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for PM concentration callback
function cb_pm_concentration(e)
fprintf("PM 1.0: %d µg/m³\n", e.pm10);
fprintf("PM 2.5: %d µg/m³\n", e.pm25);
fprintf("PM 10.0: %d µg/m³\n", e.pm100);
fprintf("\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.
BrickletParticulateMatter
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
.
In MATLAB:
import com.tinkerforge.BrickletParticulateMatter;
particulateMatter = BrickletParticulateMatter("YOUR_DEVICE_UID", ipcon);
In Octave:
particulateMatter = java_new("com.tinkerforge.BrickletParticulateMatter", "YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletParticulateMatter.
getPMConcentration
()¶Rückgabeobjekt: |
|
---|
Gibt die Feinstaub-Konzentration zurück, aufgeschlüsselt nach:
Wenn der Sensor deaktiviert ist (siehe setEnable()
), dann wird weiterhin
der letzte Sensorwert zurückgegeben.
Wenn die Werte periodisch benötigt werden, kann auch der PMConcentrationCallback
Callback
verwendet werden. Der Callback wird mit der Funktion
setPMConcentrationCallbackConfiguration()
konfiguriert.
BrickletParticulateMatter.
getPMCount
()¶Rückgabeobjekt: |
|
---|
Gibt die Anzahl der Feinstaub-Teilchen in 100ml Luft zurück, aufgeschlüsselt nach deren Durchmesser:
Wenn der Sensor deaktiviert ist (siehe setEnable()
), dann wird weiterhin
der letzte Sensorwert zurückgegeben.
Wenn die Werte periodisch benötigt werden, kann auch der PMCountCallback
Callback
verwendet werden. Der Callback wird mit der Funktion
setPMCountCallbackConfiguration()
konfiguriert.
BrickletParticulateMatter.
setEnable
(boolean enable)¶Parameter: |
|
---|
Aktiviert/deaktiviert den Lüfter und die Laserdiode des Sensors.
Der Sensor benötigt ca. 30 Sekunden nach der Aktivierung um sich einzuschwingen und stabile Werte zu produzieren.
Die Lebensdauer der Laserdiode beträgt ca. 8000 Stunden. Wenn Messungen in größeren Abständen stattfinden sollen (z.B. stündlich) lohnt es sich die Laserdiode zwischen den Messungen auszumachen.
BrickletParticulateMatter.
getEnable
()¶Rückgabe: |
|
---|
Gibt den Zustand des Sensors zurück, wie von setEnable()
gesetzt.
BrickletParticulateMatter.
getSensorInfo
()¶Rückgabeobjekt: |
|
---|
Gibt Informationen über den Sensor zurück:
BrickletParticulateMatter.
getSPITFPErrorCount
()¶Rückgabeobjekt: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
BrickletParticulateMatter.
setStatusLEDConfig
(int config)¶Parameter: |
|
---|
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:
BrickletParticulateMatter.
getStatusLEDConfig
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von setStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletParticulateMatter.
getChipTemperature
()¶Rückgabe: |
|
---|
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.
BrickletParticulateMatter.
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.
BrickletParticulateMatter.
getIdentity
()¶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.
BrickletParticulateMatter.
setPMConcentrationCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der PMConcentrationCallback
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.
BrickletParticulateMatter.
getPMConcentrationCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
setPMConcentrationCallbackConfiguration()
gesetzt.
BrickletParticulateMatter.
setPMCountCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der PMCountCallback
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.
BrickletParticulateMatter.
getPMCountCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
setPMCountCallbackConfiguration()
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.
BrickletParticulateMatter.
PMConcentrationCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
setPMConcentrationCallbackConfiguration()
gesetzten Konfiguration
Die Parameter sind der gleiche wie getPMConcentration()
.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addPMConcentrationCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removePMConcentrationCallback()
wieder entfernt werden.
BrickletParticulateMatter.
PMCountCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
setPMCountCallbackConfiguration()
gesetzten Konfiguration
Die Parameter sind der gleiche wie getPMCount()
.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addPMCountCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removePMCountCallback()
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.
BrickletParticulateMatter.
getAPIVersion
()¶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.
BrickletParticulateMatter.
getResponseExpected
(byte functionId)¶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:
BrickletParticulateMatter.
setResponseExpected
(byte functionId, boolean responseExpected)¶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:
BrickletParticulateMatter.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
BrickletParticulateMatter.
setBootloaderMode
(int mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
Für status:
BrickletParticulateMatter.
getBootloaderMode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletParticulateMatter.
setWriteFirmwarePointer
(long pointer)¶Parameter: |
|
---|
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.
BrickletParticulateMatter.
writeFirmware
(int[] data)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickletParticulateMatter.
writeUID
(long uid)¶Parameter: |
|
---|
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.
BrickletParticulateMatter.
readUID
()¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletParticulateMatter.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Particulate Matter 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.
BrickletParticulateMatter.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Particulate Matter Bricklet dar.