/ 
Tinkerforge-2.1.2
River stage zero No dependents
/ Tinkerforge::BrickletSoundIntensity

NAME

Tinkerforge::BrickletSoundIntensity - Device for sensing sound intensity

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Sound Intensity Bricklet.

The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

CALLBACK_INTENSITY

This constant is used with the register_callback() subroutine to specify the CALLBACK_INTENSITY callback.

CALLBACK_INTENSITY_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_INTENSITY_REACHED callback.

FUNCTION_GET_INTENSITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_INTENSITY_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_INTENSITY_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_INTENSITY_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

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

get_intensity()

Returns the current sound intensity. The value has a range of 0 to 4095.

The value corresponds to the `upper envelop <http://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 :func:`Intensity` and set the period with :func:`SetIntensityCallbackPeriod`.

set_intensity_callback_period()

Sets the period in ms with which the :func:`Intensity` callback is triggered periodically. A value of 0 turns the callback off.

:func:`Intensity` is only triggered if the intensity has changed since the last triggering.

The default value is 0.

get_intensity_callback_period()

Returns the period as set by :func:`SetIntensityCallbackPeriod`.

set_intensity_callback_threshold()

Sets the thresholds for the :func:`IntensityReached` callback.

The following options are possible:

.. csv-table:: :header: "Option", "Description" :widths: 10, 100

"'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)"

The default value is ('x', 0, 0).

get_intensity_callback_threshold()

Returns the threshold as set by :func:`SetIntensityCallbackThreshold`.

set_debounce_period()

Sets the period in ms with which the threshold callback

* :func:`IntensityReached`

is triggered, if the thresholds

* :func:`SetIntensityCallbackThreshold`

keeps being reached.

The default value is 100.

get_debounce_period()

Returns the debounce period as set by :func:`SetDebouncePeriod`.

get_identity()

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|