MATLAB/Octave - UV Light Bricklet¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1function matlab_example_simple()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletUVLight;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your UV Light Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    uvl = handle(BrickletUVLight(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 UV light
16    uvLight = uvl.getUVLight();
17    fprintf('UV Light: %g mW/m²\n', uvLight/10.0);
18
19    input('Press key to exit\n', 's');
20    ipcon.disconnect();
21end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 1function matlab_example_callback()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletUVLight;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your UV Light Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    uvl = handle(BrickletUVLight(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 UV light callback to function cb_uv_light
16    set(uvl, 'UVLightCallback', @(h, e) cb_uv_light(e));
17
18    % Set period for UV light callback to 1s (1000ms)
19    % Note: The UV light callback is only called every second
20    %       if the UV light has changed since the last call!
21    uvl.setUVLightCallbackPeriod(1000);
22
23    input('Press key to exit\n', 's');
24    ipcon.disconnect();
25end
26
27% Callback function for UV light callback
28function cb_uv_light(e)
29    fprintf('UV Light: %g mW/m²\n', e.uvLight/10.0);
30end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

 1function matlab_example_threshold()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletUVLight;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your UV Light Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    uvl = handle(BrickletUVLight(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    uvl.setDebouncePeriod(10000);
17
18    % Register UV light reached callback to function cb_uv_light_reached
19    set(uvl, 'UVLightReachedCallback', @(h, e) cb_uv_light_reached(e));
20
21    % Configure threshold for UV light "greater than 75 mW/m²"
22    uvl.setUVLightCallbackThreshold('>', 75*10, 0);
23
24    input('Press key to exit\n', 's');
25    ipcon.disconnect();
26end
27
28% Callback function for UV light reached callback
29function cb_uv_light_reached(e)
30    fprintf('UV Light: %g mW/m²\n', e.uvLight/10.0);
31    fprintf('UV Index > 3. Use sunscreen!\n');
32end

Simple (Octave)¶

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 UV Light Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    uvl = javaObject("com.tinkerforge.BrickletUVLight", 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 UV light
15    uvLight = uvl.getUVLight();
16    fprintf("UV Light: %g mW/m²\n", java2int(uvLight)/10.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

Callback (Octave)¶

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 UV Light Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    uvl = javaObject("com.tinkerforge.BrickletUVLight", 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 UV light callback to function cb_uv_light
15    uvl.addUVLightCallback(@cb_uv_light);
16
17    % Set period for UV light callback to 1s (1000ms)
18    % Note: The UV light callback is only called every second
19    %       if the UV light has changed since the last call!
20    uvl.setUVLightCallbackPeriod(1000);
21
22    input("Press key to exit\n", "s");
23    ipcon.disconnect();
24end
25
26% Callback function for UV light callback
27function cb_uv_light(e)
28    fprintf("UV Light: %g mW/m²\n", java2int(e.uvLight)/10.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

Threshold (Octave)¶

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 UV Light Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    uvl = javaObject("com.tinkerforge.BrickletUVLight", 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    uvl.setDebouncePeriod(10000);
16
17    % Register UV light reached callback to function cb_uv_light_reached
18    uvl.addUVLightReachedCallback(@cb_uv_light_reached);
19
20    % Configure threshold for UV light "greater than 75 mW/m²"
21    uvl.setUVLightCallbackThreshold(">", 75*10, 0);
22
23    input("Press key to exit\n", "s");
24    ipcon.disconnect();
25end
26
27% Callback function for UV light reached callback
28function cb_uv_light_reached(e)
29    fprintf("UV Light: %g mW/m²\n", java2int(e.uvLight)/10.0);
30    fprintf("UV Index > 3. Use sunscreen!\n");
31end
32
33function int = java2int(value)
34    if compare_versions(version(), "3.8", "<=")
35        int = value.intValue();
36    else
37        int = value;
38    end
39end

Grundfunktionen¶

class BrickletUVLight(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	uvLight – Typ: BrickletUVLight

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.

long BrickletUVLight.getUVLight()¶

Rückgabe:	uvLight – Typ: long, Einheit: 1/10 mW/m², Wertebereich: [0 bis 3280]

Gibt die UV-Licht-Intensität des Sensors zurück. 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¶

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

Konfigurationsfunktionen für Callbacks¶

void BrickletUVLight.setUVLightCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode 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.

long BrickletUVLight.getUVLightCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletUVLight.setUVLightCallbackThreshold(char option, long min, long max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: long, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0 max – Typ: long, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0

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)

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

Für option:

• BrickletUVLight.THRESHOLD_OPTION_OFF = 'x'

• BrickletUVLight.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletUVLight.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletUVLight.THRESHOLD_OPTION_SMALLER = '<'

• BrickletUVLight.THRESHOLD_OPTION_GREATER = '>'

BrickletUVLight.UVLightCallbackThreshold BrickletUVLight.getUVLightCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: long, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0 max – Typ: long, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Für option:

• BrickletUVLight.THRESHOLD_OPTION_OFF = 'x'

• BrickletUVLight.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletUVLight.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletUVLight.THRESHOLD_OPTION_SMALLER = '<'

• BrickletUVLight.THRESHOLD_OPTION_GREATER = '>'

void BrickletUVLight.setDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

• UVLightReachedCallback,

ausgelöst werden, wenn die Schwellwerte

• setUVLightCallbackThreshold(),

weiterhin erreicht bleiben.

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

callback BrickletUVLight.UVLightCallback¶

Event-Objekt:	uvLight – Typ: long, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000]

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 werden. Eine hinzugefügter Callback-Function kann mit removeUVLightCallback() wieder entfernt werden.

callback BrickletUVLight.UVLightReachedCallback¶

Event-Objekt:	uvLight – Typ: long, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000]

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 werden. Eine hinzugefügter Callback-Function kann mit removeUVLightReachedCallback() 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[] BrickletUVLight.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 BrickletUVLight.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, 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:

• BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2

• BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4

• BrickletUVLight.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletUVLight.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, 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:

• BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2

• BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4

• BrickletUVLight.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletUVLight.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 BrickletUVLight.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein UV Light 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 BrickletUVLight.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet dar.