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

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

.. _joystick_bricklet_php:

PHP - Joystick Bricklet
=======================

This is the description of the :ref:`PHP API bindings <api_bindings_php>` for the :ref:`Joystick Bricklet <joystick_bricklet>`. General information and technical
specifications for the Joystick Bricklet are summarized in its :ref:`hardware description
<joystick_bricklet_description>`.

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

.. _joystick_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/joystick-bricklet/raw/master/software/examples/php/ExampleSimple.php>`__

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

Callback
^^^^^^^^

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

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

Find Borders
^^^^^^^^^^^^

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

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

.. _joystick_bricklet_php_api:

API
---

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




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


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

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

 .. code-block:: php

    <?php   $joystick = new BrickletJoystick('YOUR_DEVICE_UID', $ipcon);   ?>

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


.. php:function:: array BrickletJoystick::getPosition()

 Returns the position of the Joystick. The value ranges between -100 and
 100 for both axis. The middle position of the joystick is x=0, y=0. The
 returned values are averaged and calibrated (see :php:func:`calibrate() <BrickletJoystick::calibrate>`).
 
 If you want to get the position periodically, it is recommended to use the
 callback :php:member:`CALLBACK_POSITION <BrickletJoystick::CALLBACK_POSITION>` and set the period with 
 :php:func:`setPositionCallbackPeriod() <BrickletJoystick::setPositionCallbackPeriod>`.
 
 The returned array has the keys ``x`` and ``y``.

.. php:function:: bool BrickletJoystick::isPressed()

 Returns *true* if the button is pressed and *false* otherwise.
 
 It is recommended to use the :php:member:`CALLBACK_PRESSED <BrickletJoystick::CALLBACK_PRESSED>` and :php:member:`CALLBACK_RELEASED <BrickletJoystick::CALLBACK_RELEASED>` callbacks
 to handle the button.
 


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

.. php:function:: array BrickletJoystick::getAnalogValue()

 Returns the values as read by a 12-bit analog-to-digital converter.
 The values are between 0 and 4095 for both axis.
 
 .. note::
  The values returned by :php:func:`getPosition() <BrickletJoystick::getPosition>` are averaged over several samples
  to yield less noise, while :php:func:`getAnalogValue() <BrickletJoystick::getAnalogValue>` gives back raw
  unfiltered analog values. The only reason to use :php:func:`getAnalogValue() <BrickletJoystick::getAnalogValue>` is,
  if you need the full resolution of the analog-to-digital converter.
 
 If you want the analog values periodically, it is recommended to use the 
 callback :php:member:`CALLBACK_ANALOG_VALUE <BrickletJoystick::CALLBACK_ANALOG_VALUE>` and set the period with 
 :php:func:`setAnalogValueCallbackPeriod() <BrickletJoystick::setAnalogValueCallbackPeriod>`.
 
 The returned array has the keys ``x`` and ``y``.

.. php:function:: void BrickletJoystick::calibrate()

 Calibrates the middle position of the Joystick. If your Joystick Bricklet
 does not return x=0 and y=0 in the middle position, call this function
 while the Joystick is standing still in the middle position.
 
 The resulting calibration will be saved on the EEPROM of the Joystick
 Bricklet, thus you only have to calibrate it once.
 
.. php:function:: array BrickletJoystick::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 BrickletJoystick::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() <BrickletJoystick::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() <BrickletJoystick::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletJoystick::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:
 
 * BrickletJoystick::FUNCTION_CALIBRATE = 4
 * BrickletJoystick::FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
 * BrickletJoystick::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
 * BrickletJoystick::FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
 * BrickletJoystick::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
 * BrickletJoystick::FUNCTION_SET_DEBOUNCE_PERIOD = 13
 
.. php:function:: void BrickletJoystick::setResponseExpectedAll(bool $response_expected)

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


.. php:function:: void BrickletJoystick::setPositionCallbackPeriod(int $period)

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

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

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

 Returns the period as set by :php:func:`setAnalogValueCallbackPeriod() <BrickletJoystick::setAnalogValueCallbackPeriod>`.
 
.. php:function:: void BrickletJoystick::setPositionCallbackThreshold(string $option, int $min_x, int $max_x, int $min_y, int $max_y)

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

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

.. php:function:: void BrickletJoystick::setAnalogValueCallbackThreshold(string $option, int $min_x, int $max_x, int $min_y, int $max_y)

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

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

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

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

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


.. _joystick_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() <BrickletJoystick::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";
    }

    $joystick->registerCallback(BrickletJoystick::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 BrickletJoystick::CALLBACK_POSITION

 .. code-block:: php

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

 This callback is triggered periodically with the period that is set by
 :php:func:`setPositionCallbackPeriod() <BrickletJoystick::setPositionCallbackPeriod>`. The parameter is the position of the
 Joystick.
 
 :php:member:`CALLBACK_POSITION <BrickletJoystick::CALLBACK_POSITION>` is only triggered if the position has changed since the
 last triggering.
 
.. php:member:: int BrickletJoystick::CALLBACK_ANALOG_VALUE

 .. code-block:: php

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

 This callback is triggered periodically with the period that is set by
 :php:func:`setAnalogValueCallbackPeriod() <BrickletJoystick::setAnalogValueCallbackPeriod>`. The parameters are the analog values
 of the Joystick.
 
 :php:member:`CALLBACK_ANALOG_VALUE <BrickletJoystick::CALLBACK_ANALOG_VALUE>` is only triggered if the values have changed since the
 last triggering.
 
.. php:member:: int BrickletJoystick::CALLBACK_POSITION_REACHED

 .. code-block:: php

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

 This callback is triggered when the threshold as set by
 :php:func:`setPositionCallbackThreshold() <BrickletJoystick::setPositionCallbackThreshold>` is reached.
 The parameters are the position of the Joystick.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :php:func:`setDebouncePeriod() <BrickletJoystick::setDebouncePeriod>`.
 
.. php:member:: int BrickletJoystick::CALLBACK_ANALOG_VALUE_REACHED

 .. code-block:: php

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

 This callback is triggered when the threshold as set by
 :php:func:`setAnalogValueCallbackThreshold() <BrickletJoystick::setAnalogValueCallbackThreshold>` is reached.
 The parameters are the analog values of the Joystick.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :php:func:`setDebouncePeriod() <BrickletJoystick::setDebouncePeriod>`.
 
.. php:member:: int BrickletJoystick::CALLBACK_PRESSED

 .. code-block:: php

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

 This callback is triggered when the button is pressed.
 
.. php:member:: int BrickletJoystick::CALLBACK_RELEASED

 .. code-block:: php

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

 This callback is triggered when the button is released.
 


.. _joystick_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletJoystick::DEVICE_IDENTIFIER

 This constant is used to identify a Joystick Bricklet.

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

