Tinkerforge::BrickletColor - Measures color (RGB value), illuminance and color temperature
This constant is used to identify a Color Bricklet.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a Color Bricklet.
This constant is used with the register_callback() subroutine to specify the CALLBACK_COLOR callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_COLOR_REACHED callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ILLUMINANCE callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_COLOR_TEMPERATURE callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
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:
.. image:: /Images/Bricklets/bricklet_color_wavelength_chart_600.jpg :scale: 100 % :alt: Chart Responsivity / Wavelength :align: center :target: ../../_images/Bricklets/bricklet_color_wavelength_chart_600.jpg
If you want to get the color periodically, it is recommended to use the callback :func:`Color` and set the period with :func:`SetColorCallbackPeriod`.
Sets the period in ms with which the :func:`Color` callback is triggered periodically. A value of 0 turns the callback off.
:func:`Color` is only triggered if the color has changed since the last triggering.
The default value is 0.
Returns the period as set by :func:`SetColorCallbackPeriod`.
Sets the thresholds for the :func:`ColorReached` callback.
The following options are possible:
.. csv-table:: :header: "Option", "Description" :widths: 10, 100
"'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).
Returns the threshold as set by :func:`SetColorCallbackThreshold`.
Sets the period in ms with which the threshold callback
* :func:`ColorReached`
is triggered, if the threshold
* :func:`SetColorCallbackThreshold`
keeps being reached.
The default value is 100.
Returns the debounce period as set by :func:`SetDebouncePeriod`.
Turns the LED on.
Turns the LED off.
Returns the state of the LED. Possible values are:
* 0: On * 1: Off
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.
Returns the configuration as set by :func:`SetConfig`.
Returns the illuminance affected by the gain and integration time as set by :func:`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 :func:`SetConfig`.
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 :func:`SetConfig`.
Sets the period in ms with which the :func:`Illuminance` callback is triggered periodically. A value of 0 turns the callback off.
:func:`Illuminance` is only triggered if the illuminance has changed since the last triggering.
Returns the period as set by :func:`SetIlluminanceCallbackPeriod`.
Sets the period in ms with which the :func:`ColorTemperature` callback is triggered periodically. A value of 0 turns the callback off.
:func:`ColorTemperature` is only triggered if the color temperature has changed since the last triggering.
Returns the period as set by :func:`SetColorTemperatureCallbackPeriod`.
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 :ref:`here <device_identifier>`. |device_identifier_constant|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.