MATLAB/Octave - Dust Detector Bricklet

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Dust Detector Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dust Detector Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

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

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Dust Detector Bricklet

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

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

    % Get current dust density
    dustDensity = dd.getDustDensity();
    fprintf('Dust Density: %i µg/m³\n', dustDensity);

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

Callback (MATLAB)

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

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Dust Detector Bricklet

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

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

    % Register dust density callback to function cb_dust_density
    set(dd, 'DustDensityCallback', @(h, e) cb_dust_density(e));

    % Set period for dust density callback to 1s (1000ms)
    % Note: The dust density callback is only called every second
    %       if the dust density has changed since the last call!
    dd.setDustDensityCallbackPeriod(1000);

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

% Callback function for dust density callback
function cb_dust_density(e)
    fprintf('Dust Density: %i µg/m³\n', e.dustDensity);
end

Threshold (MATLAB)

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
function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletDustDetector;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Dust Detector Bricklet

    ipcon = IPConnection(); % Create IP connection
    dd = handle(BrickletDustDetector(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)
    dd.setDebouncePeriod(10000);

    % Register dust density reached callback to function cb_dust_density_reached
    set(dd, 'DustDensityReachedCallback', @(h, e) cb_dust_density_reached(e));

    % Configure threshold for dust density "greater than 10 µg/m³"
    dd.setDustDensityCallbackThreshold('>', 10, 0);

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

% Callback function for dust density reached callback
function cb_dust_density_reached(e)
    fprintf('Dust Density: %i µg/m³\n', e.dustDensity);
end

Simple (Octave)

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 Dust Detector Bricklet

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

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

    % Get current dust density
    dustDensity = dd.getDustDensity();
    fprintf("Dust Density: %d µg/m³\n", dustDensity);

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

Callback (Octave)

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 Dust Detector Bricklet

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

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

    % Register dust density callback to function cb_dust_density
    dd.addDustDensityCallback(@cb_dust_density);

    % Set period for dust density callback to 1s (1000ms)
    % Note: The dust density callback is only called every second
    %       if the dust density has changed since the last call!
    dd.setDustDensityCallbackPeriod(1000);

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

% Callback function for dust density callback
function cb_dust_density(e)
    fprintf("Dust Density: %d µg/m³\n", e.dustDensity);
end

Threshold (Octave)

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
function octave_example_threshold()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Dust Detector Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    dd = javaObject("com.tinkerforge.BrickletDustDetector", 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)
    dd.setDebouncePeriod(10000);

    % Register dust density reached callback to function cb_dust_density_reached
    dd.addDustDensityReachedCallback(@cb_dust_density_reached);

    % Configure threshold for dust density "greater than 10 µg/m³"
    dd.setDustDensityCallbackThreshold(">", 10, 0);

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

% Callback function for dust density reached callback
function cb_dust_density_reached(e)
    fprintf("Dust Density: %d µg/m³\n", e.dustDensity);
end

API

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.

Grundfunktionen

class BrickletDustDetector(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • dustDetector – Typ: BrickletDustDetector

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

In MATLAB:

import com.tinkerforge.BrickletDustDetector;

dustDetector = BrickletDustDetector("YOUR_DEVICE_UID", ipcon);

In Octave:

dustDetector = java_new("com.tinkerforge.BrickletDustDetector", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

int BrickletDustDetector.getDustDensity()
Rückgabe:
  • dustDensity – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Gibt die Staubdichte zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den DustDensityCallback Callback zu nutzen und die Periode mit setDustDensityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

void BrickletDustDetector.setMovingAverage(short average)
Parameter:
  • average – Typ: short, Wertebereich: [0 bis 100], Standardwert: 100

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

short BrickletDustDetector.getMovingAverage()
Rückgabe:
  • average – Typ: short, Wertebereich: [0 bis 100], Standardwert: 100

Gibt die Länge des gleitenden Mittelwerts zurück, wie von setMovingAverage() gesetzt.

BrickletDustDetector.Identity BrickletDustDetector.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', 'i', '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 '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.

Konfigurationsfunktionen für Callbacks

void BrickletDustDetector.setDustDensityCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der DustDensityCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der DustDensityCallback Callback wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

long BrickletDustDetector.getDustDensityCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setDustDensityCallbackPeriod() gesetzt.

void BrickletDustDetector.setDustDensityCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den DustDensityReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Staubdichte außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Staubdichte innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Staubdichte kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Staubdichte größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletDustDetector.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDustDetector.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDustDetector.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDustDetector.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDustDetector.THRESHOLD_OPTION_GREATER = '>'
BrickletDustDetector.DustDensityCallbackThreshold BrickletDustDetector.getDustDensityCallbackThreshold()
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von setDustDensityCallbackThreshold() gesetzt.

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

Für option:

  • BrickletDustDetector.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDustDetector.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDustDetector.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDustDetector.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDustDetector.THRESHOLD_OPTION_GREATER = '>'
void BrickletDustDetector.setDebouncePeriod(long debounce)
Parameter:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

long BrickletDustDetector.getDebouncePeriod()
Rückgabe:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() 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.

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.

callback BrickletDustDetector.DustDensityCallback
Event-Objekt:
  • dustDensity – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Dieser Callback wird mit der Periode, wie gesetzt mit setDustDensityCallbackPeriod(), ausgelöst. Der Parameter ist die Staubdichte des Sensors.

Der DustDensityCallback Callback wird nur ausgelöst, wenn sich die Staubdichte 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 addDustDensityCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeDustDensityCallback() wieder entfernt werden.

callback BrickletDustDetector.DustDensityReachedCallback
Event-Objekt:
  • dustDensity – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setDustDensityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Staubdichte 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 addDustDensityReachedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeDustDensityReachedCallback() 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[] BrickletDustDetector.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 BrickletDustDetector.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BrickletDustDetector.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDustDetector.FUNCTION_SET_MOVING_AVERAGE = 10
void BrickletDustDetector.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BrickletDustDetector.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDustDetector.FUNCTION_SET_MOVING_AVERAGE = 10
void BrickletDustDetector.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.

Konstanten

int BrickletDustDetector.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Dust Detector 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.

String BrickletDustDetector.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Dust Detector Bricklet dar.