PHP - Industrial Analog Out Bricklet

This is the description of the PHP API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out Bricklet are summarized in its hardware description.

An installation guide for the PHP API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple Current

Download (ExampleSimpleCurrent.php)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletIndustrialAnalogOut.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialAnalogOut;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Industrial Analog Out Bricklet

$ipcon = new IPConnection(); // Create IP connection
$iao = new BrickletIndustrialAnalogOut(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Set output current to 4.5mA
$iao->setCurrent(4500);
$iao->enable();

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$iao->disable();
$ipcon->disconnect();

?>

Simple Voltage

Download (ExampleSimpleVoltage.php)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletIndustrialAnalogOut.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialAnalogOut;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Industrial Analog Out Bricklet

$ipcon = new IPConnection(); // Create IP connection
$iao = new BrickletIndustrialAnalogOut(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Set output voltage to 3.3V
$iao->setVoltage(3300);
$iao->enable();

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$iao->disable();
$ipcon->disconnect();

?>

API

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

Basic Functions

class BrickletIndustrialAnalogOut(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

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

This object can then be used after the IP Connection is connected (see examples above).

void BrickletIndustrialAnalogOut::enable()

Enables the output of voltage and current.

The default is disabled.

void BrickletIndustrialAnalogOut::disable()

Disables the output of voltage and current.

The default is disabled.

bool BrickletIndustrialAnalogOut::isEnabled()

Returns true if output of voltage and current is enabled, false otherwise.

void BrickletIndustrialAnalogOut::setVoltage(int $voltage)

Sets the output voltage in mV.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

int BrickletIndustrialAnalogOut::getVoltage()

Returns the voltage as set by setVoltage().

void BrickletIndustrialAnalogOut::setCurrent(int $current)

Sets the output current in µA.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

int BrickletIndustrialAnalogOut::getCurrent()

Returns the current as set by setCurrent().

Advanced Functions

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 (default)

Possible current ranges are:

  • 4mA to 20mA (default)
  • 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
array BrickletIndustrialAnalogOut::getConfiguration()

Returns the configuration as set by 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.

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.

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 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 setResponseExpected() for the list of function ID constants available for this 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.

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
void BrickletIndustrialAnalogOut::setResponseExpectedAll(bool $response_expected)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

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 here. There is also a constant for the device identifier of this Bricklet.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Constants

int BrickletIndustrialAnalogOut::DEVICE_IDENTIFIER

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

The getIdentity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletIndustrialAnalogOut::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Analog Out Bricklet.