Struct tinkerforge::color_v2_bricklet::ColorV2Bricklet
source · pub struct ColorV2Bricklet { /* private fields */ }
Expand description
Measures color (RGB value), illuminance and color temperature
Implementations§
source§impl ColorV2Bricklet
impl ColorV2Bricklet
pub const DEVICE_IDENTIFIER: u16 = 2_128u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Color Bricklet 2.0"
sourcepub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> ColorV2Bricklet
pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> ColorV2Bricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: ColorV2BrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected( &mut self, fun: ColorV2BrickletFunction ) -> 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 sent 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.
sourcepub fn set_response_expected(
&mut self,
fun: ColorV2BrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected( &mut self, fun: ColorV2BrickletFunction, 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 sent and errors are silently ignored, because they cannot be detected.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
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.
sourcepub fn get_api_version(&self) -> [u8; 3]
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.
sourcepub fn get_color_callback_receiver(
&self
) -> ConvertingCallbackReceiver<ColorEvent>
pub fn get_color_callback_receiver( &self ) -> ConvertingCallbackReceiver<ColorEvent>
This receiver is triggered periodically with the period that is set by
set_color_callback_configuration
. 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.
sourcepub fn get_illuminance_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u32>
pub fn get_illuminance_callback_receiver( &self ) -> ConvertingCallbackReceiver<u32>
This receiver is triggered periodically according to the configuration set by
[set_illuminance_callback_configuration
].
The parameter is the same as [get_illuminance
].
sourcepub fn get_color_temperature_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>
pub fn get_color_temperature_callback_receiver( &self ) -> ConvertingCallbackReceiver<u16>
This receiver is triggered periodically according to the configuration set by
[set_color_temperature_callback_configuration
].
The parameter is the same as [get_color_temperature
].
sourcepub fn get_color(&self) -> ConvertingReceiver<Color>
pub fn get_color(&self) -> ConvertingReceiver<Color>
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:
.. 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_configuration
].
sourcepub fn set_color_callback_configuration(
&self,
period: u32,
value_has_to_change: bool
) -> ConvertingReceiver<()>
pub fn set_color_callback_configuration( &self, period: u32, value_has_to_change: bool ) -> ConvertingReceiver<()>
The period is the period with which the [get_color_callback_receiver
]
receiver is triggered periodically. A value of 0 turns the receiver off.
If the value has to change
-parameter is set to true, the receiver is only
triggered after the value has changed. If the value didn’t change within the
period, the receiver is triggered immediately on change.
If it is set to false, the receiver is continuously triggered with the period, independent of the value.
sourcepub fn get_color_callback_configuration(
&self
) -> ConvertingReceiver<ColorCallbackConfiguration>
pub fn get_color_callback_configuration( &self ) -> ConvertingReceiver<ColorCallbackConfiguration>
Returns the receiver configuration as set by
[set_color_callback_configuration
].
sourcepub fn get_illuminance(&self) -> ConvertingReceiver<u32>
pub fn get_illuminance(&self) -> ConvertingReceiver<u32>
Returns the illuminance affected by the gain and integration time as
set by [set_configuration
]. 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 [set_configuration
].
If you want to get the value periodically, it is recommended to use the
[get_illuminance_callback_receiver
] receiver. You can set the receiver configuration
with [set_illuminance_callback_configuration
].
sourcepub fn set_illuminance_callback_configuration(
&self,
period: u32,
value_has_to_change: bool,
option: char,
min: u32,
max: u32
) -> ConvertingReceiver<()>
pub fn set_illuminance_callback_configuration( &self, period: u32, value_has_to_change: bool, option: char, min: u32, max: u32 ) -> ConvertingReceiver<()>
The period is the period with which the [get_illuminance_callback_receiver
] receiver is triggered
periodically. A value of 0 turns the receiver off.
If the value has to change
-parameter is set to true, the receiver is only
triggered after the value has changed. If the value didn’t change
within the period, the receiver is triggered immediately on change.
If it is set to false, the receiver is continuously triggered with the period, independent of the value.
It is furthermore possible to constrain the receiver with thresholds.
The option
-parameter together with min/max sets a threshold for the [get_illuminance_callback_receiver
] receiver.
The following options are possible:
Option | Description |
---|---|
‘x’ | Threshold is turned off |
‘o’ | Threshold is triggered when the value is outside the min and max values |
‘i’ | Threshold is triggered when the value is inside or equal to the min and max values |
‘<’ | Threshold is triggered when the value is smaller than the min value (max is ignored) |
‘>’ | Threshold is triggered when the value is greater than the min value (max is ignored) |
If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.
Associated constants:
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_OFF
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_illuminance_callback_configuration(
&self
) -> ConvertingReceiver<IlluminanceCallbackConfiguration>
pub fn get_illuminance_callback_configuration( &self ) -> ConvertingReceiver<IlluminanceCallbackConfiguration>
Returns the receiver configuration as set by [set_illuminance_callback_configuration
].
Associated constants:
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_OFF
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_color_temperature(&self) -> ConvertingReceiver<u16>
pub fn get_color_temperature(&self) -> ConvertingReceiver<u16>
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 [set_configuration
].
If you want to get the value periodically, it is recommended to use the
[get_color_temperature_callback_receiver
] receiver. You can set the receiver configuration
with [set_color_temperature_callback_configuration
].
sourcepub fn set_color_temperature_callback_configuration(
&self,
period: u32,
value_has_to_change: bool,
option: char,
min: u16,
max: u16
) -> ConvertingReceiver<()>
pub fn set_color_temperature_callback_configuration( &self, period: u32, value_has_to_change: bool, option: char, min: u16, max: u16 ) -> ConvertingReceiver<()>
The period is the period with which the [get_color_temperature_callback_receiver
] receiver is triggered
periodically. A value of 0 turns the receiver off.
If the value has to change
-parameter is set to true, the receiver is only
triggered after the value has changed. If the value didn’t change
within the period, the receiver is triggered immediately on change.
If it is set to false, the receiver is continuously triggered with the period, independent of the value.
It is furthermore possible to constrain the receiver with thresholds.
The option
-parameter together with min/max sets a threshold for the [get_color_temperature_callback_receiver
] receiver.
The following options are possible:
Option | Description |
---|---|
‘x’ | Threshold is turned off |
‘o’ | Threshold is triggered when the value is outside the min and max values |
‘i’ | Threshold is triggered when the value is inside or equal to the min and max values |
‘<’ | Threshold is triggered when the value is smaller than the min value (max is ignored) |
‘>’ | Threshold is triggered when the value is greater than the min value (max is ignored) |
If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.
Associated constants:
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_OFF
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_color_temperature_callback_configuration(
&self
) -> ConvertingReceiver<ColorTemperatureCallbackConfiguration>
pub fn get_color_temperature_callback_configuration( &self ) -> ConvertingReceiver<ColorTemperatureCallbackConfiguration>
Returns the receiver configuration as set by [set_color_temperature_callback_configuration
].
Associated constants:
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_OFF
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- COLOR_V2_BRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn set_light(&self, enable: bool) -> ConvertingReceiver<()>
pub fn set_light(&self, enable: bool) -> ConvertingReceiver<()>
Turns the white LED on the Bricklet on/off.
sourcepub fn get_light(&self) -> ConvertingReceiver<bool>
pub fn get_light(&self) -> ConvertingReceiver<bool>
Returns the value as set by [set_light
].
sourcepub fn set_configuration(
&self,
gain: u8,
integration_time: u8
) -> ConvertingReceiver<()>
pub fn set_configuration( &self, gain: u8, integration_time: u8 ) -> ConvertingReceiver<()>
Sets the configuration of the sensor. Gain and integration time can be configured 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 to get the conversion results.
Associated constants:
- COLOR_V2_BRICKLET_GAIN_1X
- COLOR_V2_BRICKLET_GAIN_4X
- COLOR_V2_BRICKLET_GAIN_16X
- COLOR_V2_BRICKLET_GAIN_60X
- COLOR_V2_BRICKLET_INTEGRATION_TIME_2MS
- COLOR_V2_BRICKLET_INTEGRATION_TIME_24MS
- COLOR_V2_BRICKLET_INTEGRATION_TIME_101MS
- COLOR_V2_BRICKLET_INTEGRATION_TIME_154MS
- COLOR_V2_BRICKLET_INTEGRATION_TIME_700MS
sourcepub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
Returns the configuration as set by [set_configuration
].
Associated constants:
- COLOR_V2_BRICKLET_GAIN_1X
- COLOR_V2_BRICKLET_GAIN_4X
- COLOR_V2_BRICKLET_GAIN_16X
- COLOR_V2_BRICKLET_GAIN_60X
- COLOR_V2_BRICKLET_INTEGRATION_TIME_2MS
- COLOR_V2_BRICKLET_INTEGRATION_TIME_24MS
- COLOR_V2_BRICKLET_INTEGRATION_TIME_101MS
- COLOR_V2_BRICKLET_INTEGRATION_TIME_154MS
- COLOR_V2_BRICKLET_INTEGRATION_TIME_700MS
sourcepub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
- ACK checksum errors,
- message checksum errors,
- framing errors and
- overflow errors.
The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
sourcepub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
Sets the bootloader mode and returns the status after the requested mode change was instigated.
You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
Associated constants:
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- COLOR_V2_BRICKLET_BOOTLOADER_STATUS_OK
- COLOR_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
- COLOR_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
- COLOR_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- COLOR_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- COLOR_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH
sourcepub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
Returns the current bootloader mode, see [set_bootloader_mode
].
Associated constants:
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- COLOR_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
sourcepub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
Sets the firmware pointer for [write_firmware
]. The pointer has
to be increased by chunks of size 64. The data is written to flash
every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
sourcepub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
Writes 64 Bytes of firmware at the position as written by
[set_write_firmware_pointer
] before. The firmware is written
to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
sourcepub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.
You can also turn the LED permanently on/off or show a heartbeat.
If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
Associated constants:
- COLOR_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- COLOR_V2_BRICKLET_STATUS_LED_CONFIG_ON
- COLOR_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- COLOR_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
Returns the configuration as set by [set_status_led_config
]
Associated constants:
- COLOR_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- COLOR_V2_BRICKLET_STATUS_LED_CONFIG_ON
- COLOR_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- COLOR_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!
The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
sourcepub fn reset(&self) -> ConvertingReceiver<()>
pub fn reset(&self) -> ConvertingReceiver<()>
Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
sourcepub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
sourcepub fn read_uid(&self) -> ConvertingReceiver<u32>
pub fn read_uid(&self) -> ConvertingReceiver<u32>
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
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’, ‘d’, ‘e’, ‘f’, ‘g’ or ‘h’ (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position ‘z’.
The device identifier numbers can be found here. |device_identifier_constant|
Trait Implementations§
source§impl Clone for ColorV2Bricklet
impl Clone for ColorV2Bricklet
source§fn clone(&self) -> ColorV2Bricklet
fn clone(&self) -> ColorV2Bricklet
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more