Class: Tinkerforge::BrickletDistanceIR

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

Overview

Measures distance up to 150cm with infrared light

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

25
DEVICE_DISPLAY_NAME =

:nodoc:

'Distance IR Bricklet'
CALLBACK_DISTANCE =

This callback is triggered periodically with the period that is set by BrickletDistanceIR#set_distance_callback_period. The parameter is the distance of the sensor.

CALLBACK_DISTANCE is only triggered if the distance has changed since the last triggering.

15
CALLBACK_ANALOG_VALUE =

This callback is triggered periodically with the period that is set by BrickletDistanceIR#set_analog_value_callback_period. The parameter is the analog value of the sensor.

CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the last triggering.

16
CALLBACK_DISTANCE_REACHED =

This callback is triggered when the threshold as set by BrickletDistanceIR#set_distance_callback_threshold is reached. The parameter is the distance of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by BrickletDistanceIR#set_debounce_period.

17
CALLBACK_ANALOG_VALUE_REACHED =

This callback is triggered when the threshold as set by BrickletDistanceIR#set_analog_value_callback_threshold is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by BrickletDistanceIR#set_debounce_period.

18
FUNCTION_GET_DISTANCE =

:nodoc:

1
FUNCTION_GET_ANALOG_VALUE =

:nodoc:

2
FUNCTION_SET_SAMPLING_POINT =

:nodoc:

3
FUNCTION_GET_SAMPLING_POINT =

:nodoc:

4
FUNCTION_SET_DISTANCE_CALLBACK_PERIOD =

:nodoc:

5
FUNCTION_GET_DISTANCE_CALLBACK_PERIOD =

:nodoc:

6
FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD =

:nodoc:

7
FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD =

:nodoc:

8
FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD =

:nodoc:

9
FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD =

:nodoc:

10
FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD =

:nodoc:

11
FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD =

:nodoc:

12
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

13
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

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

'>'

Constants inherited from Device

Device::RESPONSE_EXPECTED_ALWAYS_FALSE, 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, #registered_callbacks, #uid

Instance Method Summary collapse

Methods inherited from Device

#dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletDistanceIR

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



74
75
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
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 74

def initialize(uid, ipcon)
  super uid, ipcon

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_GET_DISTANCE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SAMPLING_POINT] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SAMPLING_POINT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DISTANCE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DISTANCE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[CALLBACK_DISTANCE] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_DISTANCE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_ANALOG_VALUE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_DISTANCE] = 'S'
  @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
  @callback_formats[CALLBACK_DISTANCE_REACHED] = 'S'
  @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
end

Instance Method Details

#get_analog_value ⇒ Object

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

.. note

The value returned by BrickletDistanceIR#get_distance is averaged over several samples to yield less noise, while BrickletDistanceIR#get_analog_value gives back raw unfiltered analog values. The only reason to use BrickletDistanceIR#get_analog_value is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the callback CALLBACK_ANALOG_VALUE and set the period with BrickletDistanceIR#set_analog_value_callback_period.



128
129
130
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 128

def get_analog_value
  send_request(FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S')
end

#get_analog_value_callback_period ⇒ Object

Returns the period as set by BrickletDistanceIR#set_analog_value_callback_period.



188
189
190
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 188

def get_analog_value_callback_period
  send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 4, 'L')
end

#get_analog_value_callback_threshold ⇒ Object

Returns the threshold as set by BrickletDistanceIR#set_analog_value_callback_threshold.



232
233
234
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 232

def get_analog_value_callback_threshold
  send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
end

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletDistanceIR#set_debounce_period.



254
255
256
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 254

def get_debounce_period
  send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
end

#get_distance ⇒ Object

Returns the distance measured by the sensor. The value is in mm and 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 distance periodically, it is recommended to use the callback CALLBACK_DISTANCE and set the period with BrickletDistanceIR#set_distance_callback_period.



112
113
114
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 112

def get_distance
  send_request(FUNCTION_GET_DISTANCE, [], '', 2, 'S')
end

#get_distance_callback_period ⇒ Object

Returns the period as set by BrickletDistanceIR#set_distance_callback_period.



172
173
174
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 172

def get_distance_callback_period
  send_request(FUNCTION_GET_DISTANCE_CALLBACK_PERIOD, [], '', 4, 'L')
end

#get_distance_callback_threshold ⇒ Object

Returns the threshold as set by BrickletDistanceIR#set_distance_callback_threshold.



210
211
212
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 210

def get_distance_callback_threshold
  send_request(FUNCTION_GET_DISTANCE_CALLBACK_THRESHOLD, [], '', 5, 'k S 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’ or ‘d’.

The device identifier numbers can be found :ref:‘here <device_identifier>`. |device_identifier_constant|



266
267
268
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 266

def get_identity
  send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
end

#get_sampling_point(position) ⇒ Object

Returns the distance to a sampling point position as set by BrickletDistanceIR#set_sampling_point.



156
157
158
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 156

def get_sampling_point(position)
  send_request(FUNCTION_GET_SAMPLING_POINT, [position], 'C', 2, 'S')
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



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

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#set_analog_value_callback_period(period) ⇒ Object

Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.

CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the last triggering.

The default value is 0.



183
184
185
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 183

def set_analog_value_callback_period(period)
  send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 0, '')
end

#set_analog_value_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.

The following options are possible:

"Option", "Description"

"'x'",    "Callback is turned off"
"'o'",    "Callback is triggered when the analog value is *outside* the min and max values"
"'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
"'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"

The default value is (‘x’, 0, 0).



227
228
229
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 227

def set_analog_value_callback_threshold(option, min, max)
  send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
end

#set_debounce_period(debounce) ⇒ Object

Sets the period in ms with which the threshold callbacks

  • CALLBACK_DISTANCE_REACHED,

  • CALLBACK_ANALOG_VALUE_REACHED

are triggered, if the thresholds

  • BrickletDistanceIR#set_distance_callback_threshold,

  • BrickletDistanceIR#set_analog_value_callback_threshold

keep being reached.

The default value is 100.



249
250
251
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 249

def set_debounce_period(debounce)
  send_request(FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, '')
end

#set_distance_callback_period(period) ⇒ Object

Sets the period in ms with which the CALLBACK_DISTANCE callback is triggered periodically. A value of 0 turns the callback off.

CALLBACK_DISTANCE is only triggered if the distance has changed since the last triggering.

The default value is 0.



167
168
169
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 167

def set_distance_callback_period(period)
  send_request(FUNCTION_SET_DISTANCE_CALLBACK_PERIOD, [period], 'L', 0, '')
end

#set_distance_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_DISTANCE_REACHED callback.

The following options are possible:

"Option", "Description"

"'x'",    "Callback is turned off"
"'o'",    "Callback is triggered when the distance is *outside* the min and max values"
"'i'",    "Callback is triggered when the distance is *inside* the min and max values"
"'<'",    "Callback is triggered when the distance is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the distance is greater than the min value (max is ignored)"

The default value is (‘x’, 0, 0).



205
206
207
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 205

def set_distance_callback_threshold(option, min, max)
  send_request(FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
end

#set_sampling_point(position, distance) ⇒ Object

Sets a sampling point value to a specific position of the lookup table. The lookup table comprises 128 equidistant analog values with corresponding distances.

If you measure a distance of 50cm at the analog value 2048, you should call this function with (64, 5000). The utilized analog-to-digital converter has a resolution of 12 bit. With 128 sampling points on the whole range, this means that every sampling point has a size of 32 analog values. Thus the analog value 2048 has the corresponding sampling point 64 = 2048/32.

Sampling points are saved on the EEPROM of the Distance IR Bricklet and loaded again on startup.

.. note

An easy way to calibrate the sampling points of the Distance IR Bricklet is implemented in the Brick Viewer. If you want to calibrate your Bricklet it is highly recommended to use this implementation.



150
151
152
 
# File 'lib/tinkerforge/bricklet_distance_ir.rb', line 150

def set_sampling_point(position, distance)
  send_request(FUNCTION_SET_SAMPLING_POINT, [position, distance], 'C S', 0, '')
end