..
 #############################################################
 # 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 - Piezo Speaker Bricklet

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

.. _piezo_speaker_bricklet_php:

PHP - Piezo Speaker Bricklet
============================

This is the description of the :ref:`PHP API bindings <api_bindings_php>` for the :ref:`Piezo Speaker Bricklet <piezo_speaker_bricklet>`. General information and technical
specifications for the Piezo Speaker Bricklet are summarized in its :ref:`hardware description
<piezo_speaker_bricklet_description>`.

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

.. _piezo_speaker_bricklet_php_examples:


Examples
--------

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

Beep
^^^^

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

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

Morse Code
^^^^^^^^^^

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

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

.. _piezo_speaker_bricklet_php_api:

API
---

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




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


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

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

 .. code-block:: php

    <?php   $piezo_speaker = new BrickletPiezoSpeaker('YOUR_DEVICE_UID', $ipcon);   ?>

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


.. php:function:: void BrickletPiezoSpeaker::beep(int $duration, int $frequency)

 Beeps with the given frequency for the duration in ms. For example: 
 If you set a duration of 1000, with a frequency value of 2000
 the piezo buzzer will beep for one second with a frequency of
 approximately 2 kHz.
 
 .. versionchanged:: 2.0.2~(Plugin)
    A duration of 0 stops the current beep if any, the frequency parameter is
    ignored. A duration of 4294967295 results in an infinite beep.
 
 The *frequency* parameter can be set between 585 and 7100.
 
 The Piezo Speaker Bricklet can only approximate the frequency, it will play
 the best possible match by applying the calibration (see :php:func:`calibrate() <BrickletPiezoSpeaker::calibrate>`).
 
 The following constants are available for this function:
 
 * BrickletPiezoSpeaker::BEEP_DURATION_OFF = 0
 * BrickletPiezoSpeaker::BEEP_DURATION_INFINITE = 4294967295
 
.. php:function:: void BrickletPiezoSpeaker::morseCode(string $morse, int $frequency)

 Sets morse code that will be played by the piezo buzzer. The morse code
 is given as a string consisting of "." (dot), "-" (minus) and " " (space)
 for *dits*, *dahs* and *pauses*. Every other character is ignored.
 The second parameter is the frequency (see :php:func:`beep() <BrickletPiezoSpeaker::beep>`).
 
 For example: If you set the string "...---...", the piezo buzzer will beep
 nine times with the durations "short short short long long long short 
 short short".
 
 The maximum string size is 60.
 


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

.. php:function:: bool BrickletPiezoSpeaker::calibrate()

 The Piezo Speaker Bricklet can play 512 different tones. This function
 plays each tone and measures the exact frequency back. The result is a
 mapping between setting value and frequency. This mapping is stored
 in the EEPROM and loaded on startup.
 
 The Bricklet should come calibrated, you only need to call this
 function (once) every time you reflash the Bricklet plugin.
 
 Returns *true* after the calibration finishes.
 
.. php:function:: array BrickletPiezoSpeaker::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 BrickletPiezoSpeaker::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() <BrickletPiezoSpeaker::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() <BrickletPiezoSpeaker::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletPiezoSpeaker::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:
 
 * BrickletPiezoSpeaker::FUNCTION_BEEP = 1
 * BrickletPiezoSpeaker::FUNCTION_MORSE_CODE = 2
 
.. php:function:: void BrickletPiezoSpeaker::setResponseExpectedAll(bool $response_expected)

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




.. _piezo_speaker_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() <BrickletPiezoSpeaker::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";
    }

    $piezo_speaker->registerCallback(BrickletPiezoSpeaker::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 BrickletPiezoSpeaker::CALLBACK_BEEP_FINISHED

 .. code-block:: php

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

 This callback is triggered if a beep set by :php:func:`beep() <BrickletPiezoSpeaker::beep>` is finished
 
.. php:member:: int BrickletPiezoSpeaker::CALLBACK_MORSE_CODE_FINISHED

 .. code-block:: php

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

 This callback is triggered if the playback of the morse code set by
 :php:func:`morseCode() <BrickletPiezoSpeaker::morseCode>` is finished.
 


.. _piezo_speaker_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletPiezoSpeaker::DEVICE_IDENTIFIER

 This constant is used to identify a Piezo Speaker Bricklet.

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

