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

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

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

.. _industrial_analog_out_bricklet_php:

PHP - Industrial Analog Out 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:`Industrial Analog Out Bricklet <industrial_analog_out_bricklet>`. General information and technical
specifications for the Industrial Analog Out Bricklet are summarized in its :ref:`hardware description
<industrial_analog_out_bricklet_description>`.

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

.. _industrial_analog_out_bricklet_php_examples:


Examples
--------

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

Simple Current
^^^^^^^^^^^^^^

`Download (ExampleSimpleCurrent.php) <https://github.com/Tinkerforge/industrial-analog-out-bricklet/raw/master/software/examples/php/ExampleSimpleCurrent.php>`__

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

Simple Voltage
^^^^^^^^^^^^^^

`Download (ExampleSimpleVoltage.php) <https://github.com/Tinkerforge/industrial-analog-out-bricklet/raw/master/software/examples/php/ExampleSimpleVoltage.php>`__

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

.. _industrial_analog_out_bricklet_php_api:

API
---

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




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


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

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

 .. code-block:: php

    <?php   $industrial_analog_out = new BrickletIndustrialAnalogOut('YOUR_DEVICE_UID', $ipcon);   ?>

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


.. php:function:: void BrickletIndustrialAnalogOut::enable()

 Enables the output of voltage and current.
 
 The default is disabled.
 
.. php:function:: void BrickletIndustrialAnalogOut::disable()

 Disables the output of voltage and current.
 
 The default is disabled.
 
.. php:function:: bool BrickletIndustrialAnalogOut::isEnabled()

 Returns *true* if output of voltage and current is enabled, *false* otherwise.
 
.. php:function:: void BrickletIndustrialAnalogOut::setVoltage(int $voltage)

 Sets the output voltage in mV.
 
.. php:function:: int BrickletIndustrialAnalogOut::getVoltage()

 Returns the voltage as set by :php:func:`setVoltage() <BrickletIndustrialAnalogOut::setVoltage>`.
 
.. php:function:: void BrickletIndustrialAnalogOut::setCurrent(int $current)

 Sets the output current in µA.
 
.. php:function:: int BrickletIndustrialAnalogOut::getCurrent()

 Returns the current as set by :php:func:`setCurrent() <BrickletIndustrialAnalogOut::setCurrent>`.
 


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

.. php:function:: void BrickletIndustrialAnalogOut::setConfiguration(int $voltage_range, int $current_range)

 Configures the voltage and current range.
 
 Possible voltage ranges are:
 
 * 0V to 5V
 * 0V to 10V
 
 Possible current ranges are:
 
 * 4mA to 20mA
 * 0mA to 20mA
 * 0mA to 24mA
 
 The resolution will always be 12 bit. This means, that the
 precision is higher with a smaller range.
 
 The following constants are available for this function:
 
 * BrickletIndustrialAnalogOut::VOLTAGE_RANGE_0_TO_5V = 0
 * BrickletIndustrialAnalogOut::VOLTAGE_RANGE_0_TO_10V = 1
 * BrickletIndustrialAnalogOut::CURRENT_RANGE_4_TO_20MA = 0
 * BrickletIndustrialAnalogOut::CURRENT_RANGE_0_TO_20MA = 1
 * BrickletIndustrialAnalogOut::CURRENT_RANGE_0_TO_24MA = 2
 
.. php:function:: array BrickletIndustrialAnalogOut::getConfiguration()

 Returns the configuration as set by :php:func:`setConfiguration() <BrickletIndustrialAnalogOut::setConfiguration>`.
 
 The following constants are available for this function:
 
 * BrickletIndustrialAnalogOut::VOLTAGE_RANGE_0_TO_5V = 0
 * BrickletIndustrialAnalogOut::VOLTAGE_RANGE_0_TO_10V = 1
 * BrickletIndustrialAnalogOut::CURRENT_RANGE_4_TO_20MA = 0
 * BrickletIndustrialAnalogOut::CURRENT_RANGE_0_TO_20MA = 1
 * BrickletIndustrialAnalogOut::CURRENT_RANGE_0_TO_24MA = 2
 
 The returned array has the keys ``voltage_range`` and ``current_range``.

.. php:function:: array BrickletIndustrialAnalogOut::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 BrickletIndustrialAnalogOut::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() <BrickletIndustrialAnalogOut::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() <BrickletIndustrialAnalogOut::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletIndustrialAnalogOut::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:
 
 * BrickletIndustrialAnalogOut::FUNCTION_ENABLE = 1
 * BrickletIndustrialAnalogOut::FUNCTION_DISABLE = 2
 * BrickletIndustrialAnalogOut::FUNCTION_SET_VOLTAGE = 4
 * BrickletIndustrialAnalogOut::FUNCTION_SET_CURRENT = 6
 * BrickletIndustrialAnalogOut::FUNCTION_SET_CONFIGURATION = 8
 
.. php:function:: void BrickletIndustrialAnalogOut::setResponseExpectedAll(bool $response_expected)

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



.. _industrial_analog_out_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletIndustrialAnalogOut::DEVICE_IDENTIFIER

 This constant is used to identify a Industrial Analog Out Bricklet.

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

