PHP - Color Bricklet

This is the description of the PHP API bindings for the Color Bricklet. General information and technical specifications for the Color Bricklet 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
28
29
30
31
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletColor;

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

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

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

// Get current color
$color = $c->getColor();

echo "Color [R]: " . $color['r'] . "\n";
echo "Color [G]: " . $color['g'] . "\n";
echo "Color [B]: " . $color['b'] . "\n";
echo "Color [C]: " . $color['c'] . "\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
37
38
39
40
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletColor;

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

// Callback function for color callback
function cb_color($r, $g, $b, $c)
{
    echo "Color [R]: $r\n";
    echo "Color [G]: $g\n";
    echo "Color [B]: $b\n";
    echo "Color [C]: $c\n";
    echo "\n";
}

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

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

// Register color callback to function cb_color
$c->registerCallback(BrickletColor::CALLBACK_COLOR, 'cb_color');

// Set period for color callback to 1s (1000ms)
// Note: The color callback is only called every second
//       if the color has changed since the last call!
$c->setColorCallbackPeriod(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
40
41
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletColor;

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

// Callback function for color reached callback
function cb_colorReached($r, $g, $b, $c)
{
    echo "Color [R]: $r\n";
    echo "Color [G]: $g\n";
    echo "Color [B]: $b\n";
    echo "Color [C]: $c\n";
    echo "\n";
}

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

// Register color reached callback to function cb_colorReached
$c->registerCallback(BrickletColor::CALLBACK_COLOR_REACHED, 'cb_colorReached');

// Configure threshold for color "greater than 100, 200, 300, 400"
$c->setColorCallbackThreshold('>', 100, 0, 200, 0, 300, 0, 400, 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 BrickletColor(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $color – Type: BrickletColor

Creates an object with the unique device ID $uid:

<?php   $color = new BrickletColor('YOUR_DEVICE_UID', $ipcon);   ?>

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

array BrickletColor::getColor()
Return Array:
  • 'r' – Type: int, Range: [0 to 216 - 1]
  • 'g' – Type: int, Range: [0 to 216 - 1]
  • 'b' – Type: int, Range: [0 to 216 - 1]
  • 'c' – Type: int, Range: [0 to 216 - 1]

Returns the measured color of the sensor.

The red (r), green (g), blue (b) and clear (c) colors are measured with four different photodiodes that are responsive at different wavelengths:

Chart Responsivity / Wavelength

If you want to get the color periodically, it is recommended to use the CALLBACK_COLOR callback and set the period with setColorCallbackPeriod().

void BrickletColor::lightOn()

Turns the LED on.

void BrickletColor::lightOff()

Turns the LED off.

int BrickletColor::isLightOn()
Returns:
  • $light – Type: int, Range: See constants, Default: 1

Returns the state of the LED. Possible values are:

  • 0: On
  • 1: Off

The following constants are available for this function:

For $light:

  • BrickletColor::LIGHT_ON = 0
  • BrickletColor::LIGHT_OFF = 1
void BrickletColor::setConfig(int $gain, int $integration_time)
Parameters:
  • $gain – Type: int, Range: See constants, Default: 3
  • $integration_time – Type: int, Range: See constants, Default: 3

Sets the configuration of the sensor. Gain and integration time can be configured in this way.

For configuring the gain:

  • 0: 1x Gain
  • 1: 4x Gain
  • 2: 16x Gain
  • 3: 60x Gain

For configuring the integration time:

  • 0: 2.4ms
  • 1: 24ms
  • 2: 101ms
  • 3: 154ms
  • 4: 700ms

Increasing the gain enables the sensor to detect a color from a higher distance.

The integration time provides a trade-off between conversion time and accuracy. With a longer integration time the values read will be more accurate but it will take longer time to get the conversion results.

The following constants are available for this function:

For $gain:

  • BrickletColor::GAIN_1X = 0
  • BrickletColor::GAIN_4X = 1
  • BrickletColor::GAIN_16X = 2
  • BrickletColor::GAIN_60X = 3

For $integration_time:

  • BrickletColor::INTEGRATION_TIME_2MS = 0
  • BrickletColor::INTEGRATION_TIME_24MS = 1
  • BrickletColor::INTEGRATION_TIME_101MS = 2
  • BrickletColor::INTEGRATION_TIME_154MS = 3
  • BrickletColor::INTEGRATION_TIME_700MS = 4
array BrickletColor::getConfig()
Return Array:
  • 'gain' – Type: int, Range: See constants, Default: 3
  • 'integration_time' – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setConfig().

The following constants are available for this function:

For $gain:

  • BrickletColor::GAIN_1X = 0
  • BrickletColor::GAIN_4X = 1
  • BrickletColor::GAIN_16X = 2
  • BrickletColor::GAIN_60X = 3

For $integration_time:

  • BrickletColor::INTEGRATION_TIME_2MS = 0
  • BrickletColor::INTEGRATION_TIME_24MS = 1
  • BrickletColor::INTEGRATION_TIME_101MS = 2
  • BrickletColor::INTEGRATION_TIME_154MS = 3
  • BrickletColor::INTEGRATION_TIME_700MS = 4
int BrickletColor::getIlluminance()
Returns:
  • $illuminance – Type: int, Unit: ? lx, Range: [0 to 103438]

Returns the illuminance affected by the gain and integration time as set by setConfig(). To get the illuminance in Lux apply this formula:

lux = illuminance * 700 / gain / integration_time

To get a correct illuminance measurement make sure that the color values themselves are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see setConfig().

int BrickletColor::getColorTemperature()
Returns:
  • $color_temperature – Type: int, Unit: 1 K, Range: [0 to 216 - 1]

Returns the color temperature.

To get a correct color temperature measurement make sure that the color values themselves are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see setConfig().

Advanced Functions

array BrickletColor::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string, Range: ['a' to 'h', 'i', 'z']
  • 'hardware_version' – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 'firmware_version' – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 'device_identifier' – Type: int, Range: [0 to 216 - 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

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

Callback Configuration Functions

void BrickletColor::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)
Parameters:
  • $callback_id – Type: int
  • $callback – Type: callable
  • $user_data – Type: mixed

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 BrickletColor::setColorCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The CALLBACK_COLOR callback is only triggered if the color has changed since the last triggering.

int BrickletColor::getColorCallbackPeriod()
Returns:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setColorCallbackPeriod().

void BrickletColor::setColorCallbackThreshold(string $option, int $min_r, int $max_r, int $min_g, int $max_g, int $min_b, int $max_b, int $min_c, int $max_c)
Parameters:
  • $option – Type: string, Range: See constants, Default: 'x'
  • $min_r – Type: int, Range: [0 to 216 - 1], Default: 0
  • $max_r – Type: int, Range: [0 to 216 - 1], Default: 0
  • $min_g – Type: int, Range: [0 to 216 - 1], Default: 0
  • $max_g – Type: int, Range: [0 to 216 - 1], Default: 0
  • $min_b – Type: int, Range: [0 to 216 - 1], Default: 0
  • $max_b – Type: int, Range: [0 to 216 - 1], Default: 0
  • $min_c – Type: int, Range: [0 to 216 - 1], Default: 0
  • $max_c – Type: int, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the CALLBACK_COLOR_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For $option:

  • BrickletColor::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColor::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColor::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColor::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColor::THRESHOLD_OPTION_GREATER = '>'
array BrickletColor::getColorCallbackThreshold()
Return Array:
  • 'option' – Type: string, Range: See constants, Default: 'x'
  • 'min_r' – Type: int, Range: [0 to 216 - 1], Default: 0
  • 'max_r' – Type: int, Range: [0 to 216 - 1], Default: 0
  • 'min_g' – Type: int, Range: [0 to 216 - 1], Default: 0
  • 'max_g' – Type: int, Range: [0 to 216 - 1], Default: 0
  • 'min_b' – Type: int, Range: [0 to 216 - 1], Default: 0
  • 'max_b' – Type: int, Range: [0 to 216 - 1], Default: 0
  • 'min_c' – Type: int, Range: [0 to 216 - 1], Default: 0
  • 'max_c' – Type: int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by setColorCallbackThreshold().

The following constants are available for this function:

For $option:

  • BrickletColor::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColor::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColor::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColor::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColor::THRESHOLD_OPTION_GREATER = '>'
void BrickletColor::setDebouncePeriod(int $debounce)
Parameters:
  • $debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callback

is triggered, if the threshold

keeps being reached.

int BrickletColor::getDebouncePeriod()
Returns:
  • $debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

void BrickletColor::setIlluminanceCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

int BrickletColor::getIlluminanceCallbackPeriod()
Returns:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setIlluminanceCallbackPeriod().

void BrickletColor::setColorTemperatureCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The CALLBACK_COLOR_TEMPERATURE callback is only triggered if the color temperature has changed since the last triggering.

int BrickletColor::getColorTemperatureCallbackPeriod()
Returns:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setColorTemperatureCallbackPeriod().

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";
}

$color->registerCallback(BrickletColor::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 BrickletColor::CALLBACK_COLOR
<?php   void callback(int $r, int $g, int $b, int $c [, mixed $user_data])   ?>
Callback Parameters:
  • $r – Type: int, Range: [0 to 216 - 1]
  • $g – Type: int, Range: [0 to 216 - 1]
  • $b – Type: int, Range: [0 to 216 - 1]
  • $c – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setColorCallbackPeriod(). The parameter is the color of the sensor as RGBC.

The CALLBACK_COLOR callback is only triggered if the color has changed since the last triggering.

int BrickletColor::CALLBACK_COLOR_REACHED
<?php   void callback(int $r, int $g, int $b, int $c [, mixed $user_data])   ?>
Callback Parameters:
  • $r – Type: int, Range: [0 to 216 - 1]
  • $g – Type: int, Range: [0 to 216 - 1]
  • $b – Type: int, Range: [0 to 216 - 1]
  • $c – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

This callback is triggered when the threshold as set by setColorCallbackThreshold() is reached. The parameter is the color of the sensor as RGBC.

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

int BrickletColor::CALLBACK_ILLUMINANCE
<?php   void callback(int $illuminance [, mixed $user_data])   ?>
Callback Parameters:
  • $illuminance – Type: int, Unit: ? lx, Range: [0 to 103438]
  • $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setIlluminanceCallbackPeriod(). The parameter is the illuminance. See getIlluminance() for how to interpret this value.

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

int BrickletColor::CALLBACK_COLOR_TEMPERATURE
<?php   void callback(int $color_temperature [, mixed $user_data])   ?>
Callback Parameters:
  • $color_temperature – Type: int, Unit: 1 K, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setColorTemperatureCallbackPeriod(). The parameter is the color temperature.

The CALLBACK_COLOR_TEMPERATURE callback is only triggered if the color temperature has changed since the last triggering.

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.

array BrickletColor::getAPIVersion()
Return Array:
  • $api_version – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, 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.

bool BrickletColor::getResponseExpected(int $function_id)
Parameters:
  • $function_id – Type: int, Range: See constants
Returns:
  • $response_expected – Type: bool

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.

The following constants are available for this function:

For $function_id:

  • BrickletColor::FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  • BrickletColor::FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  • BrickletColor::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletColor::FUNCTION_LIGHT_ON = 10
  • BrickletColor::FUNCTION_LIGHT_OFF = 11
  • BrickletColor::FUNCTION_SET_CONFIG = 13
  • BrickletColor::FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  • BrickletColor::FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
void BrickletColor::setResponseExpected(int $function_id, bool $response_expected)
Parameters:
  • $function_id – Type: int, Range: See constants
  • $response_expected – Type: bool

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 constants are available for this function:

For $function_id:

  • BrickletColor::FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  • BrickletColor::FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  • BrickletColor::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletColor::FUNCTION_LIGHT_ON = 10
  • BrickletColor::FUNCTION_LIGHT_OFF = 11
  • BrickletColor::FUNCTION_SET_CONFIG = 13
  • BrickletColor::FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  • BrickletColor::FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
void BrickletColor::setResponseExpectedAll(bool $response_expected)
Parameters:
  • $response_expected – Type: bool

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

Constants

int BrickletColor::DEVICE_IDENTIFIER

This constant is used to identify a Color Bricklet.

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

string BrickletColor::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Color Bricklet.