..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-delphi">Software</a> / Delphi/Lazarus - Sound Intensity Bricklet

.. |device_identifier_constant| replace:: There is also a :ref:`constant <sound_intensity_bricklet_delphi_constants>` for the device identifier of this Bricklet.

.. _sound_intensity_bricklet_delphi:

Delphi/Lazarus - Sound Intensity Bricklet
=========================================

This is the description of the :ref:`Delphi/Lazarus API bindings <api_bindings_delphi>` for the :ref:`Sound Intensity Bricklet <sound_intensity_bricklet>`. General information and technical
specifications for the Sound Intensity Bricklet are summarized in its :ref:`hardware description
<sound_intensity_bricklet_description>`.

An :ref:`installation guide <api_bindings_delphi_install>` for the Delphi/Lazarus API
bindings is part of their general description.

.. _sound_intensity_bricklet_delphi_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Simple
^^^^^^

`Download (ExampleSimple.pas) <https://github.com/Tinkerforge/sound-intensity-bricklet/raw/master/software/examples/delphi/ExampleSimple.pas>`__

.. literalinclude:: SoundIntensity_Bricklet_Delphi_ExampleSimple.pas
 :language: delphi
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (ExampleCallback.pas) <https://github.com/Tinkerforge/sound-intensity-bricklet/raw/master/software/examples/delphi/ExampleCallback.pas>`__

.. literalinclude:: SoundIntensity_Bricklet_Delphi_ExampleCallback.pas
 :language: delphi
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

`Download (ExampleThreshold.pas) <https://github.com/Tinkerforge/sound-intensity-bricklet/raw/master/software/examples/delphi/ExampleThreshold.pas>`__

.. literalinclude:: SoundIntensity_Bricklet_Delphi_ExampleThreshold.pas
 :language: delphi
 :linenos:
 :tab-width: 4

.. _sound_intensity_bricklet_delphi_api:

API
---

Since Delphi does not support multiple return values directly, we use the
``out`` keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.




Basic Functions
^^^^^^^^^^^^^^^


.. delphi:function:: constructor TBrickletSoundIntensity.Create(const uid: string; ipcon: TIPConnection)

 Creates an object with the unique device ID ``uid``:

 .. code-block:: delphi

    soundIntensity := TBrickletSoundIntensity.Create('YOUR_DEVICE_UID', ipcon);

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <sound_intensity_bricklet_delphi_examples>`).


.. delphi:function:: function TBrickletSoundIntensity.GetIntensity(): word

 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 :delphi:func:`OnIntensity <TBrickletSoundIntensity.OnIntensity>` and set the period with 
 :delphi:func:`SetIntensityCallbackPeriod <TBrickletSoundIntensity.SetIntensityCallbackPeriod>`.
 


Advanced Functions
^^^^^^^^^^^^^^^^^^

.. delphi:function:: function TBrickletSoundIntensity.GetAPIVersion(): array [0..2] of byte

 Returns the version of the API definition (major, minor, revision) implemented
 by this API bindings. This is neither the release version of this API bindings
 nor does it tell you anything about the represented Brick or Bricklet.
 
.. delphi:function:: function TBrickletSoundIntensity.GetResponseExpected(const functionId: byte): boolean

 Returns the response expected flag for the function specified by the function
 ID parameter. It is *true* if the function is expected to send a response,
 *false* otherwise.
 
 For getter functions this is enabled by default and cannot be disabled,
 because those functions will always send a response. For callback configuration
 functions it is enabled by default too, but can be disabled by
 :delphi:func:`SetResponseExpected <TBrickletSoundIntensity.SetResponseExpected>`. For setter functions it is disabled by default
 and can be enabled.
 
 Enabling the response expected flag for a setter function allows to detect
 timeouts and other error conditions calls of this setter as well. The
 device will then send a response for this purpose. If this flag is disabled for
 a setter function then no response is send and errors are silently ignored,
 because they cannot be detected.
 
 See :delphi:func:`SetResponseExpected <TBrickletSoundIntensity.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. delphi:function:: procedure TBrickletSoundIntensity.SetResponseExpected(const functionId: byte; const responseExpected: boolean)

 Changes the response expected flag of the function specified by the
 function ID parameter. This flag can only be changed for setter (default value:
 *false*) and callback configuration functions (default value: *true*). For
 getter functions it is always enabled and callbacks it is always disabled.
 
 Enabling the response expected flag for a setter function allows to detect
 timeouts and other error conditions calls of this setter as well. The
 device will then send a response for this purpose. If this flag is disabled for
 a setter function then no response is send and errors are silently ignored,
 because they cannot be detected.
 
 The following function ID constants are available for this function:
 
 * BRICKLET_SOUND_INTENSITY_FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
 * BRICKLET_SOUND_INTENSITY_FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
 * BRICKLET_SOUND_INTENSITY_FUNCTION_SET_DEBOUNCE_PERIOD = 6
 
.. delphi:function:: procedure TBrickletSoundIntensity.SetResponseExpectedAll(const responseExpected: boolean)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. delphi:function:: procedure TBrickletSoundIntensity.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)

 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|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. delphi:function:: procedure TBrickletSoundIntensity.SetIntensityCallbackPeriod(const period: longword)

 Sets the period in ms with which the :delphi:func:`OnIntensity <TBrickletSoundIntensity.OnIntensity>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :delphi:func:`OnIntensity <TBrickletSoundIntensity.OnIntensity>` is only triggered if the intensity has changed since the
 last triggering.
 
 The default value is 0.
 
.. delphi:function:: function TBrickletSoundIntensity.GetIntensityCallbackPeriod(): longword

 Returns the period as set by :delphi:func:`SetIntensityCallbackPeriod <TBrickletSoundIntensity.SetIntensityCallbackPeriod>`.
 
.. delphi:function:: procedure TBrickletSoundIntensity.SetIntensityCallbackThreshold(const option: char; const min: word; const max: word)

 Sets the thresholds for the :delphi:func:`OnIntensityReached <TBrickletSoundIntensity.OnIntensityReached>` 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).
 
 The following constants are available for this function:
 
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_OFF = 'x'
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_OUTSIDE = 'o'
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_INSIDE = 'i'
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_SMALLER = '<'
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_GREATER = '>'
 
.. delphi:function:: procedure TBrickletSoundIntensity.GetIntensityCallbackThreshold(out option: char; out min: word; out max: word)

 Returns the threshold as set by :delphi:func:`SetIntensityCallbackThreshold <TBrickletSoundIntensity.SetIntensityCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_OFF = 'x'
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_OUTSIDE = 'o'
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_INSIDE = 'i'
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_SMALLER = '<'
 * BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_GREATER = '>'
 
.. delphi:function:: procedure TBrickletSoundIntensity.SetDebouncePeriod(const debounce: longword)

 Sets the period in ms with which the threshold callback
 
 * :delphi:func:`OnIntensityReached <TBrickletSoundIntensity.OnIntensityReached>`
 
 is triggered, if the thresholds
 
 * :delphi:func:`SetIntensityCallbackThreshold <TBrickletSoundIntensity.SetIntensityCallbackThreshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. delphi:function:: function TBrickletSoundIntensity.GetDebouncePeriod(): longword

 Returns the debounce period as set by :delphi:func:`SetDebouncePeriod <TBrickletSoundIntensity.SetDebouncePeriod>`.
 




.. _sound_intensity_bricklet_delphi_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by assigning a procedure to an callback
property of the device object:

 .. code-block:: delphi

  procedure TExample.MyCallback(sender: TBrickletSoundIntensity; const param: word);
  begin
    WriteLn(param);
  end;

  soundIntensity.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

The available callback property and their type of parameters are described below.

.. note::
 Using callbacks for recurring events is *always* preferred
 compared to using getters. It will use less USB bandwidth and the latency
 will be a lot better, since there is no round trip time.

.. delphi:function:: property TBrickletSoundIntensity.OnIntensity

 .. code-block:: delphi

  procedure(sender: TBrickletSoundIntensity; const intensity: word) of object;


 This callback is triggered periodically with the period that is set by
 :delphi:func:`SetIntensityCallbackPeriod <TBrickletSoundIntensity.SetIntensityCallbackPeriod>`. The parameter is the intensity of
 the encoder.
 
 :delphi:func:`OnIntensity <TBrickletSoundIntensity.OnIntensity>` is only triggered if the intensity has changed since the
 last triggering.
 
.. delphi:function:: property TBrickletSoundIntensity.OnIntensityReached

 .. code-block:: delphi

  procedure(sender: TBrickletSoundIntensity; const intensity: word) of object;


 This callback is triggered when the threshold as set by
 :delphi:func:`SetIntensityCallbackThreshold <TBrickletSoundIntensity.SetIntensityCallbackThreshold>` 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 :delphi:func:`SetDebouncePeriod <TBrickletSoundIntensity.SetDebouncePeriod>`.
 


.. _sound_intensity_bricklet_delphi_constants:

Constants
^^^^^^^^^

.. delphi:function:: const BRICKLET_SOUND_INTENSITY_DEVICE_IDENTIFIER

 This constant is used to identify a Sound Intensity Bricklet.

 The :delphi:func:`GetIdentity <TBrickletSoundIntensity.GetIdentity>` function and the
 :delphi:func:`OnEnumerate <TIPConnection.OnEnumerate>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

