Class: Tinkerforge::BrickletTemperatureV2

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

Overview

Measures ambient temperature with 0.2°C accuracy

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2113
DEVICE_DISPLAY_NAME =

:nodoc:

'Temperature Bricklet 2.0'
CALLBACK_TEMPERATURE =

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

The parameter is the same as BrickletTemperatureV2#get_temperature.

4
FUNCTION_GET_TEMPERATURE =

:nodoc:

1
FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_SET_HEATER_CONFIGURATION =

:nodoc:

5
FUNCTION_GET_HEATER_CONFIGURATION =

:nodoc:

6
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
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) ⇒ BrickletTemperatureV2

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 69

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

  @api_version = [2, 0, 0]

  @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_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_TEMPERATURE] = [10, 's']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletTemperatureV2#set_bootloader_mode.



194
195
196
197
198
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 194

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.



252
253
254
255
256
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 252

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 BrickletTemperatureV2#set_heater_configuration.



155
156
157
158
159
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 155

def get_heater_configuration
  check_validity

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



299
300
301
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 299

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.



172
173
174
175
176
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 172

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



240
241
242
243
244
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 240

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



103
104
105
106
107
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 103

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



141
142
143
144
145
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 141

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.



283
284
285
286
287
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 283

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.



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

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!



264
265
266
267
268
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 264

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.



187
188
189
190
191
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 187

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 test the sensor.



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

def set_heater_configuration(heater_config)
  check_validity

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



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

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.



134
135
136
137
138
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 134

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



206
207
208
209
210
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 206

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



220
221
222
223
224
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 220

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.



275
276
277
278
279
 
# File 'lib/tinkerforge/bricklet_temperature_v2.rb', line 275

def write_uid(uid)
  check_validity

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