..
 #############################################################
 # This file was automatically generated on 2015-05-19.      #
 #                                                           #
 # 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       #
 #############################################################

:orphan:
:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-php">Software</a> / PHP - Ozone Bricklet

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

.. _ozone_bricklet_php:

PHP - Ozone Bricklet
====================

.. note::
 This Bricklet is currently in the prototype stage and the software/hardware
 as well as the documentation is in an incomplete state.


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

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

.. _ozone_bricklet_php_examples:


Examples
--------

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

.. _ozone_bricklet_php_api:

API
---

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




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


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

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

 .. code-block:: php

    <?php   $ozone = new BrickletOzone('YOUR_DEVICE_UID', $ipcon);   ?>

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


.. php:function:: int BrickletOzone::getOzoneConcentration()

 Returns the measured ozone concentration. The value is in ppb and
 between TBD and TBD.
 
 If you want to get the ozone concentration periodically, it is recommended to use the
 callback :php:member:`CALLBACK_OZONE_CONCENTRATION <BrickletOzone::CALLBACK_OZONE_CONCENTRATION>` and set the period with
 :php:func:`setOzoneConcentrationCallbackPeriod() <BrickletOzone::setOzoneConcentrationCallbackPeriod>`.
 


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

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

 Returns the value as read by a 12-bit analog-to-digital converter.
 The value is between 0 and 4095.
 
 If you want the analog value periodically, it is recommended to use the
 callback :php:member:`CALLBACK_ANALOG_VALUE <BrickletOzone::CALLBACK_ANALOG_VALUE>` and set the period with
 :php:func:`setAnalogValueCallbackPeriod() <BrickletOzone::setAnalogValueCallbackPeriod>`.
 
.. php:function:: void BrickletOzone::setMovingAverage(int $average)

 Sets the length of a `moving averaging <http://en.wikipedia.org/wiki/Moving_average>`__
 for the ozone concentration.
 
 Setting the length to 1 will turn the averaging off. With less
 averaging, there is more noise on the data.
 
 The range for the averaging is 1-50.
 
 The default value is 50.
 
.. php:function:: int BrickletOzone::getMovingAverage()

 Returns the length of the moving average as set by :php:func:`setMovingAverage() <BrickletOzone::setMovingAverage>`.
 
.. php:function:: array BrickletOzone::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 BrickletOzone::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() <BrickletOzone::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() <BrickletOzone::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletOzone::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:
 
 * BrickletOzone::FUNCTION_SET_OZONE_CONCENTRATION_CALLBACK_PERIOD = 3
 * BrickletOzone::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
 * BrickletOzone::FUNCTION_SET_OZONE_CONCENTRATION_CALLBACK_THRESHOLD = 7
 * BrickletOzone::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
 * BrickletOzone::FUNCTION_SET_DEBOUNCE_PERIOD = 11
 * BrickletOzone::FUNCTION_SET_MOVING_AVERAGE = 13
 
.. php:function:: void BrickletOzone::setResponseExpectedAll(bool $response_expected)

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


.. php:function:: void BrickletOzone::setOzoneConcentrationCallbackPeriod(int $period)

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

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

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

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

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

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

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

 Sets the thresholds for the :php:member:`CALLBACK_ANALOG_VALUE_REACHED <BrickletOzone::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:
 
 * BrickletOzone::THRESHOLD_OPTION_OFF = 'x'
 * BrickletOzone::THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletOzone::THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletOzone::THRESHOLD_OPTION_SMALLER = '<'
 * BrickletOzone::THRESHOLD_OPTION_GREATER = '>'
 
.. php:function:: array BrickletOzone::getAnalogValueCallbackThreshold()

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

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

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

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


.. _ozone_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() <BrickletOzone::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";
    }

    $ozone->registerCallback(BrickletOzone::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 BrickletOzone::CALLBACK_OZONE_CONCENTRATION

 .. code-block:: php

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

 This callback is triggered periodically with the period that is set by
 :php:func:`setOzoneConcentrationCallbackPeriod() <BrickletOzone::setOzoneConcentrationCallbackPeriod>`. The parameter is the ozone concentration of the
 sensor.
 
 :php:member:`CALLBACK_OZONE_CONCENTRATION <BrickletOzone::CALLBACK_OZONE_CONCENTRATION>` is only triggered if the ozone concentration has changed since the
 last triggering.
 
.. php:member:: int BrickletOzone::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() <BrickletOzone::setAnalogValueCallbackPeriod>`. The parameter is the analog value of the
 sensor.
 
 :php:member:`CALLBACK_ANALOG_VALUE <BrickletOzone::CALLBACK_ANALOG_VALUE>` is only triggered if the analog value has changed since the
 last triggering.
 
.. php:member:: int BrickletOzone::CALLBACK_OZONE_CONCENTRATION_REACHED

 .. code-block:: php

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

 This callback is triggered when the threshold as set by
 :php:func:`setOzoneConcentrationCallbackThreshold() <BrickletOzone::setOzoneConcentrationCallbackThreshold>` is reached.
 The parameter is the ozone concentration.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :php:func:`setDebouncePeriod() <BrickletOzone::setDebouncePeriod>`.
 
.. php:member:: int BrickletOzone::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() <BrickletOzone::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() <BrickletOzone::setDebouncePeriod>`.
 


.. _ozone_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletOzone::DEVICE_IDENTIFIER

 This constant is used to identify a Ozone Bricklet.

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

