Java - UV Light Bricklet¶

Simple¶

Download (ExampleSimple.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletUVLight;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your UV Light Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletUVLight uvl = new 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
        long uvLight = uvl.getUVLight(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("UV Light: " + uvLight/10.0 + " mW/m²");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback¶

Download (ExampleCallback.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletUVLight;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your UV Light Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletUVLight uvl = new BrickletUVLight(UID, ipcon); // Create device object

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

        // Add UV light listener
        uvl.addUVLightListener(new BrickletUVLight.UVLightListener() {
            public void uvLight(long uvLight) {
                System.out.println("UV Light: " + uvLight/10.0 + " mW/m²");
            }
        });

        // 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);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Threshold¶

Download (ExampleThreshold.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletUVLight;

public class ExampleThreshold {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your UV Light Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletUVLight uvl = new 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);

        // Add UV light reached listener
        uvl.addUVLightReachedListener(new BrickletUVLight.UVLightReachedListener() {
            public void uvLightReached(long uvLight) {
                System.out.println("UV Light: " + uvLight/10.0 + " mW/m²");
                System.out.println("UV Index > 3. Use sunscreen!");
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

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:

BrickletUVLight uvLight = new 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 UVLightListener Listener 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 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: 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 Listener¶

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 UVLightListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

Der UVLightListener Listener 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 UVLightReachedListener Listener.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Listener ist inaktiv
'o'	Listener wird ausgelöst, wenn die Intensität außerhalb des min und max Wertes ist
'i'	Listener wird ausgelöst, wenn die Intensität innerhalb des min und max Wertes ist
'<'	Listener wird ausgelöst, wenn die Intensität kleiner als der min Wert ist (max wird ignoriert)
'>'	Listener 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 Listeners

• UVLightReachedListener,

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.

Listener¶

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickletUVLight.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

class BrickletUVLight.UVLightListener()¶

Dieser Listener kann mit der Funktion addUVLightListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeUVLightListener() wieder entfernt werden.

void uvLight(long uvLight)

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

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

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

class BrickletUVLight.UVLightReachedListener()¶

Dieser Listener kann mit der Funktion addUVLightReachedListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeUVLightReachedListener() wieder entfernt werden.

void uvLightReached(long uvLight)

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

Dieser Listener 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 Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

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 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: 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 Listeners 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 Listeners (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 Listeners 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.EnumerateListener Listener 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.