..
 #############################################################
 # 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 - Analog Out Bricklet

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

.. _analog_out_bricklet_php:

PHP - Analog Out Bricklet
=========================

This is the description of the :ref:`PHP API bindings <api_bindings_php>` for the :ref:`Analog Out Bricklet <analog_out_bricklet>`. General information and technical
specifications for the Analog Out Bricklet are summarized in its :ref:`hardware description
<analog_out_bricklet_description>`.

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

.. _analog_out_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/analog-out-bricklet/raw/master/software/examples/php/ExampleSimple.php>`__

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

.. _analog_out_bricklet_php_api:

API
---

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




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


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

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

 .. code-block:: php

    <?php   $analog_out = new BrickletAnalogOut('YOUR_DEVICE_UID', $ipcon);   ?>

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


.. php:function:: void BrickletAnalogOut::setVoltage(int $voltage)

 Sets the voltage in mV. The possible range is 0V to 5V (0-5000).
 Calling this function will set the mode to 0 (see :php:func:`setMode() <BrickletAnalogOut::setMode>`).
 
 The default value is 0 (with mode 1).
 
.. php:function:: int BrickletAnalogOut::getVoltage()

 Returns the voltage as set by :php:func:`setVoltage() <BrickletAnalogOut::setVoltage>`.
 
.. php:function:: void BrickletAnalogOut::setMode(int $mode)

 Sets the mode of the analog value. Possible modes:
 
 * 0: Normal Mode (Analog value as set by :php:func:`setVoltage() <BrickletAnalogOut::setVoltage>` is applied)
 * 1: 1k Ohm resistor to ground
 * 2: 100k Ohm resistor to ground
 * 3: 500k Ohm resistor to ground
 
 Setting the mode to 0 will result in an output voltage of 0. You can jump
 to a higher output voltage directly by calling :php:func:`setVoltage() <BrickletAnalogOut::setVoltage>`.
 
 The default mode is 1.
 
 The following constants are available for this function:
 
 * BrickletAnalogOut::MODE_ANALOG_VALUE = 0
 * BrickletAnalogOut::MODE_1K_TO_GROUND = 1
 * BrickletAnalogOut::MODE_100K_TO_GROUND = 2
 * BrickletAnalogOut::MODE_500K_TO_GROUND = 3
 
.. php:function:: int BrickletAnalogOut::getMode()

 Returns the mode as set by :php:func:`setMode() <BrickletAnalogOut::setMode>`.
 
 The following constants are available for this function:
 
 * BrickletAnalogOut::MODE_ANALOG_VALUE = 0
 * BrickletAnalogOut::MODE_1K_TO_GROUND = 1
 * BrickletAnalogOut::MODE_100K_TO_GROUND = 2
 * BrickletAnalogOut::MODE_500K_TO_GROUND = 3
 


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

.. php:function:: array BrickletAnalogOut::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 BrickletAnalogOut::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() <BrickletAnalogOut::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() <BrickletAnalogOut::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletAnalogOut::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:
 
 * BrickletAnalogOut::FUNCTION_SET_VOLTAGE = 1
 * BrickletAnalogOut::FUNCTION_SET_MODE = 3
 
.. php:function:: void BrickletAnalogOut::setResponseExpectedAll(bool $response_expected)

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



.. _analog_out_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletAnalogOut::DEVICE_IDENTIFIER

 This constant is used to identify a Analog Out Bricklet.

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

