Software / API Bindings / Java / API Reference and Examples / Bricklets (Discontinued) / Ambient Light Bricklet 2.0

Java - Ambient Light Bricklet 2.0¶

This is the description of the Java API bindings for the Ambient Light Bricklet 2.0. General information and technical specifications for the Ambient Light Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Java API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple¶

Download (ExampleSimple.java)

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)

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)

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();
    }
}

API¶

Generally, every method of the Java bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions¶

class BrickletAmbientLightV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	ambientLightV2 – Type: BrickletAmbientLightV2

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected.

long BrickletAmbientLightV2.getIlluminance()¶

Returns:	illuminance – Type: long, Unit: 1/100 lx, Range: [0 to 2³² - 1]

Returns the illuminance of the ambient light sensor. The measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop.

Changed in version 2.0.2 (Plugin): An illuminance of 0lux indicates an error condition where the sensor cannot perform a reasonable measurement. This can happen with very dim or very bright light conditions. In bright light conditions this might indicate that the sensor is saturated and the configuration should be modified (setConfiguration()) to better match the light conditions.

If you want to get the illuminance periodically, it is recommended to use the IlluminanceListener listener and set the period with setIlluminanceCallbackPeriod().

Advanced Functions¶

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

Parameters:	illuminanceRange – Type: short, Range: See constants, Default: 3 integrationTime – Type: short, Range: See constants, Default: 3

Sets the configuration. It is possible to configure an illuminance range between 0-600lux and 0-64000lux and an integration time between 50ms and 400ms.

New in version 2.0.2 (Plugin): The unlimited illuminance range allows to measure up to about 100000lux, but above 64000lux the precision starts to drop.

A smaller illuminance range increases the resolution of the data. A longer integration time will result in less noise on the data.

Changed in version 2.0.2 (Plugin): If the actual measure illuminance is out-of-range then the current illuminance range maximum +0.01lux is reported by getIlluminance() and the IlluminanceListener listener. For example, 800001 for the 0-8000lux range.

Changed in version 2.0.2 (Plugin): With a long integration time the sensor might be saturated before the measured value reaches the maximum of the selected illuminance range. In this case 0lux is reported by getIlluminance() and the IlluminanceListener listener.

If the measurement is out-of-range or the sensor is saturated then you should configure the next higher illuminance range. If the highest range is already in use, then start to reduce the integration time.

The following constants are available for this function:

For 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

For 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()¶

Return Object:	illuminanceRange – Type: short, Range: See constants, Default: 3 integrationTime – Type: short, Range: See constants, Default: 3

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For 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

For 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()¶

Return Object:

Return Object:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: short[], Length: 3

0: major – Type: short, Range: [0 to 255]
1: minor – Type: short, Range: [0 to 255]
2: revision – Type: short, Range: [0 to 255]

firmwareVersion – Type: short[], Length: 3

0: major – Type: short, Range: [0 to 255]
1: minor – Type: short, Range: [0 to 255]
2: revision – Type: short, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Listener Configuration Functions¶

void BrickletAmbientLightV2.setIlluminanceCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the IlluminanceListener listener is triggered periodically. A value of 0 turns the listener off.

The IlluminanceListener listener is only triggered if the illuminance has changed since the last triggering.

long BrickletAmbientLightV2.getIlluminanceCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setIlluminanceCallbackPeriod().

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

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: long, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0 max – Type: long, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0

Sets the thresholds for the IlluminanceReachedListener listener.

The following options are possible:

Option	Description
'x'	Listener is turned off
'o'	Listener is triggered when the illuminance is outside the min and max values
'i'	Listener is triggered when the illuminance is inside the min and max values
'<'	Listener is triggered when the illuminance is smaller than the min value (max is ignored)
'>'	Listener is triggered when the illuminance is greater than the min value (max is ignored)

The following constants are available for this function:

For 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()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: long, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0 max – Type: long, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0

Returns the threshold as set by setIlluminanceCallbackThreshold().

The following constants are available for this function:

For 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)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold listeners

IlluminanceReachedListener,

are triggered, if the thresholds

setIlluminanceCallbackThreshold(),

keep being reached.

long BrickletAmbientLightV2.getDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

Listeners¶

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with add*Listener() functions of the device object.

The parameter is a listener class object, for example:

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

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding remove*Listener() function.

Note

Using listeners for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

class BrickletAmbientLightV2.IlluminanceListener()¶

This listener can be added with the addIlluminanceListener() function. An added listener can be removed with the removeIlluminanceListener() function.

void illuminance(long illuminance)

Parameters:	illuminance – Type: long, Unit: 1/100 lx, Range: [0 to 2³² - 1]

This listener is triggered periodically with the period that is set by setIlluminanceCallbackPeriod(). The parameter is the illuminance of the ambient light sensor.

The IlluminanceListener listener is only triggered if the illuminance has changed since the last triggering.

class BrickletAmbientLightV2.IlluminanceReachedListener()¶

This listener can be added with the addIlluminanceReachedListener() function. An added listener can be removed with the removeIlluminanceReachedListener() function.

void illuminanceReached(long illuminance)

Parameters:	illuminance – Type: long, Unit: 1/100 lx, Range: [0 to 2³² - 1]

This listener is triggered when the threshold as set by setIlluminanceCallbackThreshold() is reached. The parameter is the illuminance of the ambient light sensor.

If the threshold keeps being reached, the listener is triggered periodically with the period as set by setDebouncePeriod().

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

short[] BrickletAmbientLightV2.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

boolean BrickletAmbientLightV2.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For listener configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and listener configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For 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)¶

Parameters:	responseExpected – Type: boolean

Changes the response expected flag for all setter and listener configuration functions of this device at once.

Constants¶

int BrickletAmbientLightV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Ambient Light Bricklet 2.0.

The getIdentity() function and the IPConnection.EnumerateListener listener of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletAmbientLightV2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Ambient Light Bricklet 2.0.