Java - Ambient Light Bricklet 2.0¶

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

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

    // Change XYZ to the UID of your Ambient Light Bricklet 2.0
    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
        BrickletAmbientLightV2 al = new BrickletAmbientLightV2(UID, ipcon); // Create device object

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

        // Get current illuminance
        long illuminance = al.getIlluminance(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Illuminance: " + illuminance/100.0 + " lx");

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

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

    // Change XYZ to the UID of your Ambient Light Bricklet 2.0
    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
        BrickletAmbientLightV2 al = new BrickletAmbientLightV2(UID, ipcon); // Create device object

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

        // Add illuminance listener
        al.addIlluminanceListener(new BrickletAmbientLightV2.IlluminanceListener() {
            public void illuminance(long illuminance) {
                System.out.println("Illuminance: " + illuminance/100.0 + " lx");
            }
        });

        // Set period for illuminance callback to 1s (1000ms)
        // Note: The illuminance callback is only called every second
        //       if the illuminance has changed since the last call!
        al.setIlluminanceCallbackPeriod(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.BrickletAmbientLightV2;

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

    // Change XYZ to the UID of your Ambient Light Bricklet 2.0
    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
        BrickletAmbientLightV2 al = new BrickletAmbientLightV2(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)
        al.setDebouncePeriod(10000);

        // Add illuminance reached listener
        al.addIlluminanceReachedListener(new BrickletAmbientLightV2.IlluminanceReachedListener() {
            public void illuminanceReached(long illuminance) {
                System.out.println("Illuminance: " + illuminance/100.0 + " lx");
                System.out.println("Too bright, close the curtains!");
            }
        });

        // Configure threshold for illuminance "greater than 500 lx"
        al.setIlluminanceCallbackThreshold('>', 500*100, 0);

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

Grundfunktionen¶

class BrickletAmbientLightV2(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	ambientLightV2 – Typ: BrickletAmbientLightV2

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

BrickletAmbientLightV2 ambientLightV2 = new BrickletAmbientLightV2("YOUR_DEVICE_UID", ipcon);

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

long BrickletAmbientLightV2.getIlluminance()¶

Rückgabe:	illuminance – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Geändert in Version 2.0.2 (Plugin): Eine Beleuchtungsstärke von 0Lux bedeutet eine Ausnahmesituation in der der Sensor keine sinnvolle Messung durchführen kann. Dies kann bei sehr schwacher oder sehr starker Beleuchtung auftreten. Bei starker Beleuchtung bedeutet diese möglicherweise, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte (setConfiguration()), um besser der Beleuchtung zu entsprechen.

Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen den IlluminanceListener Listener zu nutzen und die Periode mit setIlluminanceCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

void BrickletAmbientLightV2.setConfiguration(short illuminanceRange, short integrationTime)¶

Parameter:	illuminanceRange – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3 integrationTime – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration. Es ist möglich den Helligkeitswertebereich zwischen 0-600Lux und 0-64000Lux sowie eine Integrationszeit zwischen 50ms und 400ms zu konfigurieren.

Neu in Version 2.0.2 (Plugin): Der unbeschränkt (unlimited) Helligkeitswertebereich ermöglicht es bis über 100000Lux zu messen, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Ein kleinerer Helligkeitswertebereich erhöht die Auflösung der Daten. Eine längere Integrationszeit verringert das Rauschen auf den Daten.

Geändert in Version 2.0.2 (Plugin): Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben getIlluminance() und der IlluminanceListener Listener das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

Geändert in Version 2.0.2 (Plugin): Bei einer langen Integrationszeit kann es sein, dass der Sensor gesättigt (saturated) ist bevor der Messwert das Maximum des ausgewählten Helligkeitswertebereichs erreicht hat. In diesem Fall geben getIlluminance() und der IlluminanceListener Listener 0Lux zurück.

Wenn der Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt oder der Sensor gesättigt ist, dann sollte der nächst höhere Helligkeitswertebereich eingestellt werden. Wenn der höchste Helligkeitswertebereich schon erreicht ist, dann kann noch die Integrationszeit verringert werden.

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

Für illuminanceRange:

• BrickletAmbientLightV2.ILLUMINANCE_RANGE_UNLIMITED = 6
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_64000LUX = 0
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_32000LUX = 1
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_16000LUX = 2
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_8000LUX = 3
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_1300LUX = 4
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_600LUX = 5

Für integrationTime:

• BrickletAmbientLightV2.INTEGRATION_TIME_50MS = 0
• BrickletAmbientLightV2.INTEGRATION_TIME_100MS = 1
• BrickletAmbientLightV2.INTEGRATION_TIME_150MS = 2
• BrickletAmbientLightV2.INTEGRATION_TIME_200MS = 3
• BrickletAmbientLightV2.INTEGRATION_TIME_250MS = 4
• BrickletAmbientLightV2.INTEGRATION_TIME_300MS = 5
• BrickletAmbientLightV2.INTEGRATION_TIME_350MS = 6
• BrickletAmbientLightV2.INTEGRATION_TIME_400MS = 7

BrickletAmbientLightV2.Configuration BrickletAmbientLightV2.getConfiguration()¶

Rückgabeobjekt:	illuminanceRange – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3 integrationTime – Typ: short, 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 illuminanceRange:

• BrickletAmbientLightV2.ILLUMINANCE_RANGE_UNLIMITED = 6
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_64000LUX = 0
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_32000LUX = 1
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_16000LUX = 2
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_8000LUX = 3
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_1300LUX = 4
• BrickletAmbientLightV2.ILLUMINANCE_RANGE_600LUX = 5

Für integrationTime:

• BrickletAmbientLightV2.INTEGRATION_TIME_50MS = 0
• BrickletAmbientLightV2.INTEGRATION_TIME_100MS = 1
• BrickletAmbientLightV2.INTEGRATION_TIME_150MS = 2
• BrickletAmbientLightV2.INTEGRATION_TIME_200MS = 3
• BrickletAmbientLightV2.INTEGRATION_TIME_250MS = 4
• BrickletAmbientLightV2.INTEGRATION_TIME_300MS = 5
• BrickletAmbientLightV2.INTEGRATION_TIME_350MS = 6
• BrickletAmbientLightV2.INTEGRATION_TIME_400MS = 7

BrickletAmbientLightV2.Identity BrickletAmbientLightV2.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 BrickletAmbientLightV2.setIlluminanceCallbackPeriod(long period)¶

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

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

Der IlluminanceListener Listener wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

long BrickletAmbientLightV2.getIlluminanceCallbackPeriod()¶

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

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

void BrickletAmbientLightV2.setIlluminanceCallbackThreshold(char option, long min, long max)¶

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

Setzt den Schwellwert für den IlluminanceReachedListener Listener.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletAmbientLightV2.IlluminanceCallbackThreshold BrickletAmbientLightV2.getIlluminanceCallbackThreshold()¶

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

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

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

Für option:

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

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

• IlluminanceReachedListener,

ausgelöst werden, wenn die Schwellwerte

• setIlluminanceCallbackThreshold(),

weiterhin erreicht bleiben.

long BrickletAmbientLightV2.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 BrickletAmbientLightV2.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 BrickletAmbientLightV2.IlluminanceListener()¶

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

void illuminance(long illuminance)

Parameter:	illuminance – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Dieser Listener wird mit der Periode, wie gesetzt mit setIlluminanceCallbackPeriod(), ausgelöst. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

Der IlluminanceListener Listener wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

class BrickletAmbientLightV2.IlluminanceReachedListener()¶

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

void illuminanceReached(long illuminance)

Parameter:	illuminance – Typ: long, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setIlluminanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

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[] BrickletAmbientLightV2.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 BrickletAmbientLightV2.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:

• BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
• BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
• BrickletAmbientLightV2.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletAmbientLightV2.FUNCTION_SET_CONFIGURATION = 8

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

• BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
• BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
• BrickletAmbientLightV2.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletAmbientLightV2.FUNCTION_SET_CONFIGURATION = 8

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

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

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