Class: Tinkerforge::BrickletCO2V2

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

Overview

Measures CO2 concentration, temperature and humidity

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2147
DEVICE_DISPLAY_NAME =

:nodoc:

'CO2 Bricklet 2.0'
CALLBACK_ALL_VALUES =

This callback is triggered periodically according to the configuration set by BrickletCO2V2#set_all_values_callback_configuration.

The parameters are the same as BrickletCO2V2#get_all_values.

.. note

The sensor is able to messure up to 120 °C. However it is only specified up to 70 °C. Exposing the Bricklet to higher temperatures might result in permanent damage.

8
CALLBACK_CO2_CONCENTRATION =

This callback is triggered periodically according to the configuration set by BrickletCO2V2#set_co2_concentration_callback_configuration.

The parameter is the same as BrickletCO2V2#get_co2_concentration.

12
CALLBACK_TEMPERATURE =

This callback is triggered periodically according to the configuration set by BrickletCO2V2#set_temperature_callback_configuration.

The parameter is the same as BrickletCO2V2#get_temperature.

16
CALLBACK_HUMIDITY =

This callback is triggered periodically according to the configuration set by BrickletCO2V2#set_humidity_callback_configuration.

The parameter is the same as BrickletCO2V2#get_humidity.

20
FUNCTION_GET_ALL_VALUES =

:nodoc:

1
FUNCTION_SET_AIR_PRESSURE =

:nodoc:

2
FUNCTION_GET_AIR_PRESSURE =

:nodoc:

3
FUNCTION_SET_TEMPERATURE_OFFSET =

:nodoc:

4
FUNCTION_GET_TEMPERATURE_OFFSET =

:nodoc:

5
FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_CO2_CONCENTRATION =

:nodoc:

9
FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION =

:nodoc:

10
FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION =

:nodoc:

11
FUNCTION_GET_TEMPERATURE =

:nodoc:

13
FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

14
FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

15
FUNCTION_GET_HUMIDITY =

:nodoc:

17
FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION =

:nodoc:

18
FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION =

:nodoc:

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

'>'
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) ⇒ BrickletCO2V2

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



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 100

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_ALL_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_AIR_PRESSURE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_AIR_PRESSURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_TEMPERATURE_OFFSET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_TEMPERATURE_OFFSET] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CO2_CONCENTRATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_HUMIDITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_HUMIDITY_CALLBACK_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_ALL_VALUES] = [14, 'S s S']
  @callback_formats[CALLBACK_CO2_CONCENTRATION] = [10, 'S']
  @callback_formats[CALLBACK_TEMPERATURE] = [10, 's']
  @callback_formats[CALLBACK_HUMIDITY] = [10, 'S']

  @ipcon.add_device self
end

Instance Method Details

#get_air_pressure ⇒ Object

Returns the ambient air pressure as set by BrickletCO2V2#set_air_pressure.



175
176
177
178
179
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 175

def get_air_pressure
  check_validity

  send_request FUNCTION_GET_AIR_PRESSURE, [], '', 10, 'S'
end

#get_all_values ⇒ Object

Returns all values measured by the CO2 Bricklet 2.0.

If you want to get the values periodically, it is recommended to use the CALLBACK_ALL_VALUES callback. You can set the callback configuration with BrickletCO2V2#set_all_values_callback_configuration.

.. note

The sensor is able to messure up to 120 °C. However it is only specified up to 70 °C. Exposing the Bricklet to higher temperatures might result in permanent damage.



151
152
153
154
155
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 151

def get_all_values
  check_validity

  send_request FUNCTION_GET_ALL_VALUES, [], '', 14, 'S s S'
end

#get_all_values_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletCO2V2#set_all_values_callback_configuration.



230
231
232
233
234
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 230

def get_all_values_callback_configuration
  check_validity

  send_request FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletCO2V2#set_bootloader_mode.



423
424
425
426
427
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 423

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.



481
482
483
484
485
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 481

def get_chip_temperature
  check_validity

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

#get_co2_concentration ⇒ Object

Returns CO2 concentration.

If you want to get the value periodically, it is recommended to use the CALLBACK_CO2_CONCENTRATION callback. You can set the callback configuration with BrickletCO2V2#set_co2_concentration_callback_configuration.



242
243
244
245
246
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 242

def get_co2_concentration
  check_validity

  send_request FUNCTION_GET_CO2_CONCENTRATION, [], '', 10, 'S'
end

#get_co2_concentration_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletCO2V2#set_co2_concentration_callback_configuration.



280
281
282
283
284
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 280

def get_co2_concentration_callback_configuration
  check_validity

  send_request FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S'
end

#get_humidity ⇒ Object

Returns relative humidity.

If you want to get the value periodically, it is recommended to use the CALLBACK_HUMIDITY callback. You can set the callback configuration with BrickletCO2V2#set_humidity_callback_configuration.



346
347
348
349
350
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 346

def get_humidity
  check_validity

  send_request FUNCTION_GET_HUMIDITY, [], '', 10, 'S'
end

#get_humidity_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletCO2V2#set_humidity_callback_configuration.



384
385
386
387
388
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 384

def get_humidity_callback_configuration
  check_validity

  send_request FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S'
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|



528
529
530
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 528

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
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.



401
402
403
404
405
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 401

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 BrickletCO2V2#set_status_led_config



469
470
471
472
473
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 469

def get_status_led_config
  check_validity

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

#get_temperature ⇒ Object

Returns temperature.

.. note

The sensor is able to messure up to 120 °C. However it is only specified up to 70 °C. Exposing the Bricklet to higher temperatures might result in permanent damage.

If you want to get the value periodically, it is recommended to use the CALLBACK_TEMPERATURE callback. You can set the callback configuration with BrickletCO2V2#set_temperature_callback_configuration.



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

def get_temperature
  check_validity

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

#get_temperature_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletCO2V2#set_temperature_callback_configuration.



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

def get_temperature_callback_configuration
  check_validity

  send_request FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k s s'
end

#get_temperature_offset ⇒ Object

Returns the temperature offset as set by BrickletCO2V2#set_temperature_offset.



207
208
209
210
211
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 207

def get_temperature_offset
  check_validity

  send_request FUNCTION_GET_TEMPERATURE_OFFSET, [], '', 10, 'S'
end

#read_uid ⇒ Object

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



512
513
514
515
516
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 512

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.



533
534
535
536
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 533

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!



493
494
495
496
497
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 493

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_air_pressure(air_pressure) ⇒ Object

The CO2 concentration depends (among other things) on the ambient air pressure.

To increase the accuracy of the CO2 Bricklet 2.0 you can set the current air pressure. You use the :ref:‘Barometer Bricklet 2.0 <barometer_v2_bricklet>` or the :ref:`Air Quality Bricklet <air_quality_bricklet>` to get the current air pressure.

By default air pressure compensation is disabled. Once you set a value it will be used for compensation. You can turn the compensation off again by setting the value to 0.

It is sufficient to update the value every few minutes.



168
169
170
171
172
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 168

def set_air_pressure(air_pressure)
  check_validity

  send_request FUNCTION_SET_AIR_PRESSURE, [air_pressure], 'S', 8, ''
end

#set_all_values_callback_configuration(period, value_has_to_change) ⇒ Object

The period is the period with which the CALLBACK_ALL_VALUES 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 at least one of the values has changed. If the values 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.



222
223
224
225
226
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 222

def set_all_values_callback_configuration(period, value_has_to_change)
  check_validity

  send_request FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 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.



416
417
418
419
420
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 416

def set_bootloader_mode(mode)
  check_validity

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

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

The period is the period with which the CALLBACK_CO2_CONCENTRATION 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_CO2_CONCENTRATION 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.



273
274
275
276
277
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 273

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

  send_request FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 8, ''
end

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

The period is the period with which the CALLBACK_HUMIDITY 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_HUMIDITY 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.



377
378
379
380
381
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 377

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

  send_request FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 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.



462
463
464
465
466
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 462

def set_status_led_config(config)
  check_validity

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

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

The period is the period with which the CALLBACK_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_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.



327
328
329
330
331
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 327

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

  send_request FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 8, ''
end

#set_temperature_offset(offset) ⇒ Object

Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C.

If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure.

We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset.

This temperature offset is used to calculate the relative humidity and CO2 concentration. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to improve the accuracy of the measurements.

It is sufficient to set the temperature offset once. The offset is saved in non-volatile memory and is applied again after a power loss.



199
200
201
202
203
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 199

def set_temperature_offset(offset)
  check_validity

  send_request FUNCTION_SET_TEMPERATURE_OFFSET, [offset], 'S', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

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



435
436
437
438
439
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 435

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



449
450
451
452
453
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 449

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.



504
505
506
507
508
 
# File 'lib/tinkerforge/bricklet_co2_v2.rb', line 504

def write_uid(uid)
  check_validity

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