MATLAB/Octave - UV Light Bricklet 2.0¶

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

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletUVLightV2;

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

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

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

    % Register UV index callback to function cb_uvi
    set(uvl, 'UVICallback', @(h, e) cb_uvi(e));

    % Set period for UVI callback to 1s (1000ms) without a threshold
    uvl.setUVICallbackConfiguration(1000, false, 'x', 0, 0);

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

% Callback function for UV index callback
function cb_uvi(e)
    fprintf('UV Index: %g\n', e.uvi/10.0);
end

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
22
23
24
25
26
27
28
29

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletUVLightV2;

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

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

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

    % Get current UV-A
    uva = uvl.getUVA();
    fprintf('UV-A: %g mW/m²\n', uva/10.0);

    % Get current UV-B
    uvb = uvl.getUVB();
    fprintf('UV-B: %g mW/m²\n', uvb/10.0);

    % Get current UV index
    uvi = uvl.getUVI();
    fprintf('UV Index: %g\n', uvi/10.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
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

function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletUVLightV2;

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

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

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

    % Register UV index callback to function cb_uvi
    set(uvl, 'UVICallback', @(h, e) cb_uvi(e));

    % Configure threshold for UV index "greater than 3"
    % with a debounce period of 1s (1000ms)
    uvl.setUVICallbackConfiguration(1000, false, '>', 3*10, 0);

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

% Callback function for UV index callback
function cb_uvi(e)
    fprintf('UV Index: %g\n', e.uvi/10.0);
    fprintf('UV index > 3. Use sunscreen!\n');
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

function octave_example_callback()
    more off;

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

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

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

    % Register UV index callback to function cb_uvi
    uvl.addUVICallback(@cb_uvi);

    % Set period for UVI callback to 1s (1000ms) without a threshold
    uvl.setUVICallbackConfiguration(1000, false, "x", 0, 0);

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

% Callback function for UV index callback
function cb_uvi(e)
    fprintf("UV Index: %g\n", e.uvi/10.0);
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 2.0

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

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

    % Get current UV-A
    uva = uvl.getUVA();
    fprintf("UV-A: %g mW/m²\n", uva/10.0);

    % Get current UV-B
    uvb = uvl.getUVB();
    fprintf("UV-B: %g mW/m²\n", uvb/10.0);

    % Get current UV index
    uvi = uvl.getUVI();
    fprintf("UV Index: %g\n", uvi/10.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
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

function octave_example_threshold()
    more off;

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

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

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

    % Register UV index callback to function cb_uvi
    uvl.addUVICallback(@cb_uvi);

    % Configure threshold for UV index "greater than 3"
    % with a debounce period of 1s (1000ms)
    uvl.setUVICallbackConfiguration(1000, false, ">", 3*10, 0);

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

% Callback function for UV index callback
function cb_uvi(e)
    fprintf("UV Index: %g\n", e.uvi/10.0);
    fprintf("UV index > 3. Use sunscreen!\n");
end

Grundfunktionen¶

class BrickletUVLightV2(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	uvLightV2 – Typ: BrickletUVLightV2

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

In MATLAB:

import com.tinkerforge.BrickletUVLightV2;

uvLightV2 = BrickletUVLightV2("YOUR_DEVICE_UID", ipcon);

In Octave:

uvLightV2 = java_new("com.tinkerforge.BrickletUVLightV2", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletUVLightV2.getUVA()¶

Rückgabe:	uva – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-1 bis 231 - 1]

Gibt die UVA Intensität des Sensors zurück. Der Sensor hat die Intensität nicht mit dem Erythem-Wirkungsspektrum gewichtet, daher handelt es sich nicht um die hautbeeinflussende Bestrahlungsstärke. Der Wert kann nicht einfach durch 250 geteilt werden, um den UVA Index zu bestimmen. Um den UV Index zu bestimmen kann getUVI() verwendet werden.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe setConfiguration().

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

Wenn der Wert periodisch benötigt wird, kann auch der UVACallback Callback verwendet werden. Der Callback wird mit der Funktion setUVACallbackConfiguration() konfiguriert.

int BrickletUVLightV2.getUVB()¶

Rückgabe:	uvb – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-1 bis 231 - 1]

Gibt die UVB Intensität des Sensors zurück. Der Sensor hat die Intensität nicht mit dem Erythem-Wirkungsspektrum gewichtet, daher handelt es sich nicht um die hautbeeinflussende Bestrahlungsstärke. Der Wert kann nicht einfach durch 250 geteilt werde, um den UVB Index zu bestimmen. Um den UV Index zu bestimmen kann getUVI() verwendet werden.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe setConfiguration().

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

Wenn der Wert periodisch benötigt wird, kann auch der UVBCallback Callback verwendet werden. Der Callback wird mit der Funktion setUVBCallbackConfiguration() konfiguriert.

int BrickletUVLightV2.getUVI()¶

Rückgabe:	uvi – Typ: int, Einheit: 1/10 , Wertebereich: [-1 bis 231 - 1]

Gibt den UV Index des Sensors in 1/10 zurück.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe setConfiguration().

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

Wenn der Wert periodisch benötigt wird, kann auch der UVICallback Callback verwendet werden. Der Callback wird mit der Funktion setUVICallbackConfiguration() konfiguriert.

Fortgeschrittene Funktionen¶

void BrickletUVLightV2.setConfiguration(int integrationTime)¶

Parameter:	integrationTime – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration des Sensors. Die Integrationszeit kann zwischen 50 und 800 ms eingestellt werden. Mit einer kürzeren Integrationszeit wird der Sensorwert öfter aktualisiert, beinhaltet aber mehr Rauschen. Mit einer längeren Integrationszeit wird das Rauschen verringert aber der Sensorwert wird nicht so oft aktualisiert.

Mit einer längeren Integrationszeit (ins besondere 800 ms) und einer höheren UV Intensität kann der Sensor gesättigt (saturated) sein. Falls dies auftritt dann sind die UVA/UVB/UVI Messwerte alle -1. In diesem Fall muss eine kürzere Integrationszeit gewählt werden.

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

Für integrationTime:

• BrickletUVLightV2.INTEGRATION_TIME_50MS = 0
• BrickletUVLightV2.INTEGRATION_TIME_100MS = 1
• BrickletUVLightV2.INTEGRATION_TIME_200MS = 2
• BrickletUVLightV2.INTEGRATION_TIME_400MS = 3
• BrickletUVLightV2.INTEGRATION_TIME_800MS = 4

int BrickletUVLightV2.getConfiguration()¶

Rückgabe:	integrationTime – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von setConfiguration() gesetzt.

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

Für integrationTime:

• BrickletUVLightV2.INTEGRATION_TIME_50MS = 0
• BrickletUVLightV2.INTEGRATION_TIME_100MS = 1
• BrickletUVLightV2.INTEGRATION_TIME_200MS = 2
• BrickletUVLightV2.INTEGRATION_TIME_400MS = 3
• BrickletUVLightV2.INTEGRATION_TIME_800MS = 4

BrickletUVLightV2.SPITFPErrorCount BrickletUVLightV2.getSPITFPErrorCount()¶

Rückgabeobjekt:	errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

• ACK-Checksummen Fehler,
• Message-Checksummen Fehler,
• Framing Fehler und
• Overflow Fehler.

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.

void BrickletUVLightV2.setStatusLEDConfig(int config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

• BrickletUVLightV2.STATUS_LED_CONFIG_OFF = 0
• BrickletUVLightV2.STATUS_LED_CONFIG_ON = 1
• BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletUVLightV2.getStatusLEDConfig()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

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

Für config:

• BrickletUVLightV2.STATUS_LED_CONFIG_OFF = 0
• BrickletUVLightV2.STATUS_LED_CONFIG_ON = 1
• BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletUVLightV2.getChipTemperature()¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

void BrickletUVLightV2.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.

BrickletUVLightV2.Identity BrickletUVLightV2.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 BrickletUVLightV2.setUVACallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

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

Die Periode ist die Periode mit der der UVACallback 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den UVACallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

BrickletUVLightV2.UVACallbackConfiguration BrickletUVLightV2.getUVACallbackConfiguration()¶

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

Gibt die Callback-Konfiguration zurück, wie mittels setUVACallbackConfiguration() gesetzt.

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

Für option:

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

void BrickletUVLightV2.setUVBCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

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

Die Periode ist die Periode mit der der UVBCallback 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den UVBCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

BrickletUVLightV2.UVBCallbackConfiguration BrickletUVLightV2.getUVBCallbackConfiguration()¶

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

Gibt die Callback-Konfiguration zurück, wie mittels setUVBCallbackConfiguration() gesetzt.

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

Für option:

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

void BrickletUVLightV2.setUVICallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 , Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 , Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der UVICallback 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den UVICallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

BrickletUVLightV2.UVICallbackConfiguration BrickletUVLightV2.getUVICallbackConfiguration()¶

Rückgabeobjekt:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 , Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 , Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels setUVICallbackConfiguration() gesetzt.

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

Für option:

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

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 BrickletUVLightV2.UVACallback¶

Event-Objekt:	uva – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-1 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setUVACallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getUVA().

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addUVACallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeUVACallback() wieder entfernt werden.

callback BrickletUVLightV2.UVBCallback¶

Event-Objekt:	uvb – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-1 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setUVBCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getUVB().

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addUVBCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeUVBCallback() wieder entfernt werden.

callback BrickletUVLightV2.UVICallback¶

Event-Objekt:	uvi – Typ: int, Einheit: 1/10 , Wertebereich: [-1 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setUVICallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getUVI().

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addUVICallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeUVICallback() 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[] BrickletUVLightV2.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 BrickletUVLightV2.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:

• BrickletUVLightV2.FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
• BrickletUVLightV2.FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
• BrickletUVLightV2.FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
• BrickletUVLightV2.FUNCTION_SET_CONFIGURATION = 13
• BrickletUVLightV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletUVLightV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletUVLightV2.FUNCTION_RESET = 243
• BrickletUVLightV2.FUNCTION_WRITE_UID = 248

void BrickletUVLightV2.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:

• BrickletUVLightV2.FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
• BrickletUVLightV2.FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
• BrickletUVLightV2.FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
• BrickletUVLightV2.FUNCTION_SET_CONFIGURATION = 13
• BrickletUVLightV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletUVLightV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletUVLightV2.FUNCTION_RESET = 243
• BrickletUVLightV2.FUNCTION_WRITE_UID = 248

void BrickletUVLightV2.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.

Interne Funktionen¶

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.

int BrickletUVLightV2.setBootloaderMode(int mode)¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

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:

• BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletUVLightV2.BOOTLOADER_STATUS_OK = 0
• BrickletUVLightV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletUVLightV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletUVLightV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletUVLightV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletUVLightV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletUVLightV2.getBootloaderMode()¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für mode:

• BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletUVLightV2.setWriteFirmwarePointer(long pointer)¶

Parameter:	pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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.

int BrickletUVLightV2.writeFirmware(int[] data)¶

Parameter:	data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

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.

void BrickletUVLightV2.writeUID(long uid)¶

Parameter:	uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

long BrickletUVLightV2.readUID()¶

Rückgabe:	uid – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

int BrickletUVLightV2.DEVICE_IDENTIFIER¶

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

Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet 2.0 dar.