PHP - Color Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
            - Examples
              - Simple
              - Callback
              - Threshold
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# 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
    32

    <?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 = 'abc'; // Change to your UID

    $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 "\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 = 'abc'; // Change to your UID

    // Callback function for color
    function cb_color($r, $g, $b, $cl)
    {
        echo "Color(R): " . $r ."\n";
        echo "Color(G): " . $g ."\n";
        echo "Color(B): " . $b ."\n";
        echo "Color(C): " . $cl ."\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

    // Set Period for color callback to 1s (1000ms)
    // Note: The callback is only called every second if the
    //       color has changed since the last call!
    $c->setColorCallbackPeriod(1000);

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

    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
    42
    43
    44
    45

    <?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 = 'abc'; // Change to your UID

    // Callback for color threshold reached
    function cb_reached($r, $g, $b, $cl)
    {
        echo "Color(R): " . $r ."\n";
        echo "Color(G): " . $g ."\n";
        echo "Color(B): " . $b ."\n";
        echo "Color(C): " . $cl ."\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 threshold reached callback to function cb_reached
    $c->registerCallback(BrickletColor::CALLBACK_COLOR_REACHED, 'cb_reached');

    // Configure threshold for color values,
    // RED   greater than 100
    // GREEN greater than 200
    // BLUE  greater than 300
    // CLEAR greater than 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)

  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`()

  Returns the measured color of the sensor. The values have a range of 0 to 65535.

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

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

  The returned array has the keys `r`, `g`, `b` and `c`.

void `BrickletColor::``lightOn`()

  Turns the LED on.

void `BrickletColor::``lightOff`()

  Turns the LED off.

int `BrickletColor::``isLightOn`()

  Returns the state of the LED. Possible values are:

  - 0: On
  - 1: Off

  The following constants are available for this function:

  - BrickletColor::LIGHT_ON = 0
  - BrickletColor::LIGHT_OFF = 1

void `BrickletColor::``setConfig`(int $gain, int $integration_time)

  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 default values are 60x gain and 154ms integration time.

  The following constants are available for this function:

  - BrickletColor::GAIN_1X = 0
  - BrickletColor::GAIN_4X = 1
  - BrickletColor::GAIN_16X = 2
  - BrickletColor::GAIN_60X = 3
  - 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`()

  Returns the configuration as set by `setConfig()`.

  The following constants are available for this function:

  - BrickletColor::GAIN_1X = 0
  - BrickletColor::GAIN_4X = 1
  - BrickletColor::GAIN_16X = 2
  - BrickletColor::GAIN_60X = 3
  - 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

  The returned array has the keys `gain` and `integration_time`.

int `BrickletColor::``getIlluminance`()

  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 themself 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 the color temperature in Kelvin.

  To get a correct color temperature measurement make sure that the color values themself 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::``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 `BrickletColor::``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 `BrickletColor::``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 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:

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

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

array `BrickletColor::``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 `BrickletColor::``registerCallback`(int $id, callable $callback, mixed $userData=NULL)

  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.

void `BrickletColor::``setColorCallbackPeriod`(int $period)

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

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

  The default value is 0.

int `BrickletColor::``getColorCallbackPeriod`()

  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)

  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 default value is ('x', 0, 0, 0, 0, 0, 0, 0, 0).

  The following constants are available for this function:

  - 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`()

  Returns the threshold as set by `setColorCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletColor::THRESHOLD_OPTION_OFF = 'x'
  - BrickletColor::THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletColor::THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletColor::THRESHOLD_OPTION_SMALLER = '<'
  - BrickletColor::THRESHOLD_OPTION_GREATER = '>'

  The returned array has the keys `option`, `min_r`, `max_r`, `min_g`, `max_g`, `min_b`, `max_b`, `min_c` and `max_c`.

void `BrickletColor::``setDebouncePeriod`(int $debounce)

  Sets the period in ms with which the threshold callback

  - `CALLBACK_COLOR_REACHED`

  is triggered, if the threshold

  - `setColorCallbackThreshold()`

  keeps being reached.

  The default value is 100.

int `BrickletColor::``getDebouncePeriod`()

  Returns the debounce period as set by `setDebouncePeriod()`.

void `BrickletColor::``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.

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

  The default value is 0.

int `BrickletColor::``getIlluminanceCallbackPeriod`()

  Returns the period as set by `setIlluminanceCallbackPeriod()`.

void `BrickletColor::``setColorTemperatureCallbackPeriod`(int $period)

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

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

  The default value is 0.

int `BrickletColor::``getColorTemperatureCallbackPeriod`()

  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 $userData])   ?>

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

  `CALLBACK_COLOR` 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 $userData])   ?>

  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 $userData])   ?>

  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.

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

int `BrickletColor::``CALLBACK_COLOR_TEMPERATURE`

      <?php   void callback(int $color_temperature [, mixed $userData])   ?>

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

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

### Constants

int `BrickletColor::``DEVICE_IDENTIFIER`

  This constant is used to identify a Color Bricklet.

  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.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.