Class: Tinkerforge::BrickletAirQuality

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

Overview

Measures IAQ index, temperature, humidity and air pressure

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

297
DEVICE_DISPLAY_NAME =

:nodoc:

'Air Quality Bricklet'
CALLBACK_ALL_VALUES =

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

The parameters are the same as BrickletAirQuality#get_all_values.

6
CALLBACK_IAQ_INDEX =

This callback is triggered periodically according to the configuration set by BrickletAirQuality#set_iaq_index_callback_configuration.

The parameters are the same as BrickletAirQuality#get_iaq_index.

10
CALLBACK_TEMPERATURE =

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

The parameter is the same as BrickletAirQuality#get_temperature.

14
CALLBACK_HUMIDITY =

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

The parameter is the same as BrickletAirQuality#get_humidity.

18
CALLBACK_AIR_PRESSURE =

This callback is triggered periodically according to the configuration set by BrickletAirQuality#set_air_pressure_callback_configuration.

The parameter is the same as BrickletAirQuality#get_air_pressure.

22
FUNCTION_GET_ALL_VALUES =

:nodoc:

1
FUNCTION_SET_TEMPERATURE_OFFSET =

:nodoc:

2
FUNCTION_GET_TEMPERATURE_OFFSET =

:nodoc:

3
FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION =

:nodoc:

4
FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION =

:nodoc:

5
FUNCTION_GET_IAQ_INDEX =

:nodoc:

7
FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION =

:nodoc:

8
FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION =

:nodoc:

9
FUNCTION_GET_TEMPERATURE =

:nodoc:

11
FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

12
FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

13
FUNCTION_GET_HUMIDITY =

:nodoc:

15
FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION =

:nodoc:

16
FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION =

:nodoc:

17
FUNCTION_GET_AIR_PRESSURE =

:nodoc:

19
FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION =

:nodoc:

20
FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION =

:nodoc:

21
FUNCTION_REMOVE_CALIBRATION =

:nodoc:

23
FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION =

:nodoc:

24
FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION =

:nodoc:

25
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
ACCURACY_UNRELIABLE =

:nodoc:

0
ACCURACY_LOW =

:nodoc:

1
ACCURACY_MEDIUM =

:nodoc:

2
ACCURACY_HIGH =

:nodoc:

3
THRESHOLD_OPTION_OFF =

:nodoc:

'x'
THRESHOLD_OPTION_OUTSIDE =

:nodoc:

'o'
THRESHOLD_OPTION_INSIDE =

:nodoc:

'i'
THRESHOLD_OPTION_SMALLER =

:nodoc:

'<'
THRESHOLD_OPTION_GREATER =

:nodoc:

'>'
DURATION_4_DAYS =

:nodoc:

0
DURATION_28_DAYS =

:nodoc:

1
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) ⇒ BrickletAirQuality

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



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 112

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

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_GET_ALL_VALUES] = 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_IAQ_INDEX] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_IAQ_INDEX_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_AIR_PRESSURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_REMOVE_CALIBRATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION] = 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] = [25, 'l C l l l']
  @callback_formats[CALLBACK_IAQ_INDEX] = [13, 'l C']
  @callback_formats[CALLBACK_TEMPERATURE] = [12, 'l']
  @callback_formats[CALLBACK_HUMIDITY] = [12, 'l']
  @callback_formats[CALLBACK_AIR_PRESSURE] = [12, 'l']

  @ipcon.add_device self
end

Instance Method Details

#get_air_pressure ⇒ Object

Returns air pressure.

If you want to get the value periodically, it is recommended to use the CALLBACK_AIR_PRESSURE callback. You can set the callback configuration with BrickletAirQuality#set_air_pressure_callback_configuration.



371
372
373
374
375
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 371

def get_air_pressure
  check_validity

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

#get_air_pressure_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletAirQuality#set_air_pressure_callback_configuration.



409
410
411
412
413
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 409

def get_air_pressure_callback_configuration
  check_validity

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

#get_all_values ⇒ Object

Returns all values measured by the Air Quality Bricklet. The values are IAQ (Indoor Air Quality) Index (higher value means greater level of air pollution), IAQ Index Accuracy, Temperature, Humidity and Air Pressure.

.. image

/Images/Misc/bricklet_air_quality_iaq_index.png

:scale: 100 %
:alt: Air Quality Index description
:align: center
:target: ../../_images/Misc/bricklet_air_quality_iaq_index.png



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

def get_all_values
  check_validity

  send_request FUNCTION_GET_ALL_VALUES, [], '', 25, 'l C l l l'
end

#get_all_values_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletAirQuality#set_all_values_callback_configuration.



219
220
221
222
223
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 219

def get_all_values_callback_configuration
  check_validity

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

#get_background_calibration_duration ⇒ Object

Returns the background calibration duration as set by BrickletAirQuality#set_background_calibration_duration.

.. versionadded

2.0.3$nbsp;(Plugin)



463
464
465
466
467
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 463

def get_background_calibration_duration
  check_validity

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

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletAirQuality#set_bootloader_mode.



502
503
504
505
506
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 502

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.



560
561
562
563
564
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 560

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, '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 BrickletAirQuality#set_humidity_callback_configuration.



321
322
323
324
325
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 321

def get_humidity
  check_validity

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

#get_humidity_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletAirQuality#set_humidity_callback_configuration.



359
360
361
362
363
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 359

def get_humidity_callback_configuration
  check_validity

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

#get_iaq_index ⇒ Object

Returns the IAQ index and accuracy. The higher the IAQ index, the greater the level of air pollution.

.. image

/Images/Misc/bricklet_air_quality_iaq_index.png

:scale: 100 %
:alt: IAQ index description
:align: center
:target: ../../_images/Misc/bricklet_air_quality_iaq_index.png

If you want to get the value periodically, it is recommended to use the CALLBACK_IAQ_INDEX callback. You can set the callback configuration with BrickletAirQuality#set_iaq_index_callback_configuration.



236
237
238
239
240
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 236

def get_iaq_index
  check_validity

  send_request FUNCTION_GET_IAQ_INDEX, [], '', 13, 'l C'
end

#get_iaq_index_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletAirQuality#set_iaq_index_callback_configuration.



259
260
261
262
263
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 259

def get_iaq_index_callback_configuration
  check_validity

  send_request FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
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|



607
608
609
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 607

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.



480
481
482
483
484
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 480

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



548
549
550
551
552
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 548

def get_status_led_config
  check_validity

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

#get_temperature ⇒ Object

Returns temperature.

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



271
272
273
274
275
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 271

def get_temperature
  check_validity

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

#get_temperature_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletAirQuality#set_temperature_callback_configuration.



309
310
311
312
313
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 309

def get_temperature_callback_configuration
  check_validity

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

#get_temperature_offset ⇒ Object

Returns the temperature offset as set by BrickletAirQuality#set_temperature_offset.



196
197
198
199
200
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 196

def get_temperature_offset
  check_validity

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

#read_uid ⇒ Object

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



591
592
593
594
595
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 591

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.



612
613
614
615
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 612

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

#remove_calibration ⇒ Object

Deletes the calibration from flash. After you call this function, you need to power cycle the Air Quality Bricklet.

On the next power up the Bricklet will start a new calibration, as if it was started for the very first time.

The calibration is based on the data of the last four days, so it takes four days until a full calibration is re-established.

.. versionadded

2.0.3$nbsp;(Plugin)



425
426
427
428
429
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 425

def remove_calibration
  check_validity

  send_request FUNCTION_REMOVE_CALIBRATION, [], '', 8, ''
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!



572
573
574
575
576
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 572

def reset
  check_validity

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

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

The period is the period with which the CALLBACK_AIR_PRESSURE 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_AIR_PRESSURE 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.



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

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

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



211
212
213
214
215
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 211

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_background_calibration_duration(duration) ⇒ Object

The Air Quality Bricklet uses an automatic background calibration mechanism to calculate the IAQ Index. This calibration mechanism considers a history of measured data. The duration of this history can be configured to either be 4 days or 28 days.

If you keep the Bricklet mostly at one place and it does not get moved around to different environments, we recommend that you use a duration of 28 days.

If you change the duration, the current calibration will be discarded and the calibration will start from beginning again. The configuration of the duration is saved in flash, so you should only have to call this function once in the lifetime of the Bricklet.

The Bricklet has to be power cycled after this function is called for a duration change to take effect.

Before firmware version 2.0.3 this was not configurable and the duration was 4 days.

The default value (since firmware version 2.0.3) is 28 days.

.. versionadded

2.0.3$nbsp;(Plugin)



453
454
455
456
457
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 453

def set_background_calibration_duration(duration)
  check_validity

  send_request FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION, [duration], 'C', 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.



495
496
497
498
499
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 495

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
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.



352
353
354
355
356
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 352

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 l l', 8, ''
end

#set_iaq_index_callback_configuration(period, value_has_to_change) ⇒ Object

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



251
252
253
254
255
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 251

def set_iaq_index_callback_configuration(period, value_has_to_change)
  check_validity

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



541
542
543
544
545
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 541

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.



302
303
304
305
306
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 302

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 l l', 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 IAQ index measurements. 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.



188
189
190
191
192
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 188

def set_temperature_offset(offset)
  check_validity

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

#set_write_firmware_pointer(pointer) ⇒ Object

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



514
515
516
517
518
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 514

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



528
529
530
531
532
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 528

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.



583
584
585
586
587
 
# File 'lib/tinkerforge/bricklet_air_quality.rb', line 583

def write_uid(uid)
  check_validity

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