Class: Tinkerforge::BrickletSoundIntensity

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

Overview

Measures sound intensity

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

238
DEVICE_DISPLAY_NAME =

:nodoc:

'Sound Intensity Bricklet'
CALLBACK_INTENSITY =

This callback is triggered periodically with the period that is set by BrickletSoundIntensity#set_intensity_callback_period. The parameter is the intensity of the sensor.

The CALLBACK_INTENSITY callback is only triggered if the intensity has changed since the last triggering.

8
CALLBACK_INTENSITY_REACHED =

This callback is triggered when the threshold as set by BrickletSoundIntensity#set_intensity_callback_threshold is reached. The parameter is the intensity of the encoder.

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

9
FUNCTION_GET_INTENSITY =

:nodoc:

1
FUNCTION_SET_INTENSITY_CALLBACK_PERIOD =

:nodoc:

2
FUNCTION_GET_INTENSITY_CALLBACK_PERIOD =

:nodoc:

3
FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD =

:nodoc:

4
FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD =

:nodoc:

5
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

6
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

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

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 53

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_INTENSITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_INTENSITY_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_INTENSITY_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_INTENSITY_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[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_INTENSITY] = [10, 'S']
  @callback_formats[CALLBACK_INTENSITY_REACHED] = [10, 'S']

  @ipcon.add_device self
end

Instance Method Details

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletSoundIntensity#set_debounce_period.



146
147
148
149
150
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 146

def get_debounce_period
  check_validity

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



162
163
164
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 162

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

#get_intensity ⇒ Object

Returns the current sound intensity.

The value corresponds to the ‘upper envelop <en.wikipedia.org/wiki/Envelope_(waves)>`__ of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the CALLBACK_INTENSITY callback and set the period with BrickletSoundIntensity#set_intensity_callback_period.



82
83
84
85
86
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 82

def get_intensity
  check_validity

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

#get_intensity_callback_period ⇒ Object

Returns the period as set by BrickletSoundIntensity#set_intensity_callback_period.



100
101
102
103
104
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 100

def get_intensity_callback_period
  check_validity

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

#get_intensity_callback_threshold ⇒ Object

Returns the threshold as set by BrickletSoundIntensity#set_intensity_callback_threshold.



124
125
126
127
128
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 124

def get_intensity_callback_threshold
  check_validity

  send_request FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



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

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

#set_debounce_period(debounce) ⇒ Object

Sets the period with which the threshold callback

  • CALLBACK_INTENSITY_REACHED

is triggered, if the thresholds

  • BrickletSoundIntensity#set_intensity_callback_threshold

keeps being reached.



139
140
141
142
143
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 139

def set_debounce_period(debounce)
  check_validity

  send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
end

#set_intensity_callback_period(period) ⇒ Object

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

The CALLBACK_INTENSITY callback is only triggered if the intensity has changed since the last triggering.



93
94
95
96
97
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 93

def set_intensity_callback_period(period)
  check_validity

  send_request FUNCTION_SET_INTENSITY_CALLBACK_PERIOD, [period], 'L', 8, ''
end

#set_intensity_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_INTENSITY_REACHED callback.

The following options are possible:

"Option", "Description"

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



117
118
119
120
121
 
# File 'lib/tinkerforge/bricklet_sound_intensity.rb', line 117

def set_intensity_callback_threshold(option, min, max)
  check_validity

  send_request FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
end