..
 #############################################################
 # 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 - Tilt Bricklet

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

.. _tilt_bricklet_delphi:

Delphi/Lazarus - Tilt Bricklet
==============================

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

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

.. _tilt_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/tilt-bricklet/raw/master/software/examples/delphi/ExampleSimple.pas>`__

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

Callback
^^^^^^^^

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

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

.. _tilt_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 TBrickletTilt.Create(const uid: string; ipcon: TIPConnection)

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

 .. code-block:: delphi

    tilt := TBrickletTilt.Create('YOUR_DEVICE_UID', ipcon);

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


.. delphi:function:: function TBrickletTilt.GetTiltState(): byte

 Returns the current tilt state. The state can either be
 
 * 0 = Closed: The ball in the tilt switch closes the circuit.
 * 1 = Open: The ball in the tilt switch does not close the circuit.
 * 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
 
 .. image:: /Images/Bricklets/bricklet_tilt_mechanics.jpg
    :scale: 100 %
    :alt: Tilt states
    :align: center
    :target: ../../_images/Bricklets/bricklet_tilt_mechanics.jpg
 
 
 The following constants are available for this function:
 
 * BRICKLET_TILT_TILT_STATE_CLOSED = 0
 * BRICKLET_TILT_TILT_STATE_OPEN = 1
 * BRICKLET_TILT_TILT_STATE_CLOSED_VIBRATING = 2
 


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

.. delphi:function:: function TBrickletTilt.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 TBrickletTilt.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 <TBrickletTilt.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 <TBrickletTilt.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. delphi:function:: procedure TBrickletTilt.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_TILT_FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
 * BRICKLET_TILT_FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
 
.. delphi:function:: procedure TBrickletTilt.SetResponseExpectedAll(const responseExpected: boolean)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. delphi:function:: procedure TBrickletTilt.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 TBrickletTilt.EnableTiltStateCallback()

 Enables the :delphi:func:`OnTiltState <TBrickletTilt.OnTiltState>` callback.
 
.. delphi:function:: procedure TBrickletTilt.DisableTiltStateCallback()

 Disables the :delphi:func:`OnTiltState <TBrickletTilt.OnTiltState>` callback.
 
.. delphi:function:: function TBrickletTilt.IsTiltStateCallbackEnabled(): boolean

 Returns *true* if the :delphi:func:`OnTiltState <TBrickletTilt.OnTiltState>` callback is enabled.
 




.. _tilt_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: TBrickletTilt; const param: word);
  begin
    WriteLn(param);
  end;

  tilt.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 TBrickletTilt.OnTiltState

 .. code-block:: delphi

  procedure(sender: TBrickletTilt; const state: byte) of object;


 This callback provides the current tilt state. It is called every time the
 state changes.
 
 See :delphi:func:`GetTiltState <TBrickletTilt.GetTiltState>` for a description of the states.
 
 The following constants are available for this function:
 
 * BRICKLET_TILT_TILT_STATE_CLOSED = 0
 * BRICKLET_TILT_TILT_STATE_OPEN = 1
 * BRICKLET_TILT_TILT_STATE_CLOSED_VIBRATING = 2
 


.. _tilt_bricklet_delphi_constants:

Constants
^^^^^^^^^

.. delphi:function:: const BRICKLET_TILT_DEVICE_IDENTIFIER

 This constant is used to identify a Tilt Bricklet.

 The :delphi:func:`GetIdentity <TBrickletTilt.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.

