MATLAB/Octave - UV Light Bricklet

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das UV Light Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des UV Light 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.BrickletUVLight;

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

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

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

    % Get current UV light
    uvLight = uvl.getUVLight();
    fprintf('UV Light: %g mW/m²\n', uvLight/10.0);

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

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

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

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

    % Register UV light callback to function cb_uv_light
    set(uvl, 'UVLightCallback', @(h, e) cb_uv_light(e));

    % Set period for UV light callback to 1s (1000ms)
    % Note: The UV light callback is only called every second
    %       if the UV light has changed since the last call!
    uvl.setUVLightCallbackPeriod(1000);

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

% Callback function for UV light callback
function cb_uv_light(e)
    fprintf('UV Light: %g mW/m²\n', e.uvLight/10.0);
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
32
function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletUVLight;

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

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

    % Register UV light reached callback to function cb_uv_light_reached
    set(uvl, 'UVLightReachedCallback', @(h, e) cb_uv_light_reached(e));

    % Configure threshold for UV light "greater than 75 mW/m²"
    uvl.setUVLightCallbackThreshold('>', 75*10, 0);

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

% Callback function for UV light reached callback
function cb_uv_light_reached(e)
    fprintf('UV Light: %g mW/m²\n', e.uvLight/10.0);
    fprintf('UV Index > 3. Use sunscreen!\n');
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
21
22
23
24
25
26
27
28
function octave_example_simple()
    more off;

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

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

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

    % Get current UV light
    uvLight = uvl.getUVLight();
    fprintf("UV Light: %g mW/m²\n", java2int(uvLight)/10.0);

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

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
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
30
31
32
33
34
35
36
37
function octave_example_callback()
    more off;

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

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

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

    % Register UV light callback to function cb_uv_light
    uvl.addUVLightCallback(@cb_uv_light);

    % Set period for UV light callback to 1s (1000ms)
    % Note: The UV light callback is only called every second
    %       if the UV light has changed since the last call!
    uvl.setUVLightCallbackPeriod(1000);

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

% Callback function for UV light callback
function cb_uv_light(e)
    fprintf("UV Light: %g mW/m²\n", java2int(e.uvLight)/10.0);
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
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
31
32
33
34
35
36
37
38
39
function octave_example_threshold()
    more off;

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

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

    % Register UV light reached callback to function cb_uv_light_reached
    uvl.addUVLightReachedCallback(@cb_uv_light_reached);

    % Configure threshold for UV light "greater than 75 mW/m²"
    uvl.setUVLightCallbackThreshold(">", 75*10, 0);

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

% Callback function for UV light reached callback
function cb_uv_light_reached(e)
    fprintf("UV Light: %g mW/m²\n", java2int(e.uvLight)/10.0);
    fprintf("UV Index > 3. Use sunscreen!\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
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

public class BrickletUVLight(String uid, IPConnection ipcon)

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

In MATLAB:

import com.tinkerforge.BrickletUVLight;

uvLight = BrickletUVLight("YOUR_DEVICE_UID", ipcon);

In Octave:

uvLight = java_new("com.tinkerforge.BrickletUVLight", "YOUR_DEVICE_UID", ipcon);

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

public long getUVLight()

Gibt die UV-Licht-Intensität des Sensors zurück. Die Intensität wird in der Einheit 1/10 mW/m² gegeben. Der Sensor hat die Intensität bereits mit dem Erythem-Wirkungsspektrum gewichtet, um die hautbeeinflussende Bestrahlungsstärke zu bestimmen.

Die Intensität kann dann einfach durch 250 geteilt werden um den UV Index zu bestimmen. Beispiel: Eine UV-Licht-Intensität von 500 entspricht einem UV Index von 2.

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den UVLightCallback Callback zu nutzen und die Periode mit setUVLightCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

public short[] getAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) 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.

public boolean getResponseExpected(short functionId)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(short functionId, boolean responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2
  • BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4
  • BrickletUVLight.FUNCTION_SET_DEBOUNCE_PERIOD = 6
public void setResponseExpectedAll(boolean responseExpected)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

public BrickletUVLight.Identity getIdentity()

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Callbacks

public void setUVLightCallbackPeriod(long period)

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

Der UVLightCallback Callback wird nur ausgelöst wenn sich die Intensität seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

public long getUVLightCallbackPeriod()

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

public void setUVLightCallbackThreshold(char option, long min, long max)

Setzt den Schwellwert für den UVLightReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

  • BrickletUVLight.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLight.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLight.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLight.THRESHOLD_OPTION_GREATER = '>'
public BrickletUVLight.UVLightCallbackThreshold getUVLightCallbackThreshold()

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

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

  • BrickletUVLight.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLight.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLight.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLight.THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, long min und long max.

public void setDebouncePeriod(long debounce)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

public long getDebouncePeriod()

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.

public callback BrickletUVLight.UVLightCallback
Parameter:uvLight -- long

Dieser Callback wird mit der Periode, wie gesetzt mit setUVLightCallbackPeriod(), ausgelöst. Der Parameter ist die UV-Licht-Intensität des Sensors.

Der UVLightCallback Callback wird nur ausgelöst wenn sich die Intensität 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 addUVLightCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeUVLightCallback() wieder entfernt werden.

public callback BrickletUVLight.UVLightReachedCallback
Parameter:uvLight -- long

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von setUVLightCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die UV-Licht-Intensität 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 addUVLightReachedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeUVLightReachedCallback() wieder entfernt werden.

Konstanten

public static final int BrickletUVLight.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein UV Light Bricklet zu identifizieren.

Die getIdentity() Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

public static final String BrickletUVLight.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet dar.