Note
This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.
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.
The example code below is Public Domain (CC0 1.0).
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 | <?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 to your UID
$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 (unit is Lux/100)
$illuminance = $al->getIlluminance() / 100.0;
echo "Illuminance: $illuminance Lux\n";
echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();
?>
|
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 to your UID
// Callback function for illuminance callback (parameter has unit Lux/100)
function cb_illuminance($illuminance)
{
echo "Illuminance: " . $illuminance / 100.0 . " Lux\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
// 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 to function cb_illuminance
$al->registerCallback(BrickletAmbientLightV2::CALLBACK_ILLUMINANCE, 'cb_illuminance');
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
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 | <?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 to your UID
// Callback for illuminance greater than 200 Lux
function cb_reached($illuminance)
{
echo "We have " . $illuminance / 100.0 . " Lux.\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 threshold reached callback to function cb_reached
$al->registerCallback(BrickletAmbientLightV2::CALLBACK_ILLUMINANCE_REACHED, 'cb_reached');
// Configure threshold for "greater than 200 Lux" (unit is Lux/100)
$al->setIlluminanceCallbackThreshold('>', 200*100, 0);
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
Functions that return multiple values return them in an associative array.
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).
Returns the illuminance of the ambient light sensor. The value has a range of 0 to 6400000 and is given in 1/100 Lux, i.e. a value of 45000 means that an illuminance of 450 Lux is measured.
If you want to get the illuminance periodically, it is recommended to use the callback CALLBACK_ILLUMINANCE and set the period with setIlluminanceCallbackPeriod().
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.
A smaller illuminance range increases the resolution of the data. An increase in integration time will result in less noise on the data.
The default values are 0-8000lux illuminance range and 200ms integration time.
The following constants are available for this function:
Returns the configuration as set by setConfiguration().
The following constants are available for this function:
The returned array has the keys illuminance_range and integration_time.
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.
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.
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 and callbacks it is always disabled.
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:
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
Registers a callback with ID $id to the callable $callback. The $userData will be given as a parameter of the callback.
The available IDs with corresponding function signatures are listed below.
Sets the period in ms with which the CALLBACK_ILLUMINANCE callback is triggered periodically. A value of 0 turns the callback off.
CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the last triggering.
The default value is 0.
Returns the period as set by setIlluminanceCallbackPeriod().
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:
Returns the threshold as set by setIlluminanceCallbackThreshold().
The following constants are available for this function:
The returned array has the keys option, min and max.
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
The default value is 100.
Returns the debounce period as set by setDebouncePeriod().
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.
<?php void callback(int $illuminance [, mixed $userData]) ?>
This callback is triggered periodically with the period that is set by setIlluminanceCallbackPeriod(). The parameter is the illuminance of the ambient light sensor.
CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the last triggering.
<?php void callback(int $illuminance [, mixed $userData]) ?>
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().
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.