Struct tinkerforge::color_bricklet::ColorBricklet

pub struct ColorBricklet { /* fields omitted */ }

Measures color (RGB value), illuminance and color temperature

Methods

impl ColorBricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new(uid: &str, ip_connection: &IpConnection) -> ColorBricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected(     &mut self,     fun: ColorBrickletFunction ) -> Result<bool, GetResponseExpectedError>

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 set_response_expected. 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 set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected(     &mut self,     fun: ColorBrickletFunction,     response_expected: bool ) -> Result<(), SetResponseExpectedError>

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.

pub fn set_response_expected_all(&mut self, response_expected: bool)

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

pub fn get_api_version(&self) -> [u8; 3]

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.

pub fn get_color_callback_receiver(     &self ) -> ConvertingCallbackReceiver<ColorEvent>

This receiver is triggered periodically with the period that is set by set_color_callback_period. The parameter is the color of the sensor as RGBC.

The get_color_callback_receiver receiver is only triggered if the color has changed since the last triggering.

pub fn get_color_reached_callback_receiver(     &self ) -> ConvertingCallbackReceiver<ColorReachedEvent>

This receiver is triggered when the threshold as set by set_color_callback_threshold is reached. The parameter is the color of the sensor as RGBC.

If the threshold keeps being reached, the receiver is triggered periodically with the period as set by set_debounce_period.

pub fn get_illuminance_callback_receiver(     &self ) -> ConvertingCallbackReceiver<u32>

This receiver is triggered periodically with the period that is set by set_illuminance_callback_period. The parameter is the illuminance. See get_illuminance for how to interpret this value.

The get_illuminance_callback_receiver receiver is only triggered if the illuminance has changed since the last triggering.

pub fn get_color_temperature_callback_receiver(     &self ) -> ConvertingCallbackReceiver<u16>

This receiver is triggered periodically with the period that is set by set_color_temperature_callback_period. The parameter is the color temperature in Kelvin.

The get_color_temperature_callback_receiver receiver is only triggered if the color temperature has changed since the last triggering.

pub fn get_color(&self) -> ConvertingReceiver<Color>

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 get_color_callback_receiver receiver and set the period with set_color_callback_period.

pub fn set_color_callback_period(&self, period: u32) -> ConvertingReceiver<()>

Sets the period in ms with which the get_color_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

The get_color_callback_receiver receiver is only triggered if the color has changed since the last triggering.

The default value is 0.

pub fn get_color_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by set_color_callback_period.

pub fn set_color_callback_threshold(     &self,     option: char,     min_r: u16,     max_r: u16,     min_g: u16,     max_g: u16,     min_b: u16,     max_b: u16,     min_c: u16,     max_c: u16 ) -> ConvertingReceiver<()>

Sets the thresholds for the get_color_reached_callback_receiver receiver.

The following options are possible:

Option	Description
'x'	Receiver is turned off
'o'	Receiver is triggered when the temperature is outside the min and max values
'i'	Receiver is triggered when the temperature is inside the min and max values
'<'	Receiver is triggered when the temperature is smaller than the min value (max is ignored)
'>'	Receiver 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).

Associated constants:

• COLOR_BRICKLET_THRESHOLD_OPTION_OFF
• COLOR_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• COLOR_BRICKLET_THRESHOLD_OPTION_INSIDE
• COLOR_BRICKLET_THRESHOLD_OPTION_SMALLER
• COLOR_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_color_callback_threshold(     &self ) -> ConvertingReceiver<ColorCallbackThreshold>

Returns the threshold as set by set_color_callback_threshold.

Associated constants:

• COLOR_BRICKLET_THRESHOLD_OPTION_OFF
• COLOR_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• COLOR_BRICKLET_THRESHOLD_OPTION_INSIDE
• COLOR_BRICKLET_THRESHOLD_OPTION_SMALLER
• COLOR_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>

Sets the period in ms with which the threshold receiver

• get_color_reached_callback_receiver

is triggered, if the threshold

• set_color_callback_threshold

keeps being reached.

The default value is 100.

pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>

Returns the debounce period as set by set_debounce_period.

pub fn light_on(&self) -> ConvertingReceiver<()>

Turns the LED on.

pub fn light_off(&self) -> ConvertingReceiver<()>

Turns the LED off.

pub fn is_light_on(&self) -> ConvertingReceiver<u8>

Returns the state of the LED. Possible values are:

• 0: On
• 1: Off

Associated constants:

• COLOR_BRICKLET_LIGHT_ON
• COLOR_BRICKLET_LIGHT_OFF

pub fn set_config(     &self,     gain: u8,     integration_time: u8 ) -> ConvertingReceiver<()>

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.

Associated constants:

• COLOR_BRICKLET_GAIN_1X
• COLOR_BRICKLET_GAIN_4X
• COLOR_BRICKLET_GAIN_16X
• COLOR_BRICKLET_GAIN_60X
• COLOR_BRICKLET_INTEGRATION_TIME_2MS
• COLOR_BRICKLET_INTEGRATION_TIME_24MS
• COLOR_BRICKLET_INTEGRATION_TIME_101MS
• COLOR_BRICKLET_INTEGRATION_TIME_154MS
• COLOR_BRICKLET_INTEGRATION_TIME_700MS

pub fn get_config(&self) -> ConvertingReceiver<Config>

Returns the configuration as set by set_config.

Associated constants:

• COLOR_BRICKLET_GAIN_1X
• COLOR_BRICKLET_GAIN_4X
• COLOR_BRICKLET_GAIN_16X
• COLOR_BRICKLET_GAIN_60X
• COLOR_BRICKLET_INTEGRATION_TIME_2MS
• COLOR_BRICKLET_INTEGRATION_TIME_24MS
• COLOR_BRICKLET_INTEGRATION_TIME_101MS
• COLOR_BRICKLET_INTEGRATION_TIME_154MS
• COLOR_BRICKLET_INTEGRATION_TIME_700MS

pub fn get_illuminance(&self) -> ConvertingReceiver<u32>

Returns the illuminance affected by the gain and integration time as set by set_config. 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 set_config.

pub fn get_color_temperature(&self) -> ConvertingReceiver<u16>

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

pub fn set_illuminance_callback_period(     &self,     period: u32 ) -> ConvertingReceiver<()>

Sets the period in ms with which the get_illuminance_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

The get_illuminance_callback_receiver receiver is only triggered if the illuminance has changed since the last triggering.

The default value is 0.

pub fn get_illuminance_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by set_illuminance_callback_period.

pub fn set_color_temperature_callback_period(     &self,     period: u32 ) -> ConvertingReceiver<()>

Sets the period in ms with which the get_color_temperature_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

The get_color_temperature_callback_receiver receiver is only triggered if the color temperature has changed since the last triggering.

The default value is 0.

pub fn get_color_temperature_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by set_color_temperature_callback_period.

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

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

Trait Implementations

impl Clone for ColorBricklet

fn clone(&self) -> ColorBricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.