class Tinkerforge::BrickletHumidityV2
Measures relative humidity
Constants
- 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
.- 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
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 87 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
Public Instance Methods
Returns the current bootloader mode, see BrickletHumidityV2#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 324 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 382 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
Returns the heater configuration as set by BrickletHumidityV2#set_heater_configuration
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 232 def get_heater_configuration check_validity send_request FUNCTION_GET_HEATER_CONFIGURATION, [], '', 9, 'C' end
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
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 129 def get_humidity check_validity send_request FUNCTION_GET_HUMIDITY, [], '', 10, 'S' end
Returns the callback configuration as set by BrickletHumidityV2#set_humidity_callback_configuration
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 167 def get_humidity_callback_configuration check_validity send_request FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S' end
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|
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 429 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the moving average configuration as set by BrickletHumidityV2#set_moving_average_configuration
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 259 def get_moving_average_configuration check_validity send_request FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION, [], '', 12, 'S S' end
Returnes the samples per second, as set by BrickletHumidityV2#set_samples_per_second
.
- .. versionadded
-
2.0.3$nbsp;(Plugin)
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 285 def get_samples_per_second check_validity send_request FUNCTION_GET_SAMPLES_PER_SECOND, [], '', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 302 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletHumidityV2#set_status_led_config
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 370 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
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
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 179 def get_temperature check_validity send_request FUNCTION_GET_TEMPERATURE, [], '', 10, 's' end
Returns the callback configuration as set by BrickletHumidityV2#set_temperature_callback_configuration
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 217 def get_temperature_callback_configuration check_validity send_request FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k s s' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 413 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 434 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
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!
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 394 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 317 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 225 def set_heater_configuration(heater_config) check_validity send_request FUNCTION_SET_HEATER_CONFIGURATION, [heater_config], 'C', 8, '' end
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 160 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
Sets the length of a `moving averaging <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!
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 252 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
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)
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 276 def set_samples_per_second(sps) check_validity send_request FUNCTION_SET_SAMPLES_PER_SECOND, [sps], 'C', 8, '' end
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 363 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 210 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
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 336 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 350 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_humidity_v2.rb, line 405 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end