PHP - Ambient Light Bricklet 2.0

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

Examples

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

Simple

Download (ExampleSimple.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletAmbientLightV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAmbientLightV2;

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

$ipcon = new IPConnection(); // Create IP connection
$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
$illuminance = $al->getIlluminance();
echo "Illuminance: " . $illuminance/100.0 . " lx\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback

Download (ExampleCallback.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletAmbientLightV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAmbientLightV2;

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

// Callback function for illuminance callback
function cb_illuminance($illuminance)
{
    echo "Illuminance: " . $illuminance/100.0 . " lx\n";
}

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

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

// Register illuminance callback to function cb_illuminance
$al->registerCallback(BrickletAmbientLightV2::CALLBACK_ILLUMINANCE, 'cb_illuminance');

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

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Threshold

Download (ExampleThreshold.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletAmbientLightV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAmbientLightV2;

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

// Callback function for illuminance reached callback
function cb_illuminanceReached($illuminance)
{
    echo "Illuminance: " . $illuminance/100.0 . " lx\n";
    echo "Too bright, close the curtains!\n";
}

$ipcon = new IPConnection(); // Create IP connection
$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);

// Register illuminance reached callback to function cb_illuminanceReached
$al->registerCallback(BrickletAmbientLightV2::CALLBACK_ILLUMINANCE_REACHED,
                      'cb_illuminanceReached');

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

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletAmbientLightV2(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $ambient_light_v2 = new BrickletAmbientLightV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletAmbientLightV2::getIlluminance()

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

void BrickletAmbientLightV2::setConfiguration(int $illuminance_range, int $integration_time)

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
array BrickletAmbientLightV2::getConfiguration()

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

The returned array has the keys illuminance_range and integration_time.

array BrickletAmbientLightV2::getAPIVersion()

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.

bool BrickletAmbientLightV2::getResponseExpected(int $function_id)

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.

void BrickletAmbientLightV2::setResponseExpected(int $function_id, bool $response_expected)

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
void BrickletAmbientLightV2::setResponseExpectedAll(bool $response_expected)

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

array BrickletAmbientLightV2::getIdentity()

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.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

void BrickletAmbientLightV2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

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

void BrickletAmbientLightV2::setIlluminanceCallbackPeriod(int $period)

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.

int BrickletAmbientLightV2::getIlluminanceCallbackPeriod()

Returns the period as set by setIlluminanceCallbackPeriod().

void BrickletAmbientLightV2::setIlluminanceCallbackThreshold(string $option, int $min, int $max)

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 = '>'
array BrickletAmbientLightV2::getIlluminanceCallbackThreshold()

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 = '>'

The returned array has the keys option, min and max.

void BrickletAmbientLightV2::setDebouncePeriod(int $debounce)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

int BrickletAmbientLightV2::getDebouncePeriod()

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 registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$ambient_light_v2->registerCallback(BrickletAmbientLightV2::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures 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.

int BrickletAmbientLightV2::CALLBACK_ILLUMINANCE
<?php   void callback(int $illuminance [, mixed $user_data])   ?>

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.

int BrickletAmbientLightV2::CALLBACK_ILLUMINANCE_REACHED
<?php   void callback(int $illuminance [, mixed $user_data])   ?>

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

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