JavaScript - Ambient Light Bricklet 2.0

This is the description of the JavaScript 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 JavaScript API bindings is part of their general description.

Examples

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

Simple (Node.js)

Download (ExampleSimple.js)

 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
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Ambient Light Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var al = new Tinkerforge.BrickletAmbientLightV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get current illuminance
        al.getIlluminance(
            function (illuminance) {
                console.log('Illuminance: ' + illuminance/100.0 + ' lx');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (Node.js)

Download (ExampleCallback.js)

 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
38
39
40
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Ambient Light Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var al = new Tinkerforge.BrickletAmbientLightV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // 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);
    }
);

// Register illuminance callback
al.on(Tinkerforge.BrickletAmbientLightV2.CALLBACK_ILLUMINANCE,
    // Callback function for illuminance callback
    function (illuminance) {
        console.log('Illuminance: ' + illuminance/100.0 + ' lx');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Threshold (Node.js)

Download (ExampleThreshold.js)

 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
38
39
40
41
42
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Ambient Light Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var al = new Tinkerforge.BrickletAmbientLightV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        al.setDebouncePeriod(10000);

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

// Register illuminance reached callback
al.on(Tinkerforge.BrickletAmbientLightV2.CALLBACK_ILLUMINANCE_REACHED,
    // Callback function for illuminance reached callback
    function (illuminance) {
        console.log('Illuminance: ' + illuminance/100.0 + ' lx');
        console.log('Too bright, close the curtains!');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Simple (HTML)

Download (ExampleSimple.html), Test (ExampleSimple.html)

 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Ambient Light Bricklet 2.0 Simple Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var al = new Tinkerforge.BrickletAmbientLightV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get current illuminance
                        al.getIlluminance(
                            function (illuminance) {
                                textArea.value += 'Illuminance: ' + illuminance/100.0 + ' lx\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)

Download (ExampleCallback.html), Test (ExampleCallback.html)

 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Ambient Light Bricklet 2.0 Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var al = new Tinkerforge.BrickletAmbientLightV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // 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);
                    }
                );

                // Register illuminance callback
                al.on(Tinkerforge.BrickletAmbientLightV2.CALLBACK_ILLUMINANCE,
                    // Callback function for illuminance callback
                    function (illuminance) {
                        textArea.value += 'Illuminance: ' + illuminance/100.0 + ' lx\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Threshold (HTML)

Download (ExampleThreshold.html), Test (ExampleThreshold.html)

 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Ambient Light Bricklet 2.0 Threshold Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var al = new Tinkerforge.BrickletAmbientLightV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
                        al.setDebouncePeriod(10000);

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

                // Register illuminance reached callback
                al.on(Tinkerforge.BrickletAmbientLightV2.CALLBACK_ILLUMINANCE_REACHED,
                    // Callback function for illuminance reached callback
                    function (illuminance) {
                        textArea.value += 'Illuminance: ' + illuminance/100.0 + ' lx\n';
                        textArea.value += 'Too bright, close the curtains!\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API

Generally, every method of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback is called with the return values as parameters, if the method returns something. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:

  • IPConnection.ERROR_ALREADY_CONNECTED = 11
  • IPConnection.ERROR_NOT_CONNECTED = 12
  • IPConnection.ERROR_CONNECT_FAILED = 13
  • IPConnection.ERROR_INVALID_FUNCTION_ID = 21
  • IPConnection.ERROR_TIMEOUT = 31
  • IPConnection.ERROR_INVALID_PARAMETER = 41
  • IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
  • IPConnection.ERROR_UNKNOWN_ERROR = 43

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions

new BrickletAmbientLightV2(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected (see examples above).

BrickletAmbientLightV2.getIlluminance([returnCallback][, errorCallback])
Callback:
  • illuminance -- int

Returns the illuminance of the ambient light sensor. The measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop. The illuminance is given in lux/100, i.e. a value of 450000 means that an illuminance of 4500lux is measured.

Changed in version 2.0.2 (Plugin): An illuminance of 0lux indicates that the sensor is saturated and the configuration should be modified, see setConfiguration().

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

Advanced Functions

BrickletAmbientLightV2.setConfiguration(illuminanceRange, integrationTime[, returnCallback][, errorCallback])
Parameters:
  • illuminanceRange -- int
  • integrationTime -- int
Callback:

undefined

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 CALLBACK_ILLUMINANCE callback. 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 CALLBACK_ILLUMINANCE callback.

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 default values are 0-8000lux illuminance range and 200ms integration time.

The following constants are available for this function:

  • 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
  • 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.getConfiguration([returnCallback][, errorCallback])
Callback:
  • illuminanceRange -- int
  • integrationTime -- int

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

  • 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
  • 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.getAPIVersion()
Return type:[int, int, int]

Returns the version of the API definition (major, minor, revision) 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.

BrickletAmbientLightV2.getResponseExpected(functionId[, errorCallback])
Parameters:
  • functionId -- int
Return 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 callback 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 send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

BrickletAmbientLightV2.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameters:
  • functionId -- int
  • responseExpected -- 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 callback configuration functions (default value: true). For getter functions it is always 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • 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
BrickletAmbientLightV2.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected -- boolean

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

BrickletAmbientLightV2.getIdentity([returnCallback][, errorCallback])
Callback:
  • uid -- string
  • connectedUid -- string
  • position -- char
  • hardwareVersion -- [int, int, int]
  • firmwareVersion -- [int, int, int]
  • deviceIdentifier -- int

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' or 'd'.

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

Callback Configuration Functions

BrickletAmbientLightV2.on(callback_id, function)
Parameters:
  • callback_id -- int
  • function -- function

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletAmbientLightV2.setIlluminanceCallbackPeriod(period[, returnCallback][, errorCallback])
Parameters:
  • period -- int
Callback:

undefined

Sets the period in ms with which the CALLBACK_ILLUMINANCE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed since the last triggering.

The default value is 0.

BrickletAmbientLightV2.getIlluminanceCallbackPeriod([returnCallback][, errorCallback])
Callback:
  • period -- int

Returns the period as set by setIlluminanceCallbackPeriod().

BrickletAmbientLightV2.setIlluminanceCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
Parameters:
  • option -- char
  • min -- int
  • max -- int
Callback:

undefined

Sets the thresholds for the CALLBACK_ILLUMINANCE_REACHED callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletAmbientLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLightV2.THRESHOLD_OPTION_GREATER = '>'
BrickletAmbientLightV2.getIlluminanceCallbackThreshold([returnCallback][, errorCallback])
Callback:
  • option -- char
  • min -- int
  • max -- int

Returns the threshold as set by setIlluminanceCallbackThreshold().

The following constants are available for this function:

  • BrickletAmbientLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAmbientLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAmbientLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAmbientLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAmbientLightV2.THRESHOLD_OPTION_GREATER = '>'
BrickletAmbientLightV2.setDebouncePeriod(debounce[, returnCallback][, errorCallback])
Parameters:
  • debounce -- int
Callback:

undefined

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletAmbientLightV2.getDebouncePeriod([returnCallback][, errorCallback])
Callback:
  • debounce -- int

Returns the debounce period as set by setDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

ambientLightV2.on(BrickletAmbientLightV2.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks 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.

BrickletAmbientLightV2.CALLBACK_ILLUMINANCE
Parameters:
  • illuminance -- int

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

The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed since the last triggering.

BrickletAmbientLightV2.CALLBACK_ILLUMINANCE_REACHED
Parameters:
  • illuminance -- int

This callback 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 callback is triggered periodically with the period as set by setDebouncePeriod().

Constants

BrickletAmbientLightV2.DEVICE_IDENTIFIER

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

The getIdentity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletAmbientLightV2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Ambient Light Bricklet 2.0.