Java - Ambient Light Bricklet

Dies ist die Beschreibung der Java API Bindings für das Ambient Light Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Ambient Light Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Java API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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.BrickletAmbientLight;

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
    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
        BrickletAmbientLight al = new BrickletAmbientLight(UID, ipcon); // Create device object

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

        // Get current illuminance
        int illuminance = al.getIlluminance(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Illuminance: " + illuminance/10.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.BrickletAmbientLight;

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
    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
        BrickletAmbientLight al = new BrickletAmbientLight(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 BrickletAmbientLight.IlluminanceListener() {
            public void illuminance(int illuminance) {
                System.out.println("Illuminance: " + illuminance/10.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.BrickletAmbientLight;

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
    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
        BrickletAmbientLight al = new BrickletAmbientLight(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 BrickletAmbientLight.IlluminanceReachedListener() {
            public void illuminanceReached(int illuminance) {
                System.out.println("Illuminance: " + illuminance/10.0 + " lx");
                System.out.println("Too bright, close the curtains!");
            }
        });

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

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

API

Prinzipiell kann jede Methode der Java 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 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

class BrickletAmbientLight(String uid, IPConnection ipcon)

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

BrickletAmbientLight ambientLight = new BrickletAmbientLight("YOUR_DEVICE_UID", ipcon);

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

int BrickletAmbientLight.getIlluminance()

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Wertbereich ist von 0 bis 9000 und ist in Lux/10 angegeben, d.h. bei einem Wert von 4500 wurde eine Beleuchtungsstärke von 450Lux gemessen.

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

Fortgeschrittene Funktionen

int BrickletAmbientLight.getAnalogValue()

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von getIlluminance() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Weiterhin deckt der Analog-Digital-Wandler drei unterschiedliche Bereiche ab, welche dynamisch gewechselt werden abhängig von der Lichtintensität. Es ist nicht möglich, anhand der Analogwerte, zwischen diesen Bereichen zu unterscheiden.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueListener Listener zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

short[] BrickletAmbientLight.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.

boolean BrickletAmbientLight.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 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:

  • BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletAmbientLight.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletAmbientLight.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 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:

  • BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletAmbientLight.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletAmbientLight.setResponseExpectedAll(boolean responseExpected)

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

BrickletAmbientLight.Identity BrickletAmbientLight.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 Listener

void BrickletAmbientLight.setIlluminanceCallbackPeriod(long period)

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

Der Standardwert ist 0.

long BrickletAmbientLight.getIlluminanceCallbackPeriod()

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

void BrickletAmbientLight.setAnalogValueCallbackPeriod(long period)

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

Der AnalogValueListener Listener wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

long BrickletAmbientLight.getAnalogValueCallbackPeriod()

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

void BrickletAmbientLight.setIlluminanceCallbackThreshold(char option, int min, int max)

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)

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

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

  • BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'
BrickletAmbientLight.IlluminanceCallbackThreshold BrickletAmbientLight.getIlluminanceCallbackThreshold()

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

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

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

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

void BrickletAmbientLight.setAnalogValueCallbackThreshold(char option, int min, int max)

Setzt den Schwellwert für den AnalogValueReachedListener Listener.

Die folgenden Optionen sind möglich:

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

  • BrickletAmbientLight.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLight.THRESHOLD_OPTION_GREATER = '>'
BrickletAmbientLight.AnalogValueCallbackThreshold BrickletAmbientLight.getAnalogValueCallbackThreshold()

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

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

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

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

void BrickletAmbientLight.setDebouncePeriod(long debounce)

Setzt die Periode in ms mit welcher die Schwellwert Listeners

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

long BrickletAmbientLight.getDebouncePeriod()

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 BrickletAmbientLight.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.

Bemerkung

Listener 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.

class BrickletAmbientLight.IlluminanceListener()

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

void illuminance(int illuminance)

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 BrickletAmbientLight.AnalogValueListener()

Dieser Listener kann mit der Funktion addAnalogValueListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeAnalogValueListener() wieder entfernt werden.

void analogValue(int value)

Dieser Listener wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Umgebungslichtsensors.

Der AnalogValueListener Listener wird nur ausgelöst wenn sich der Analogwert seit der letzten Auslösung geändert hat.

class BrickletAmbientLight.IlluminanceReachedListener()

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

void illuminanceReached(int illuminance)

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.

class BrickletAmbientLight.AnalogValueReachedListener()

Dieser Listener kann mit der Funktion addAnalogValueReachedListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeAnalogValueReachedListener() wieder entfernt werden.

void analogValueReached(int value)

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Umgebungslichtsensors.

Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

static final int BrickletAmbientLight.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Ambient 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.

static final String BrickletAmbientLight.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet dar.