Class: Tinkerforge::BrickletHumidityV2

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

Overview

Measures relative humidity

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

283
DEVICE_DISPLAY_NAME =

:nodoc:

'Humidity Bricklet 2.0'
CALLBACK_HUMIDITY =

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

The parameter is the same as BrickletHumidityV2#get_humidity.

4
CALLBACK_TEMPERATURE =

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

The parameter is the same as BrickletHumidityV2#get_temperature.

8
FUNCTION_GET_HUMIDITY =

:nodoc:

1
FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_GET_TEMPERATURE =

:nodoc:

5
FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_SET_HEATER_CONFIGURATION =

:nodoc:

9
FUNCTION_GET_HEATER_CONFIGURATION =

:nodoc:

10
FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION =

:nodoc:

11
FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION =

:nodoc:

12
FUNCTION_SET_SAMPLES_PER_SECOND =

:nodoc:

13
FUNCTION_GET_SAMPLES_PER_SECOND =

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

'>'
HEATER_CONFIG_DISABLED =

:nodoc:

0
HEATER_CONFIG_ENABLED =

:nodoc:

1
SPS_20 =

:nodoc:

0
SPS_10 =

:nodoc:

1
SPS_5 =

:nodoc:

2
SPS_1 =

:nodoc:

3
SPS_02 =

:nodoc:

4
SPS_01 =

:nodoc:

5
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) ⇒ BrickletHumidityV2

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



88
89
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
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 88

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

  @api_version = [2, 0, 2]

  @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_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_SET_HEATER_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_HEATER_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SAMPLES_PER_SECOND] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SAMPLES_PER_SECOND] = 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_HUMIDITY] = [10, 'S']
  @callback_formats[CALLBACK_TEMPERATURE] = [10, 's']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletHumidityV2#set_bootloader_mode.



325
326
327
328
329
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 325

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.



383
384
385
386
387
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 383

def get_chip_temperature
  check_validity

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

#get_heater_configuration ⇒ Object

Returns the heater configuration as set by BrickletHumidityV2#set_heater_configuration.



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

def get_heater_configuration
  check_validity

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

#get_humidity ⇒ Object

Returns the humidity measured by the sensor.

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



130
131
132
133
134
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 130

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 BrickletHumidityV2#set_humidity_callback_configuration.



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

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|



430
431
432
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 430

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

#get_moving_average_configuration ⇒ Object

Returns the moving average configuration as set by BrickletHumidityV2#set_moving_average_configuration.



260
261
262
263
264
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 260

def get_moving_average_configuration
  check_validity

  send_request FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION, [], '', 12, 'S S'
end

#get_samples_per_second ⇒ Object

Returnes the samples per second, as set by BrickletHumidityV2#set_samples_per_second.

.. versionadded

2.0.3$nbsp;(Plugin)



286
287
288
289
290
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 286

def get_samples_per_second
  check_validity

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



303
304
305
306
307
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 303

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



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

def get_status_led_config
  check_validity

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

#get_temperature ⇒ Object

Returns the temperature measured by the sensor.

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



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

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 BrickletHumidityV2#set_temperature_callback_configuration.



218
219
220
221
222
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 218

def get_temperature_callback_configuration
  check_validity

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

#read_uid ⇒ Object

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



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

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.



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

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!



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

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.



318
319
320
321
322
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 318

def set_bootloader_mode(mode)
  check_validity

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

#set_heater_configuration(heater_config) ⇒ Object

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.



226
227
228
229
230
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 226

def set_heater_configuration(heater_config)
  check_validity

  send_request FUNCTION_SET_HEATER_CONFIGURATION, [heater_config], 'C', 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.



161
162
163
164
165
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 161

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_moving_average_configuration(moving_average_length_humidity, moving_average_length_temperature) ⇒ Object

Sets the length of a ‘moving averaging <en.wikipedia.org/wiki/Moving_average>`__ for the humidity and temperature.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

New data is gathered every 50ms*. With a moving average of length 1000 the resulting averaging window has a length of 50s. If you want to do long term measurements the longest moving average will give the cleanest results.

* In firmware version 2.0.3 we added the BrickletHumidityV2#set_samples_per_second function. It configures the measurement frequency. Since high frequencies can result in self-heating of th IC, changed the default value from 20 samples per second to 1. With 1 sample per second a moving average length of 1000 would result in an averaging window of 1000 seconds!



253
254
255
256
257
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 253

def set_moving_average_configuration(moving_average_length_humidity, moving_average_length_temperature)
  check_validity

  send_request FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION, [moving_average_length_humidity, moving_average_length_temperature], 'S S', 8, ''
end

#set_samples_per_second(sps) ⇒ Object

Sets the samples per second that are gathered by the humidity/temperature sensor HDC1080.

We added this function since we found out that a high measurement frequency can lead to self-heating of the sensor. Which can distort the temperature measurement.

If you don’t need a lot of measurements, you can use the lowest available measurement frequency of 0.1 samples per second for the least amount of self-heating.

Before version 2.0.3 the default was 20 samples per second. The new default is 1 sample per second.

.. versionadded

2.0.3$nbsp;(Plugin)



277
278
279
280
281
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 277

def set_samples_per_second(sps)
  check_validity

  send_request FUNCTION_SET_SAMPLES_PER_SECOND, [sps], '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.



364
365
366
367
368
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 364

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.



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

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_write_firmware_pointer(pointer) ⇒ Object

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



337
338
339
340
341
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 337

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



351
352
353
354
355
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 351

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.



406
407
408
409
410
 
# File 'lib/tinkerforge/bricklet_humidity_v2.rb', line 406

def write_uid(uid)
  check_validity

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