Class: Tinkerforge::BrickletDistanceIRV2

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

Overview

Measures distance up to 150cm with infrared light

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2125
DEVICE_DISPLAY_NAME =

:nodoc:

'Distance IR Bricklet 2.0'
CALLBACK_DISTANCE =

This callback is triggered periodically according to the configuration set by BrickletDistanceIRV2#set_distance_callback_configuration.

The parameter is the same as BrickletDistanceIRV2#get_distance.

4
CALLBACK_ANALOG_VALUE =

This callback is triggered periodically according to the configuration set by BrickletDistanceIRV2#set_analog_value_callback_configuration.

The parameter is the same as BrickletDistanceIRV2#get_analog_value.

8
FUNCTION_GET_DISTANCE =

:nodoc:

1
FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_DISTANCE_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_GET_ANALOG_VALUE =

:nodoc:

5
FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_ANALOG_VALUE_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION =

:nodoc:

9
FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION =

:nodoc:

10
FUNCTION_SET_DISTANCE_LED_CONFIG =

:nodoc:

11
FUNCTION_GET_DISTANCE_LED_CONFIG =

:nodoc:

12
FUNCTION_SET_SENSOR_TYPE =

:nodoc:

13
FUNCTION_GET_SENSOR_TYPE =

:nodoc:

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

'>'
DISTANCE_LED_CONFIG_OFF =

:nodoc:

0
DISTANCE_LED_CONFIG_ON =

:nodoc:

1
DISTANCE_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
DISTANCE_LED_CONFIG_SHOW_DISTANCE =

:nodoc:

3
SENSOR_TYPE_2Y0A41 =

:nodoc:

0
SENSOR_TYPE_2Y0A21 =

:nodoc:

1
SENSOR_TYPE_2Y0A02 =

: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) ⇒ BrickletDistanceIRV2

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 87

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

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_GET_DISTANCE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DISTANCE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_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_DISTANCE_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_DISTANCE_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SENSOR_TYPE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SENSOR_TYPE] = 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_DISTANCE] = [10, 'S']
  @callback_formats[CALLBACK_ANALOG_VALUE] = [12, 'L']

  @ipcon.add_device self
end

Instance Method Details

#get_analog_value ⇒ Object

Returns the analog value as read by a analog-to-digital converter.

This is unfiltered raw data. We made sure that the integration time of the ADC is shorter then the measurement interval of the sensor (10ms vs 16.5ms). So there is no information lost.

If you want to do your own calibration or create your own lookup table you can use this value.

If you want to get the value periodically, it is recommended to use the CALLBACK_ANALOG_VALUE callback. You can set the callback configuration with BrickletDistanceIRV2#set_analog_value_callback_configuration.



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

def get_analog_value
  check_validity

  send_request FUNCTION_GET_ANALOG_VALUE, [], '', 12, 'L'
end

#get_analog_value_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletDistanceIRV2#set_analog_value_callback_configuration.



226
227
228
229
230
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 226

def get_analog_value_callback_configuration
  check_validity

  send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k L L'
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletDistanceIRV2#set_bootloader_mode.



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

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.



381
382
383
384
385
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 381

def get_chip_temperature
  check_validity

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

#get_distance ⇒ Object

Returns the distance measured by the sensor. Possible distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the selected IR sensor.

If you want to get the value periodically, it is recommended to use the CALLBACK_DISTANCE callback. You can set the callback configuration with BrickletDistanceIRV2#set_distance_callback_configuration.



131
132
133
134
135
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 131

def get_distance
  check_validity

  send_request FUNCTION_GET_DISTANCE, [], '', 10, 'S'
end

#get_distance_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletDistanceIRV2#set_distance_callback_configuration.



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

def get_distance_callback_configuration
  check_validity

  send_request FUNCTION_GET_DISTANCE_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S'
end

#get_distance_led_config ⇒ Object

Returns the LED configuration as set by BrickletDistanceIRV2#set_distance_led_config



263
264
265
266
267
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 263

def get_distance_led_config
  check_validity

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



428
429
430
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 428

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



248
249
250
251
252
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 248

def get_moving_average_configuration
  check_validity

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

#get_sensor_type ⇒ Object

Returns the sensor type as set by BrickletDistanceIRV2#set_sensor_type.



284
285
286
287
288
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 284

def get_sensor_type
  check_validity

  send_request FUNCTION_GET_SENSOR_TYPE, [], '', 9, '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.



301
302
303
304
305
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 301

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



369
370
371
372
373
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 369

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.



412
413
414
415
416
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 412

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.



433
434
435
436
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 433

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!



393
394
395
396
397
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 393

def reset
  check_validity

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

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

The period is the period with which the CALLBACK_ANALOG_VALUE 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_ANALOG_VALUE 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.



219
220
221
222
223
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 219

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

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



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

def set_bootloader_mode(mode)
  check_validity

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

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

The period is the period with which the CALLBACK_DISTANCE 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_DISTANCE 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.



162
163
164
165
166
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 162

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

  send_request FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 8, ''
end

#set_distance_led_config(config) ⇒ Object

Configures the distance LED to be either turned off, turned on, blink in heartbeat mode or show the distance (brighter = object is nearer).



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

def set_distance_led_config(config)
  check_validity

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

#set_moving_average_configuration(moving_average_length) ⇒ Object

Sets the length of a ‘moving averaging <en.wikipedia.org/wiki/Moving_average>`__ for the distance.

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

New data is gathered every ~10ms. With a moving average of length 1000 the resulting averaging window has a length of approximately 10s. If you want to do long term measurements the longest moving average will give the cleanest results.



241
242
243
244
245
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 241

def set_moving_average_configuration(moving_average_length)
  check_validity

  send_request FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION, [moving_average_length], 'S', 8, ''
end

#set_sensor_type(sensor) ⇒ Object

Sets the sensor type.

The Bricklet comes configured with the correct sensor type and the type is saved in flash (i.e. the Bricklet retains the information if power is lost).

If you want to change the sensor you can set the type in Brick Viewer, you will likely never need to call this function from your program.



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

def set_sensor_type(sensor)
  check_validity

  send_request FUNCTION_SET_SENSOR_TYPE, [sensor], '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.



362
363
364
365
366
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 362

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



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

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



349
350
351
352
353
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 349

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.



404
405
406
407
408
 
# File 'lib/tinkerforge/bricklet_distance_ir_v2.rb', line 404

def write_uid(uid)
  check_validity

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