class Tinkerforge::BrickletSoundIntensity
Measures sound intensity
Constants
- 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.- 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
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 52 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
Public Instance Methods
Returns the debounce period as set by BrickletSoundIntensity#set_debounce_period
.
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 145 def get_debounce_period check_validity send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L' end
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|
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 161 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the current sound intensity.
The value corresponds to the `upper envelop <CALLBACK_INTENSITY
callback and set the period with BrickletSoundIntensity#set_intensity_callback_period
.
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 81 def get_intensity check_validity send_request FUNCTION_GET_INTENSITY, [], '', 10, 'S' end
Returns the period as set by BrickletSoundIntensity#set_intensity_callback_period
.
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 99 def get_intensity_callback_period check_validity send_request FUNCTION_GET_INTENSITY_CALLBACK_PERIOD, [], '', 12, 'L' end
Returns the threshold as set by BrickletSoundIntensity#set_intensity_callback_threshold
.
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 123 def get_intensity_callback_threshold check_validity send_request FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD, [], '', 13, 'k S S' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 166 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
Sets the period with which the threshold callback
is triggered, if the thresholds
keeps being reached.
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 138 def set_debounce_period(debounce) check_validity send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, '' end
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.
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 92 def set_intensity_callback_period(period) check_validity send_request FUNCTION_SET_INTENSITY_CALLBACK_PERIOD, [period], 'L', 8, '' end
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)"
# File lib/tinkerforge/bricklet_sound_intensity.rb, line 116 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