..
 #############################################################
 # 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 - Distance IR Bricklet

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

.. _distance_ir_bricklet_php:

PHP - Distance IR Bricklet
==========================

This is the description of the :ref:`PHP API bindings <api_bindings_php>` for the :ref:`Distance IR Bricklet <distance_ir_bricklet>`. General information and technical
specifications for the Distance IR Bricklet are summarized in its :ref:`hardware description
<distance_ir_bricklet_description>`.

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

.. _distance_ir_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/distance-ir-bricklet/raw/master/software/examples/php/ExampleSimple.php>`__

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

Callback
^^^^^^^^

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

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

Threshold
^^^^^^^^^

`Download (ExampleThreshold.php) <https://github.com/Tinkerforge/distance-ir-bricklet/raw/master/software/examples/php/ExampleThreshold.php>`__

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

.. _distance_ir_bricklet_php_api:

API
---

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




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


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

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

 .. code-block:: php

    <?php   $distance_ir = new BrickletDistanceIR('YOUR_DEVICE_UID', $ipcon);   ?>

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


.. php:function:: int BrickletDistanceIR::getDistance()

 Returns the distance measured by the sensor. The value is in mm and possible
 distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the
 selected IR sensor.
 
 If you want to get the distance periodically, it is recommended to use the
 callback :php:member:`CALLBACK_DISTANCE <BrickletDistanceIR::CALLBACK_DISTANCE>` and set the period with 
 :php:func:`setDistanceCallbackPeriod() <BrickletDistanceIR::setDistanceCallbackPeriod>`.
 


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

.. php:function:: int BrickletDistanceIR::getAnalogValue()

 Returns the value as read by a 12-bit analog-to-digital converter.
 The value is between 0 and 4095.
 
 .. note::
  The value returned by :php:func:`getDistance() <BrickletDistanceIR::getDistance>` is averaged over several samples
  to yield less noise, while :php:func:`getAnalogValue() <BrickletDistanceIR::getAnalogValue>` gives back raw
  unfiltered analog values. The only reason to use :php:func:`getAnalogValue() <BrickletDistanceIR::getAnalogValue>` is,
  if you need the full resolution of the analog-to-digital converter.
 
 If you want the analog value periodically, it is recommended to use the 
 callback :php:member:`CALLBACK_ANALOG_VALUE <BrickletDistanceIR::CALLBACK_ANALOG_VALUE>` and set the period with 
 :php:func:`setAnalogValueCallbackPeriod() <BrickletDistanceIR::setAnalogValueCallbackPeriod>`.
 
.. php:function:: void BrickletDistanceIR::setSamplingPoint(int $position, int $distance)

 Sets a sampling point value to a specific position of the lookup table.
 The lookup table comprises 128 equidistant analog values with
 corresponding distances.
 
 If you measure a distance of 50cm at the analog value 2048, you
 should call this function with (64, 5000). The utilized analog-to-digital
 converter has a resolution of 12 bit. With 128 sampling points on the
 whole range, this means that every sampling point has a size of 32
 analog values. Thus the analog value 2048 has the corresponding sampling
 point 64 = 2048/32.
 
 Sampling points are saved on the EEPROM of the Distance IR Bricklet and
 loaded again on startup.
 
 .. note::
  An easy way to calibrate the sampling points of the Distance IR Bricklet is
  implemented in the Brick Viewer. If you want to calibrate your Bricklet it is
  highly recommended to use this implementation.
 
.. php:function:: int BrickletDistanceIR::getSamplingPoint(int $position)

 Returns the distance to a sampling point position as set by
 :php:func:`setSamplingPoint() <BrickletDistanceIR::setSamplingPoint>`.
 
.. php:function:: array BrickletDistanceIR::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 BrickletDistanceIR::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() <BrickletDistanceIR::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() <BrickletDistanceIR::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletDistanceIR::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:
 
 * BrickletDistanceIR::FUNCTION_SET_SAMPLING_POINT = 3
 * BrickletDistanceIR::FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
 * BrickletDistanceIR::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
 * BrickletDistanceIR::FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
 * BrickletDistanceIR::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
 * BrickletDistanceIR::FUNCTION_SET_DEBOUNCE_PERIOD = 13
 
.. php:function:: void BrickletDistanceIR::setResponseExpectedAll(bool $response_expected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. php:function:: array BrickletDistanceIR::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 BrickletDistanceIR::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 <distance_ir_bricklet_php_callbacks>`.


.. php:function:: void BrickletDistanceIR::setDistanceCallbackPeriod(int $period)

 Sets the period in ms with which the :php:member:`CALLBACK_DISTANCE <BrickletDistanceIR::CALLBACK_DISTANCE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :php:member:`CALLBACK_DISTANCE <BrickletDistanceIR::CALLBACK_DISTANCE>` is only triggered if the distance has changed since the
 last triggering.
 
 The default value is 0.
 
.. php:function:: int BrickletDistanceIR::getDistanceCallbackPeriod()

 Returns the period as set by :php:func:`setDistanceCallbackPeriod() <BrickletDistanceIR::setDistanceCallbackPeriod>`.
 
.. php:function:: void BrickletDistanceIR::setAnalogValueCallbackPeriod(int $period)

 Sets the period in ms with which the :php:member:`CALLBACK_ANALOG_VALUE <BrickletDistanceIR::CALLBACK_ANALOG_VALUE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :php:member:`CALLBACK_ANALOG_VALUE <BrickletDistanceIR::CALLBACK_ANALOG_VALUE>` is only triggered if the analog value has changed since the
 last triggering.
 
 The default value is 0.
 
.. php:function:: int BrickletDistanceIR::getAnalogValueCallbackPeriod()

 Returns the period as set by :php:func:`setAnalogValueCallbackPeriod() <BrickletDistanceIR::setAnalogValueCallbackPeriod>`.
 
.. php:function:: void BrickletDistanceIR::setDistanceCallbackThreshold(string $option, int $min, int $max)

 Sets the thresholds for the :php:member:`CALLBACK_DISTANCE_REACHED <BrickletDistanceIR::CALLBACK_DISTANCE_REACHED>` 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 distance is *outside* the min and max values"
  "'i'",    "Callback is triggered when the distance is *inside* the min and max values"
  "'<'",    "Callback is triggered when the distance is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the distance is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletDistanceIR::THRESHOLD_OPTION_OFF = 'x'
 * BrickletDistanceIR::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletDistanceIR::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletDistanceIR::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletDistanceIR::THRESHOLD_OPTION_GREATER = '>'
 
.. php:function:: array BrickletDistanceIR::getDistanceCallbackThreshold()

 Returns the threshold as set by :php:func:`setDistanceCallbackThreshold() <BrickletDistanceIR::setDistanceCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletDistanceIR::THRESHOLD_OPTION_OFF = 'x'
 * BrickletDistanceIR::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletDistanceIR::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletDistanceIR::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletDistanceIR::THRESHOLD_OPTION_GREATER = '>'
 
 The returned array has the keys ``option``, ``min`` and ``max``.

.. php:function:: void BrickletDistanceIR::setAnalogValueCallbackThreshold(string $option, int $min, int $max)

 Sets the thresholds for the :php:member:`CALLBACK_ANALOG_VALUE_REACHED <BrickletDistanceIR::CALLBACK_ANALOG_VALUE_REACHED>` 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 analog value is *outside* the min and max values"
  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
  "'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletDistanceIR::THRESHOLD_OPTION_OFF = 'x'
 * BrickletDistanceIR::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletDistanceIR::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletDistanceIR::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletDistanceIR::THRESHOLD_OPTION_GREATER = '>'
 
.. php:function:: array BrickletDistanceIR::getAnalogValueCallbackThreshold()

 Returns the threshold as set by :php:func:`setAnalogValueCallbackThreshold() <BrickletDistanceIR::setAnalogValueCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletDistanceIR::THRESHOLD_OPTION_OFF = 'x'
 * BrickletDistanceIR::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletDistanceIR::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletDistanceIR::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletDistanceIR::THRESHOLD_OPTION_GREATER = '>'
 
 The returned array has the keys ``option``, ``min`` and ``max``.

.. php:function:: void BrickletDistanceIR::setDebouncePeriod(int $debounce)

 Sets the period in ms with which the threshold callbacks
 
 * :php:member:`CALLBACK_DISTANCE_REACHED <BrickletDistanceIR::CALLBACK_DISTANCE_REACHED>`,
 * :php:member:`CALLBACK_ANALOG_VALUE_REACHED <BrickletDistanceIR::CALLBACK_ANALOG_VALUE_REACHED>`
 
 are triggered, if the thresholds
 
 * :php:func:`setDistanceCallbackThreshold() <BrickletDistanceIR::setDistanceCallbackThreshold>`,
 * :php:func:`setAnalogValueCallbackThreshold() <BrickletDistanceIR::setAnalogValueCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. php:function:: int BrickletDistanceIR::getDebouncePeriod()

 Returns the debounce period as set by :php:func:`setDebouncePeriod() <BrickletDistanceIR::setDebouncePeriod>`.
 


.. _distance_ir_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() <BrickletDistanceIR::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";
    }

    $distance_ir->registerCallback(BrickletDistanceIR::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 BrickletDistanceIR::CALLBACK_DISTANCE

 .. code-block:: php

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

 This callback is triggered periodically with the period that is set by
 :php:func:`setDistanceCallbackPeriod() <BrickletDistanceIR::setDistanceCallbackPeriod>`. The parameter is the distance of the
 sensor.
 
 :php:member:`CALLBACK_DISTANCE <BrickletDistanceIR::CALLBACK_DISTANCE>` is only triggered if the distance has changed since the
 last triggering.
 
.. php:member:: int BrickletDistanceIR::CALLBACK_ANALOG_VALUE

 .. code-block:: php

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

 This callback is triggered periodically with the period that is set by
 :php:func:`setAnalogValueCallbackPeriod() <BrickletDistanceIR::setAnalogValueCallbackPeriod>`. The parameter is the analog value of the
 sensor.
 
 :php:member:`CALLBACK_ANALOG_VALUE <BrickletDistanceIR::CALLBACK_ANALOG_VALUE>` is only triggered if the analog value has changed since the
 last triggering.
 
.. php:member:: int BrickletDistanceIR::CALLBACK_DISTANCE_REACHED

 .. code-block:: php

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

 This callback is triggered when the threshold as set by
 :php:func:`setDistanceCallbackThreshold() <BrickletDistanceIR::setDistanceCallbackThreshold>` is reached.
 The parameter is the distance of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :php:func:`setDebouncePeriod() <BrickletDistanceIR::setDebouncePeriod>`.
 
.. php:member:: int BrickletDistanceIR::CALLBACK_ANALOG_VALUE_REACHED

 .. code-block:: php

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

 This callback is triggered when the threshold as set by
 :php:func:`setAnalogValueCallbackThreshold() <BrickletDistanceIR::setAnalogValueCallbackThreshold>` is reached.
 The parameter is the analog value of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :php:func:`setDebouncePeriod() <BrickletDistanceIR::setDebouncePeriod>`.
 


.. _distance_ir_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletDistanceIR::DEVICE_IDENTIFIER

 This constant is used to identify a Distance IR Bricklet.

 The :php:func:`getIdentity() <BrickletDistanceIR::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.

