..
 #############################################################
 # 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-php">Software</a> / PHP - Multi Touch Bricklet

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

.. _multi_touch_bricklet_php:

PHP - Multi Touch Bricklet
==========================

This is the description of the :ref:`PHP API bindings <api_bindings_php>` for the :ref:`Multi Touch Bricklet <multi_touch_bricklet>`. General information and technical
specifications for the Multi Touch Bricklet are summarized in its :ref:`hardware description
<multi_touch_bricklet_description>`.

An :ref:`installation guide <api_bindings_php_install>` for the PHP API
bindings is part of their general description.

.. _multi_touch_bricklet_php_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.php) <https://github.com/Tinkerforge/multi-touch-bricklet/raw/master/software/examples/php/ExampleSimple.php>`__

.. literalinclude:: MultiTouch_Bricklet_PHP_ExampleSimple.php
 :language: php
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (ExampleCallback.php) <https://github.com/Tinkerforge/multi-touch-bricklet/raw/master/software/examples/php/ExampleCallback.php>`__

.. literalinclude:: MultiTouch_Bricklet_PHP_ExampleCallback.php
 :language: php
 :linenos:
 :tab-width: 4

.. _multi_touch_bricklet_php_api:

API
---

Functions that return multiple values return them in an associative array.




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


.. php:function:: class BrickletMultiTouch(string $uid, IPConnection $ipcon)

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

 .. code-block:: php

    <?php   $multi_touch = new BrickletMultiTouch('YOUR_DEVICE_UID', $ipcon);   ?>

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


.. php:function:: int BrickletMultiTouch::getTouchState()

 Returns the current touch state. The state is given as a bitfield.
 
 Bits 0 to 11 represent the 12 electrodes and bit 12 represents
 the proximity.
 
 If an electrode is touched, the corresponding bit is true. If
 a hand or similar is in proximity to the electrodes, bit 12 is
 *true*.
 
 Example: The state 4103 = 0x1007 = 0b1000000000111 means that
 electrodes 0, 1 and 2 are touched and that something is in the
 proximity of the electrodes.
 
 The proximity is activated with a distance of 1-2cm. An electrode
 is already counted as touched if a finger is nearly touching the
 electrode. This means that you can put a piece of paper or foil
 or similar on top of a electrode to build a touch panel with
 a professional look.
 
.. php:function:: void BrickletMultiTouch::recalibrate()

 Recalibrates the electrodes. Call this function whenever you changed
 or moved you electrodes.
 
.. php:function:: void BrickletMultiTouch::setElectrodeConfig(int $enabled_electrodes)

 Enables/disables electrodes with a bitfield (see :php:func:`getTouchState() <BrickletMultiTouch::getTouchState>`).
 
 *True* enables the electrode, *false* disables the electrode. A
 disabled electrode will always return *false* as its state. If you
 don't need all electrodes you can disable the electrodes that are
 not needed.
 
 It is recommended that you disable the proximity bit (bit 12) if
 the proximity feature is not needed. This will reduce the amount of
 traffic that is produced by the :php:member:`CALLBACK_TOUCH_STATE <BrickletMultiTouch::CALLBACK_TOUCH_STATE>` callback.
 
 Disabling electrodes will also reduce power consumption.
 
 Default: 8191 = 0x1FFF = 0b1111111111111 (all electrodes enabled)
 
.. php:function:: int BrickletMultiTouch::getElectrodeConfig()

 Returns the electrode configuration, as set by :php:func:`setElectrodeConfig() <BrickletMultiTouch::setElectrodeConfig>`.
 
.. php:function:: void BrickletMultiTouch::setElectrodeSensitivity(int $sensitivity)

 Sets the sensitivity of the electrodes. An electrode with a high sensitivity
 will register a touch earlier then an electrode with a low sensitivity.
 
 If you build a big electrode you might need to decrease the sensitivity, since
 the area that can be charged will get bigger. If you want to be able to
 activate an electrode from further away you need to increase the sensitivity.
 
 After a new sensitivity is set, you likely want to call :php:func:`recalibrate() <BrickletMultiTouch::recalibrate>`
 to calibrate the electrodes with the newly defined sensitivity.
 
 The valid sensitivity value range is 5-201.
 
 The default sensitivity value is 181.
 
.. php:function:: int BrickletMultiTouch::getElectrodeSensitivity()

 Returns the current sensitivity, as set by :php:func:`setElectrodeSensitivity() <BrickletMultiTouch::setElectrodeSensitivity>`.
 


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

.. php:function:: array BrickletMultiTouch::getAPIVersion()

 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.
 
.. php:function:: bool BrickletMultiTouch::getResponseExpected(int $function_id)

 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
 :php:func:`setResponseExpected() <BrickletMultiTouch::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 :php:func:`setResponseExpected() <BrickletMultiTouch::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletMultiTouch::setResponseExpected(int $function_id, bool $response_expected)

 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:
 
 * BrickletMultiTouch::FUNCTION_RECALIBRATE = 2
 * BrickletMultiTouch::FUNCTION_SET_ELECTRODE_CONFIG = 3
 * BrickletMultiTouch::FUNCTION_SET_ELECTRODE_SENSITIVITY = 6
 
.. php:function:: void BrickletMultiTouch::setResponseExpectedAll(bool $response_expected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. php:function:: array BrickletMultiTouch::getIdentity()

 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|
 
 The returned array has the keys ``uid``, ``connected_uid``, ``position``, ``hardware_version``, ``firmware_version`` and ``device_identifier``.



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


.. php:function:: void BrickletMultiTouch::registerCallback(int $id, callable $callback, mixed $userData = NULL)

 Registers a callback with ID *$id* to the callable *$callback*.
 The *$userData*  will be given as a parameter of the callback.

 The available  IDs with corresponding function signatures are listed
 :ref:`below <multi_touch_bricklet_php_callbacks>`.




.. _multi_touch_bricklet_php_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive
time critical or recurring data from the device. The registration is done
with the :php:func:`registerCallback() <BrickletMultiTouch::registerCallback>` function of
the device object. The first parameter is the callback ID and the second
parameter the callback function:

.. code-block:: php

    <?php

    function myCallback($param)
    {
        echo $param . "\n";
    }

    $multi_touch->registerCallback(BrickletMultiTouch::CALLBACK_EXAMPLE, 'myCallback');

    ?>

The available constants with corresponding function signatures 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.

.. php:member:: int BrickletMultiTouch::CALLBACK_TOUCH_STATE

 .. code-block:: php

  <?php   void callback(int $state [, mixed $userData])   ?>

 Returns the current touch state, see :php:func:`getTouchState() <BrickletMultiTouch::getTouchState>` for
 information about the state.
 
 This callback is triggered every time the touch state changes.
 


.. _multi_touch_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletMultiTouch::DEVICE_IDENTIFIER

 This constant is used to identify a Multi Touch Bricklet.

 The :php:func:`getIdentity() <BrickletMultiTouch::getIdentity>` function and the
 :php:member:`CALLBACK_ENUMERATE <IPConnection::CALLBACK_ENUMERATE>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

