Class: Tinkerforge::BrickletUVLightV2

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_uv_light_v2.rb

Overview

Measures UV-A, UV-B and UV index

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2118
DEVICE_DISPLAY_NAME =

:nodoc:

'UV Light Bricklet 2.0'
CALLBACK_UVA =

This callback is triggered periodically according to the configuration set by BrickletUVLightV2#set_uva_callback_configuration.

The parameter is the same as BrickletUVLightV2#get_uva.

4
CALLBACK_UVB =

This callback is triggered periodically according to the configuration set by BrickletUVLightV2#set_uvb_callback_configuration.

The parameter is the same as BrickletUVLightV2#get_uvb.

8
CALLBACK_UVI =

This callback is triggered periodically according to the configuration set by BrickletUVLightV2#set_uvi_callback_configuration.

The parameter is the same as BrickletUVLightV2#get_uvi.

12
FUNCTION_GET_UVA =

:nodoc:

1
FUNCTION_SET_UVA_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_UVA_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_GET_UVB =

:nodoc:

5
FUNCTION_SET_UVB_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_UVB_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_UVI =

:nodoc:

9
FUNCTION_SET_UVI_CALLBACK_CONFIGURATION =

:nodoc:

10
FUNCTION_GET_UVI_CALLBACK_CONFIGURATION =

:nodoc:

11
FUNCTION_SET_CONFIGURATION =

:nodoc:

13
FUNCTION_GET_CONFIGURATION =

:nodoc:

14
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:

'>'
INTEGRATION_TIME_50MS =

:nodoc:

0
INTEGRATION_TIME_100MS =

:nodoc:

1
INTEGRATION_TIME_200MS =

:nodoc:

2
INTEGRATION_TIME_400MS =

:nodoc:

3
INTEGRATION_TIME_800MS =

: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

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

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 90

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_UVA] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_UVA_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_UVA_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_UVB] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_UVB_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_UVB_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_UVI] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_UVI_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_UVI_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_UVA] = [12, 'l']
  @callback_formats[CALLBACK_UVB] = [12, 'l']
  @callback_formats[CALLBACK_UVI] = [12, 'l']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_modeObject

Returns the current bootloader mode, see BrickletUVLightV2#set_bootloader_mode.



356
357
358
359
360
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 356

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_chip_temperatureObject

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.



414
415
416
417
418
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 414

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_configurationObject

Returns the configuration as set by BrickletUVLightV2#set_configuration.



317
318
319
320
321
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 317

def get_configuration
  check_validity

  send_request FUNCTION_GET_CONFIGURATION, [], '', 9, 'C'
end

#get_identityObject

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|



461
462
463
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 461

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_spitfp_error_countObject

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.



334
335
336
337
338
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 334

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_status_led_configObject

Returns the configuration as set by BrickletUVLightV2#set_status_led_config



402
403
404
405
406
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 402

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#get_uvaObject

Returns the UVA intensity of the sensor. The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVA index. To get the UV index use BrickletUVLightV2#get_uvi.

If the sensor is saturated, then -1 is returned, see BrickletUVLightV2#set_configuration.

If you want to get the intensity periodically, it is recommended to use the CALLBACK_UVA callback and set the period with BrickletUVLightV2#set_uva_callback_configuration.

If you want to get the value periodically, it is recommended to use the CALLBACK_UVA callback. You can set the callback configuration with BrickletUVLightV2#set_uva_callback_configuration.



142
143
144
145
146
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 142

def get_uva
  check_validity

  send_request FUNCTION_GET_UVA, [], '', 12, 'l'
end

#get_uva_callback_configurationObject

Returns the callback configuration as set by BrickletUVLightV2#set_uva_callback_configuration.



180
181
182
183
184
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 180

def get_uva_callback_configuration
  check_validity

  send_request FUNCTION_GET_UVA_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
end

#get_uvbObject

Returns the UVB intensity of the sensor. The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVB index. To get the UV index use BrickletUVLightV2#get_uvi.

If the sensor is saturated, then -1 is returned, see BrickletUVLightV2#set_configuration.

If you want to get the intensity periodically, it is recommended to use the CALLBACK_UVB callback and set the period with BrickletUVLightV2#set_uvb_callback_configuration.

If you want to get the value periodically, it is recommended to use the CALLBACK_UVB callback. You can set the callback configuration with BrickletUVLightV2#set_uvb_callback_configuration.



202
203
204
205
206
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 202

def get_uvb
  check_validity

  send_request FUNCTION_GET_UVB, [], '', 12, 'l'
end

#get_uvb_callback_configurationObject

Returns the callback configuration as set by BrickletUVLightV2#set_uvb_callback_configuration.



240
241
242
243
244
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 240

def get_uvb_callback_configuration
  check_validity

  send_request FUNCTION_GET_UVB_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
end

#get_uviObject

Returns the UV index of the sensor, the index is given in 1/10.

If the sensor is saturated, then -1 is returned, see BrickletUVLightV2#set_configuration.

If you want to get the intensity periodically, it is recommended to use the CALLBACK_UVI callback and set the period with BrickletUVLightV2#set_uvi_callback_configuration.

If you want to get the value periodically, it is recommended to use the CALLBACK_UVI callback. You can set the callback configuration with BrickletUVLightV2#set_uvi_callback_configuration.



258
259
260
261
262
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 258

def get_uvi
  check_validity

  send_request FUNCTION_GET_UVI, [], '', 12, 'l'
end

#get_uvi_callback_configurationObject

Returns the callback configuration as set by BrickletUVLightV2#set_uvi_callback_configuration.



296
297
298
299
300
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 296

def get_uvi_callback_configuration
  check_validity

  send_request FUNCTION_GET_UVI_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
end

#read_uidObject

Returns the current UID as an integer. Encode as Base58 to get the usual string version.



445
446
447
448
449
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 445

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.



466
467
468
469
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 466

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#resetObject

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!



426
427
428
429
430
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 426

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.



349
350
351
352
353
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 349

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_configuration(integration_time) ⇒ Object

Sets the configuration of the sensor. The integration time can be configured between 50 and 800 ms. With a shorter integration time the sensor reading updates more often but contains more noise. With a longer integration the sensor reading contains less noise but updates less often.

With a longer integration time (especially 800 ms) and a higher UV intensity the sensor can be saturated. If this happens the UVA/UVB/UVI readings are all -1. In this case you need to choose a shorter integration time.



310
311
312
313
314
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 310

def set_configuration(integration_time)
  check_validity

  send_request FUNCTION_SET_CONFIGURATION, [integration_time], 'C', 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.



395
396
397
398
399
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 395

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_uva_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object

The period is the period with which the CALLBACK_UVA 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_UVA 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.



173
174
175
176
177
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 173

def set_uva_callback_configuration(period, value_has_to_change, option, min, max)
  check_validity

  send_request FUNCTION_SET_UVA_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
end

#set_uvb_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object

The period is the period with which the CALLBACK_UVB 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_UVB 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.



233
234
235
236
237
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 233

def set_uvb_callback_configuration(period, value_has_to_change, option, min, max)
  check_validity

  send_request FUNCTION_SET_UVB_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
end

#set_uvi_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object

The period is the period with which the CALLBACK_UVI 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_UVI 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.



289
290
291
292
293
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 289

def set_uvi_callback_configuration(period, value_has_to_change, option, min, max)
  check_validity

  send_request FUNCTION_SET_UVI_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

Sets the firmware pointer for BrickletUVLightV2#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.



368
369
370
371
372
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 368

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 BrickletUVLightV2#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.



382
383
384
385
386
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 382

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.



437
438
439
440
441
# File 'lib/tinkerforge/bricklet_uv_light_v2.rb', line 437

def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end