Class: Tinkerforge::BrickletColorV2
- Defined in:
- lib/tinkerforge/bricklet_color_v2.rb
Overview
Measures color (RGB value), illuminance and color temperature
Constant Summary collapse
- DEVICE_IDENTIFIER =
:nodoc:
2128
- DEVICE_DISPLAY_NAME =
:nodoc:
'Color Bricklet 2.0'
- CALLBACK_COLOR =
This callback is triggered periodically with the period that is set by BrickletColorV2#set_color_callback_configuration. 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.
4
- CALLBACK_ILLUMINANCE =
This callback is triggered periodically according to the configuration set by BrickletColorV2#set_illuminance_callback_configuration.
The parameter is the same as BrickletColorV2#get_illuminance.
8
- CALLBACK_COLOR_TEMPERATURE =
This callback is triggered periodically according to the configuration set by BrickletColorV2#set_color_temperature_callback_configuration.
The parameter is the same as BrickletColorV2#get_color_temperature.
12
- FUNCTION_GET_COLOR =
:nodoc:
1
- FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION =
:nodoc:
2
- FUNCTION_GET_COLOR_CALLBACK_CONFIGURATION =
:nodoc:
3
- FUNCTION_GET_ILLUMINANCE =
:nodoc:
5
- FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION =
:nodoc:
6
- FUNCTION_GET_ILLUMINANCE_CALLBACK_CONFIGURATION =
:nodoc:
7
- FUNCTION_GET_COLOR_TEMPERATURE =
:nodoc:
9
- FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION =
:nodoc:
10
- FUNCTION_GET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION =
:nodoc:
11
- FUNCTION_SET_LIGHT =
:nodoc:
13
- FUNCTION_GET_LIGHT =
:nodoc:
14
- FUNCTION_SET_CONFIGURATION =
:nodoc:
15
- FUNCTION_GET_CONFIGURATION =
:nodoc:
16
- FUNCTION_GET_SPITFP_ERROR_COUNT =
:nodoc:
234
- FUNCTION_SET_BOOTLOADER_MODE =
:nodoc:
235
- FUNCTION_GET_BOOTLOADER_MODE =
:nodoc:
236
- FUNCTION_SET_WRITE_FIRMWARE_POINTER =
:nodoc:
237
- FUNCTION_WRITE_FIRMWARE =
:nodoc:
238
- FUNCTION_SET_STATUS_LED_CONFIG =
:nodoc:
239
- FUNCTION_GET_STATUS_LED_CONFIG =
:nodoc:
240
- FUNCTION_GET_CHIP_TEMPERATURE =
:nodoc:
242
- FUNCTION_RESET =
:nodoc:
243
- FUNCTION_WRITE_UID =
:nodoc:
248
- FUNCTION_READ_UID =
:nodoc:
249
- FUNCTION_GET_IDENTITY =
:nodoc:
255
- THRESHOLD_OPTION_OFF =
:nodoc:
'x'
- THRESHOLD_OPTION_OUTSIDE =
:nodoc:
'o'
- THRESHOLD_OPTION_INSIDE =
:nodoc:
'i'
- THRESHOLD_OPTION_SMALLER =
:nodoc:
'<'
- THRESHOLD_OPTION_GREATER =
:nodoc:
'>'
- GAIN_1X =
:nodoc:
0
- GAIN_4X =
:nodoc:
1
- GAIN_16X =
:nodoc:
2
- GAIN_60X =
:nodoc:
3
- INTEGRATION_TIME_2MS =
:nodoc:
0
- INTEGRATION_TIME_24MS =
:nodoc:
1
- INTEGRATION_TIME_101MS =
:nodoc:
2
- INTEGRATION_TIME_154MS =
:nodoc:
3
- INTEGRATION_TIME_700MS =
:nodoc:
4
- BOOTLOADER_MODE_BOOTLOADER =
:nodoc:
0
- BOOTLOADER_MODE_FIRMWARE =
:nodoc:
1
- BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =
:nodoc:
2
- BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =
:nodoc:
3
- BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =
:nodoc:
4
- BOOTLOADER_STATUS_OK =
:nodoc:
0
- BOOTLOADER_STATUS_INVALID_MODE =
:nodoc:
1
- BOOTLOADER_STATUS_NO_CHANGE =
:nodoc:
2
- BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =
:nodoc:
3
- BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =
:nodoc:
4
- BOOTLOADER_STATUS_CRC_MISMATCH =
:nodoc:
5
- STATUS_LED_CONFIG_OFF =
:nodoc:
0
- STATUS_LED_CONFIG_ON =
:nodoc:
1
- STATUS_LED_CONFIG_SHOW_HEARTBEAT =
:nodoc:
2
- STATUS_LED_CONFIG_SHOW_STATUS =
:nodoc:
3
Constants inherited from Device
Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE
Instance Attribute Summary
Attributes inherited from Device
#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #high_level_callbacks, #registered_callbacks, #replaced, #uid
Instance Method Summary collapse
-
#get_bootloader_mode ⇒ Object
Returns the current bootloader mode, see BrickletColorV2#set_bootloader_mode.
-
#get_chip_temperature ⇒ Object
Returns the temperature as measured inside the microcontroller.
-
#get_color ⇒ Object
Returns the measured color of the sensor.
-
#get_color_callback_configuration ⇒ Object
Returns the callback configuration as set by BrickletColorV2#set_color_callback_configuration.
-
#get_color_temperature ⇒ Object
Returns the color temperature.
-
#get_color_temperature_callback_configuration ⇒ Object
Returns the callback configuration as set by BrickletColorV2#set_color_temperature_callback_configuration.
-
#get_configuration ⇒ Object
Returns the configuration as set by BrickletColorV2#set_configuration.
-
#get_identity ⇒ Object
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.
-
#get_illuminance ⇒ Object
Returns the illuminance affected by the gain and integration time as set by BrickletColorV2#set_configuration.
-
#get_illuminance_callback_configuration ⇒ Object
Returns the callback configuration as set by BrickletColorV2#set_illuminance_callback_configuration.
-
#get_light ⇒ Object
Returns the value as set by BrickletColorV2#set_light.
-
#get_spitfp_error_count ⇒ Object
Returns the error count for the communication between Brick and Bricklet.
-
#get_status_led_config ⇒ Object
Returns the configuration as set by BrickletColorV2#set_status_led_config.
-
#initialize(uid, ipcon) ⇒ BrickletColorV2
constructor
Creates an object with the unique device ID
uid
and adds it to the IP Connectionipcon
. -
#read_uid ⇒ Object
Returns the current UID as an integer.
-
#register_callback(id, &block) ⇒ Object
Registers a callback with ID
id
to the blockblock
. -
#reset ⇒ Object
Calling this function will reset the Bricklet.
-
#set_bootloader_mode(mode) ⇒ Object
Sets the bootloader mode and returns the status after the requested mode change was instigated.
-
#set_color_callback_configuration(period, value_has_to_change) ⇒ Object
The period is the period with which the CALLBACK_COLOR callback is triggered periodically.
-
#set_color_temperature_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object
The period is the period with which the CALLBACK_COLOR_TEMPERATURE callback is triggered periodically.
-
#set_configuration(gain, integration_time) ⇒ Object
Sets the configuration of the sensor.
-
#set_illuminance_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object
The period is the period with which the CALLBACK_ILLUMINANCE callback is triggered periodically.
-
#set_light(enable) ⇒ Object
Turns the white LED on the Bricklet on/off.
-
#set_status_led_config(config) ⇒ Object
Sets the status LED configuration.
-
#set_write_firmware_pointer(pointer) ⇒ Object
Sets the firmware pointer for BrickletColorV2#write_firmware.
-
#write_firmware(data) ⇒ Object
Writes 64 Bytes of firmware at the position as written by BrickletColorV2#set_write_firmware_pointer before.
-
#write_uid(uid) ⇒ Object
Writes a new UID into flash.
Methods inherited from Device
#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all
Constructor Details
#initialize(uid, ipcon) ⇒ BrickletColorV2
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
Instance Method Details
#get_bootloader_mode ⇒ Object
Returns the current bootloader mode, see BrickletColorV2#set_bootloader_mode.
378 379 380 381 382 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 378 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end |
#get_chip_temperature ⇒ Object
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.
436 437 438 439 440 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 436 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end |
#get_color ⇒ Object
Returns the measured color of the sensor.
The red ®, green (g), blue (b) and clear © 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_COLOR callback and set the period with BrickletColorV2#set_color_callback_configuration.
151 152 153 154 155 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 151 def get_color check_validity send_request FUNCTION_GET_COLOR, [], '', 16, 'S S S S' end |
#get_color_callback_configuration ⇒ Object
Returns the callback configuration as set by BrickletColorV2#set_color_callback_configuration.
174 175 176 177 178 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 174 def get_color_callback_configuration check_validity send_request FUNCTION_GET_COLOR_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end |
#get_color_temperature ⇒ Object
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 BrickletColorV2#set_configuration.
If you want to get the value periodically, it is recommended to use the CALLBACK_COLOR_TEMPERATURE callback. You can set the callback configuration with BrickletColorV2#set_color_temperature_callback_configuration.
249 250 251 252 253 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 249 def get_color_temperature check_validity send_request FUNCTION_GET_COLOR_TEMPERATURE, [], '', 10, 'S' end |
#get_color_temperature_callback_configuration ⇒ Object
Returns the callback configuration as set by BrickletColorV2#set_color_temperature_callback_configuration.
287 288 289 290 291 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 287 def get_color_temperature_callback_configuration check_validity send_request FUNCTION_GET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S' end |
#get_configuration ⇒ Object
Returns the configuration as set by BrickletColorV2#set_configuration.
339 340 341 342 343 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 339 def get_configuration check_validity send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C C' end |
#get_identity ⇒ Object
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 :ref:‘Isolator Bricklet <isolator_bricklet>` is always at position ’z’.
The device identifier numbers can be found :ref:‘here <device_identifier>`. |device_identifier_constant|
483 484 485 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 483 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end |
#get_illuminance ⇒ Object
Returns the illuminance affected by the gain and integration time as
- set by BrickletColorV2#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 BrickletColorV2#set_configuration.
If you want to get the value periodically, it is recommended to use the CALLBACK_ILLUMINANCE callback. You can set the callback configuration with BrickletColorV2#set_illuminance_callback_configuration.
194 195 196 197 198 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 194 def get_illuminance check_validity send_request FUNCTION_GET_ILLUMINANCE, [], '', 12, 'L' end |
#get_illuminance_callback_configuration ⇒ Object
Returns the callback configuration as set by BrickletColorV2#set_illuminance_callback_configuration.
232 233 234 235 236 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 232 def get_illuminance_callback_configuration check_validity send_request FUNCTION_GET_ILLUMINANCE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k L L' end |
#get_light ⇒ Object
Returns the value as set by BrickletColorV2#set_light.
301 302 303 304 305 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 301 def get_light check_validity send_request FUNCTION_GET_LIGHT, [], '', 9, '?' end |
#get_spitfp_error_count ⇒ Object
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.
356 357 358 359 360 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 356 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end |
#get_status_led_config ⇒ Object
Returns the configuration as set by BrickletColorV2#set_status_led_config
424 425 426 427 428 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 424 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end |
#read_uid ⇒ Object
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
467 468 469 470 471 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 467 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end |
#register_callback(id, &block) ⇒ Object
Registers a callback with ID id
to the block block
.
488 489 490 491 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 488 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end |
#reset ⇒ Object
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!
448 449 450 451 452 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 448 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end |
#set_bootloader_mode(mode) ⇒ Object
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.
371 372 373 374 375 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 371 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end |
#set_color_callback_configuration(period, value_has_to_change) ⇒ Object
The period is the period with which the CALLBACK_COLOR callback is triggered periodically. A value of 0 turns the callback off.
If the ‘value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn’t change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
166 167 168 169 170 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 166 def set_color_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end |
#set_color_temperature_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object
The period is the period with which the CALLBACK_COLOR_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.
If the ‘value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn’t change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
It is furthermore possible to constrain the callback with thresholds.
The ‘option`-parameter together with min/max sets a threshold for the CALLBACK_COLOR_TEMPERATURE callback.
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 callback is triggered with the fixed period.
280 281 282 283 284 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 280 def set_color_temperature_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 8, '' end |
#set_configuration(gain, integration_time) ⇒ Object
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.
332 333 334 335 336 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 332 def set_configuration(gain, integration_time) check_validity send_request FUNCTION_SET_CONFIGURATION, [gain, integration_time], 'C C', 8, '' end |
#set_illuminance_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object
The period is the period with which the CALLBACK_ILLUMINANCE callback is triggered periodically. A value of 0 turns the callback off.
If the ‘value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn’t change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
It is furthermore possible to constrain the callback with thresholds.
The ‘option`-parameter together with min/max sets a threshold for the CALLBACK_ILLUMINANCE callback.
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 callback is triggered with the fixed period.
225 226 227 228 229 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 225 def set_illuminance_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k L L', 8, '' end |
#set_light(enable) ⇒ Object
Turns the white LED on the Bricklet on/off.
294 295 296 297 298 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 294 def set_light(enable) check_validity send_request FUNCTION_SET_LIGHT, [enable], '?', 8, '' end |
#set_status_led_config(config) ⇒ Object
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.
417 418 419 420 421 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 417 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end |
#set_write_firmware_pointer(pointer) ⇒ Object
Sets the firmware pointer for BrickletColorV2#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.
390 391 392 393 394 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 390 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end |
#write_firmware(data) ⇒ Object
Writes 64 Bytes of firmware at the position as written by BrickletColorV2#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.
404 405 406 407 408 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 404 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end |
#write_uid(uid) ⇒ Object
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.
459 460 461 462 463 |
# File 'lib/tinkerforge/bricklet_color_v2.rb', line 459 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end |