Class: Tinkerforge::BrickletBarometerV2

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

Overview

Measures air pressure and altitude changes

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2117
DEVICE_DISPLAY_NAME =

:nodoc:

'Barometer Bricklet 2.0'
CALLBACK_AIR_PRESSURE =

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

The parameter is the same as BrickletBarometerV2#get_air_pressure.

4
CALLBACK_ALTITUDE =

This callback is triggered periodically according to the configuration set by BrickletBarometerV2#set_altitude_callback_configuration.

The parameter is the same as BrickletBarometerV2#get_altitude.

8
CALLBACK_TEMPERATURE =

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

The parameter is the same as BrickletBarometerV2#get_temperature.

12
FUNCTION_GET_AIR_PRESSURE =

:nodoc:

1
FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_GET_ALTITUDE =

:nodoc:

5
FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_ALTITUDE_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_TEMPERATURE =

:nodoc:

9
FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

10
FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

11
FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION =

:nodoc:

13
FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION =

:nodoc:

14
FUNCTION_SET_REFERENCE_AIR_PRESSURE =

:nodoc:

15
FUNCTION_GET_REFERENCE_AIR_PRESSURE =

:nodoc:

16
FUNCTION_SET_CALIBRATION =

:nodoc:

17
FUNCTION_GET_CALIBRATION =

:nodoc:

18
FUNCTION_SET_SENSOR_CONFIGURATION =

:nodoc:

19
FUNCTION_GET_SENSOR_CONFIGURATION =

:nodoc:

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

'>'
DATA_RATE_OFF =

:nodoc:

0
DATA_RATE_1HZ =

:nodoc:

1
DATA_RATE_10HZ =

:nodoc:

2
DATA_RATE_25HZ =

:nodoc:

3
DATA_RATE_50HZ =

:nodoc:

4
DATA_RATE_75HZ =

:nodoc:

5
LOW_PASS_FILTER_OFF =

:nodoc:

0
LOW_PASS_FILTER_1_9TH =

:nodoc:

1
LOW_PASS_FILTER_1_20TH =

:nodoc:

2
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) ⇒ BrickletBarometerV2

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_barometer_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_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_GET_ALTITUDE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ALTITUDE_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_MOVING_AVERAGE_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_REFERENCE_AIR_PRESSURE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_REFERENCE_AIR_PRESSURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CALIBRATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CALIBRATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SENSOR_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SENSOR_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_AIR_PRESSURE] = [12, 'l']
  @callback_formats[CALLBACK_ALTITUDE] = [12, 'l']
  @callback_formats[CALLBACK_TEMPERATURE] = [12, 'l']

  @ipcon.add_device self
end

Instance Method Details

#get_air_pressure ⇒ Object

Returns the measured 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 BrickletBarometerV2#set_air_pressure_callback_configuration.



148
149
150
151
152
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 148

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 BrickletBarometerV2#set_air_pressure_callback_configuration.



186
187
188
189
190
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 186

def get_air_pressure_callback_configuration
  check_validity

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

#get_altitude ⇒ Object

Returns the relative altitude of the air pressure sensor. The value is calculated based on the difference between the current air pressure and the reference air pressure that can be set with BrickletBarometerV2#set_reference_air_pressure.

If you want to get the value periodically, it is recommended to use the CALLBACK_ALTITUDE callback. You can set the callback configuration with BrickletBarometerV2#set_altitude_callback_configuration.



201
202
203
204
205
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 201

def get_altitude
  check_validity

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

#get_altitude_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletBarometerV2#set_altitude_callback_configuration.



239
240
241
242
243
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 239

def get_altitude_callback_configuration
  check_validity

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

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletBarometerV2#set_bootloader_mode.



428
429
430
431
432
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 428

def get_bootloader_mode
  check_validity

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

#get_calibration ⇒ Object

Returns the air pressure one point calibration values as set by BrickletBarometerV2#set_calibration.



366
367
368
369
370
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 366

def get_calibration
  check_validity

  send_request FUNCTION_GET_CALIBRATION, [], '', 16, 'l l'
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.



486
487
488
489
490
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 486

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, '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|



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

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 BrickletBarometerV2#set_moving_average_configuration.



316
317
318
319
320
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 316

def get_moving_average_configuration
  check_validity

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

#get_reference_air_pressure ⇒ Object

Returns the reference air pressure as set by BrickletBarometerV2#set_reference_air_pressure.



338
339
340
341
342
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 338

def get_reference_air_pressure
  check_validity

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

#get_sensor_configuration ⇒ Object

Returns the sensor configuration as set by BrickletBarometerV2#set_sensor_configuration.



389
390
391
392
393
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 389

def get_sensor_configuration
  check_validity

  send_request FUNCTION_GET_SENSOR_CONFIGURATION, [], '', 10, 'C 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.



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

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



474
475
476
477
478
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 474

def get_status_led_config
  check_validity

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

#get_temperature ⇒ Object

Returns the temperature of the air pressure sensor.

This temperature is used internally for temperature compensation of the air pressure measurement. It is not as accurate as the temperature measured by the :ref:‘temperature_v2_bricklet` or the :ref:`temperature_ir_v2_bricklet`.

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



256
257
258
259
260
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 256

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



294
295
296
297
298
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 294

def get_temperature_callback_configuration
  check_validity

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

#read_uid ⇒ Object

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



517
518
519
520
521
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 517

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.



538
539
540
541
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 538

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!



498
499
500
501
502
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 498

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.



179
180
181
182
183
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 179

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_altitude_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object

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



232
233
234
235
236
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 232

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

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



421
422
423
424
425
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 421

def set_bootloader_mode(mode)
  check_validity

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

#set_calibration(measured_air_pressure, actual_air_pressure) ⇒ Object

Sets the one point calibration (OPC) values for the air pressure measurement.

Before the Bricklet can be calibrated any previous calibration has to be removed by setting “measured air pressure“ and “actual air pressure“ to 0.

Then the current air pressure has to be measured using the Bricklet (“measured air pressure“) and with an accurate reference barometer (“actual air pressure“) at the same time and passed to this function.

After proper calibration the air pressure measurement can achieve an accuracy up to 0.2 hPa.

The calibration is saved in the EEPROM of the Bricklet and only needs to be configured once.



358
359
360
361
362
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 358

def set_calibration(measured_air_pressure, actual_air_pressure)
  check_validity

  send_request FUNCTION_SET_CALIBRATION, [measured_air_pressure, actual_air_pressure], 'l l', 8, ''
end

#set_moving_average_configuration(moving_average_length_air_pressure, moving_average_length_temperature) ⇒ Object

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

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

If you want to do long term measurements the longest moving average will give the cleanest results.



308
309
310
311
312
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 308

def set_moving_average_configuration(moving_average_length_air_pressure, moving_average_length_temperature)
  check_validity

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

#set_reference_air_pressure(air_pressure) ⇒ Object

Sets the reference air pressure for the altitude calculation. Setting the reference to the current air pressure results in a calculated altitude of 0mm. Passing 0 is a shortcut for passing the current air pressure as reference.

Well known reference values are the Q codes ‘QNH <en.wikipedia.org/wiki/QNH>`__ and `QFE <en.wikipedia.org/wiki/Mean_sea_level_pressure#Mean_sea_level_pressure>`__ used in aviation.



331
332
333
334
335
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 331

def set_reference_air_pressure(air_pressure)
  check_validity

  send_request FUNCTION_SET_REFERENCE_AIR_PRESSURE, [air_pressure], 'l', 8, ''
end

#set_sensor_configuration(data_rate, air_pressure_low_pass_filter) ⇒ Object

Configures the data rate and air pressure low pass filter. The low pass filter cut-off frequency (if enabled) can be set to 1/9th or 1/20th of the configure data rate to decrease the noise on the air pressure data.

The low pass filter configuration only applies to the air pressure measurement. There is no low pass filter for the temperature measurement.

A higher data rate will result in a less precise temperature because of self-heating of the sensor. If the accuracy of the temperature reading is important to you, we would recommend the 1Hz data rate.



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

def set_sensor_configuration(data_rate, air_pressure_low_pass_filter)
  check_validity

  send_request FUNCTION_SET_SENSOR_CONFIGURATION, [data_rate, air_pressure_low_pass_filter], 'C 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.



467
468
469
470
471
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 467

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.



287
288
289
290
291
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 287

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

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



440
441
442
443
444
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 440

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



454
455
456
457
458
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 454

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.



509
510
511
512
513
 
# File 'lib/tinkerforge/bricklet_barometer_v2.rb', line 509

def write_uid(uid)
  check_validity

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