Class: Tinkerforge::BrickletHallEffectV2

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

Overview

Measures magnetic flux density between -7mT and +7mT

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2132
DEVICE_DISPLAY_NAME =

:nodoc:

'Hall Effect Bricklet 2.0'
CALLBACK_MAGNETIC_FLUX_DENSITY =

This callback is triggered periodically according to the configuration set by BrickletHallEffectV2#set_magnetic_flux_density_callback_configuration.

The parameter is the same as BrickletHallEffectV2#get_magnetic_flux_density.

4
CALLBACK_COUNTER =

This callback is triggered periodically according to the configuration set by BrickletHallEffectV2#set_counter_callback_configuration.

The count is the same as you would get with BrickletHallEffectV2#get_counter.

10
FUNCTION_GET_MAGNETIC_FLUX_DENSITY =

:nodoc:

1
FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_GET_COUNTER =

:nodoc:

5
FUNCTION_SET_COUNTER_CONFIG =

:nodoc:

6
FUNCTION_GET_COUNTER_CONFIG =

:nodoc:

7
FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION =

:nodoc:

8
FUNCTION_GET_COUNTER_CALLBACK_CONFIGURATION =

:nodoc:

9
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) ⇒ BrickletHallEffectV2

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_hall_effect_v2.rb', line 76

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_MAGNETIC_FLUX_DENSITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_COUNTER] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_COUNTER_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_COUNTER_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_COUNTER_CALLBACK_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_MAGNETIC_FLUX_DENSITY] = [10, 's']
  @callback_formats[CALLBACK_COUNTER] = [12, 'L']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletHallEffectV2#set_bootloader_mode.



250
251
252
253
254
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 250

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.



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

def get_chip_temperature
  check_validity

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

#get_counter(reset_counter) ⇒ Object

Returns the current value of the counter.

You can configure the low/high thresholds and the debounce time with BrickletHallEffectV2#set_counter_config.

If you set reset counter to true, the count is set back to 0 directly after it is read.

If you want to get the count periodically, it is recommended to use the CALLBACK_COUNTER callback. You can set the callback configuration with BrickletHallEffectV2#set_counter_callback_configuration.



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

def get_counter(reset_counter)
  check_validity

  send_request FUNCTION_GET_COUNTER, [reset_counter], '?', 12, 'L'
end

#get_counter_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletHallEffectV2#set_counter_callback_configuration.



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

def get_counter_callback_configuration
  check_validity

  send_request FUNCTION_GET_COUNTER_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
end

#get_counter_config ⇒ Object

Returns the counter config as set by BrickletHallEffectV2#set_counter_config.



188
189
190
191
192
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 188

def get_counter_config
  check_validity

  send_request FUNCTION_GET_COUNTER_CONFIG, [], '', 16, 's s L'
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|



355
356
357
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 355

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

#get_magnetic_flux_density ⇒ Object

Returns the ‘magnetic flux density (magnetic induction) <en.wikipedia.org/wiki/Magnetic_flux>`__.

If you want to get the value periodically, it is recommended to use the CALLBACK_MAGNETIC_FLUX_DENSITY callback. You can set the callback configuration with BrickletHallEffectV2#set_magnetic_flux_density_callback_configuration.



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

def get_magnetic_flux_density
  check_validity

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

#get_magnetic_flux_density_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletHallEffectV2#set_magnetic_flux_density_callback_configuration.



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

def get_magnetic_flux_density_callback_configuration
  check_validity

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



228
229
230
231
232
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 228

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



296
297
298
299
300
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 296

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.



339
340
341
342
343
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 339

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.



360
361
362
363
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 360

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!



320
321
322
323
324
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 320

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.



243
244
245
246
247
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 243

def set_bootloader_mode(mode)
  check_validity

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

#set_counter_callback_configuration(period, value_has_to_change) ⇒ Object

The period is the period with which the CALLBACK_COUNTER 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 at least one of the values has changed. If the values 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.



203
204
205
206
207
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 203

def set_counter_callback_configuration(period, value_has_to_change)
  check_validity

  send_request FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
end

#set_counter_config(high_threshold, low_threshold, debounce) ⇒ Object

Sets a high and a low threshold as well as a debounce time.

If the measured magnetic flux density goes above the high threshold or below the low threshold, the count of the counter is increased by 1.

The debounce time is the minimum time between two count increments.



181
182
183
184
185
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 181

def set_counter_config(high_threshold, low_threshold, debounce)
  check_validity

  send_request FUNCTION_SET_COUNTER_CONFIG, [high_threshold, low_threshold, debounce], 's s L', 8, ''
end

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

The period is the period with which the CALLBACK_MAGNETIC_FLUX_DENSITY 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_MAGNETIC_FLUX_DENSITY 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_hall_effect_v2.rb', line 145

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

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



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

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



262
263
264
265
266
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 262

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



276
277
278
279
280
 
# File 'lib/tinkerforge/bricklet_hall_effect_v2.rb', line 276

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.



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

def write_uid(uid)
  check_validity

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