Class: Tinkerforge::BrickletTemperatureIRV2

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

Overview

Measures contactless object temperature between -70°C and +380°C

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

291
DEVICE_DISPLAY_NAME =

:nodoc:

'Temperature IR Bricklet 2.0'
CALLBACK_AMBIENT_TEMPERATURE =

This callback is triggered periodically according to the configuration set by BrickletTemperatureIRV2#set_ambient_temperature_callback_configuration.

The parameter is the same as BrickletTemperatureIRV2#get_ambient_temperature.

4
CALLBACK_OBJECT_TEMPERATURE =

This callback is triggered periodically according to the configuration set by BrickletTemperatureIRV2#set_object_temperature_callback_configuration.

The parameter is the same as BrickletTemperatureIRV2#get_object_temperature.

8
FUNCTION_GET_AMBIENT_TEMPERATURE =

:nodoc:

1
FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_GET_OBJECT_TEMPERATURE =

:nodoc:

5
FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_SET_EMISSIVITY =

:nodoc:

9
FUNCTION_GET_EMISSIVITY =

:nodoc:

10
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) ⇒ BrickletTemperatureIRV2

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 76

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

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_GET_AMBIENT_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_OBJECT_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_EMISSIVITY] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_EMISSIVITY] = 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_AMBIENT_TEMPERATURE] = [10, 's']
  @callback_formats[CALLBACK_OBJECT_TEMPERATURE] = [10, 's']

  @ipcon.add_device self
end

Instance Method Details

#get_ambient_temperature ⇒ Object

Returns the ambient temperature of the sensor.

If you want to get the value periodically, it is recommended to use the CALLBACK_AMBIENT_TEMPERATURE callback. You can set the callback configuration with BrickletTemperatureIRV2#set_ambient_temperature_callback_configuration.



114
115
116
117
118
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 114

def get_ambient_temperature
  check_validity

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

#get_ambient_temperature_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletTemperatureIRV2#set_ambient_temperature_callback_configuration.



152
153
154
155
156
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 152

def get_ambient_temperature_callback_configuration
  check_validity

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

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletTemperatureIRV2#set_bootloader_mode.



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

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.



335
336
337
338
339
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 335

def get_chip_temperature
  check_validity

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

#get_emissivity ⇒ Object

Returns the emissivity as set by BrickletTemperatureIRV2#set_emissivity.



238
239
240
241
242
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 238

def get_emissivity
  check_validity

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



382
383
384
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 382

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

#get_object_temperature ⇒ Object

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their ‘emissivity <en.wikipedia.org/wiki/Emissivity>`__. The emissivity of the material can be set with BrickletTemperatureIRV2#set_emissivity.

If you want to get the value periodically, it is recommended to use the CALLBACK_OBJECT_TEMPERATURE callback. You can set the callback configuration with BrickletTemperatureIRV2#set_object_temperature_callback_configuration.



169
170
171
172
173
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 169

def get_object_temperature
  check_validity

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

#get_object_temperature_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletTemperatureIRV2#set_object_temperature_callback_configuration.



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

def get_object_temperature_callback_configuration
  check_validity

  send_request FUNCTION_GET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k s 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.



255
256
257
258
259
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 255

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



323
324
325
326
327
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 323

def get_status_led_config
  check_validity

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

#read_uid ⇒ Object

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



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

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.



387
388
389
390
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 387

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!



347
348
349
350
351
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 347

def reset
  check_validity

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

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

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



145
146
147
148
149
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 145

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

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



270
271
272
273
274
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 270

def set_bootloader_mode(mode)
  check_validity

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

#set_emissivity(emissivity) ⇒ Object

Sets the ‘emissivity <en.wikipedia.org/wiki/Emissivity>`__ that is used to calculate the surface temperature as returned by BrickletTemperatureIRV2#get_object_temperature.

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found ‘here <www.infrared-thermography.com/material.htm>`__.

The parameter of BrickletTemperatureIRV2#set_emissivity has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

.. note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.



231
232
233
234
235
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 231

def set_emissivity(emissivity)
  check_validity

  send_request FUNCTION_SET_EMISSIVITY, [emissivity], 'S', 8, ''
end

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

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



200
201
202
203
204
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 200

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

  send_request FUNCTION_SET_OBJECT_TEMPERATURE_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.



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

def set_status_led_config(config)
  check_validity

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

#set_write_firmware_pointer(pointer) ⇒ Object

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



289
290
291
292
293
 
# File 'lib/tinkerforge/bricklet_temperature_ir_v2.rb', line 289

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



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

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.



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

def write_uid(uid)
  check_validity

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