PHP - Analog Out Bricklet

This is the description of the PHP API bindings for the Analog Out Bricklet. General information and technical specifications for the 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

Download (ExampleSimple.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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAnalogOut;

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

$ipcon = new IPConnection(); // Create IP connection
$ao = new BrickletAnalogOut(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
$ao->setVoltage(3300);

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

?>

API

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

Basic Functions

class BrickletAnalogOut(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $analog_out – Type: BrickletAnalogOut

Creates an object with the unique device ID $uid:

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

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

void BrickletAnalogOut::setVoltage(int $voltage)
Parameters:
  • $voltage – Type: int, Range: [0 to 216 - 1]

Sets the voltage in mV. The possible range is 0V to 5V (0-5000). Calling this function will set the mode to 0 (see setMode()).

The default value is 0 (with mode 1).

int BrickletAnalogOut::getVoltage()
Returns:
  • $voltage – Type: int, Range: [0 to 216 - 1]

Returns the voltage as set by setVoltage().

void BrickletAnalogOut::setMode(int $mode)
Parameters:
  • $mode – Type: int, Range: See constants

Sets the mode of the analog value. Possible modes:

  • 0: Normal Mode (Analog value as set by 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 setVoltage().

The default mode is 1.

The following constants are available for this function:

For $mode:

  • BrickletAnalogOut::MODE_ANALOG_VALUE = 0
  • BrickletAnalogOut::MODE_1K_TO_GROUND = 1
  • BrickletAnalogOut::MODE_100K_TO_GROUND = 2
  • BrickletAnalogOut::MODE_500K_TO_GROUND = 3
int BrickletAnalogOut::getMode()
Returns:
  • $mode – Type: int, Range: See constants

Returns the mode as set by setMode().

The following constants are available for this function:

For $mode:

  • 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

array BrickletAnalogOut::getAPIVersion()
Returns:
  • $api_version – Type: array(int, ...), Length: 3, Range: [0 to 255]

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 BrickletAnalogOut::getResponseExpected(int $function_id)
Parameters:
  • $function_id – Type: int, Range: See constants
Returns:
  • $response_expected – Type: bool

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.

The following constants are available for this function:

For $function_id:

  • BrickletAnalogOut::FUNCTION_SET_VOLTAGE = 1
  • BrickletAnalogOut::FUNCTION_SET_MODE = 3
void BrickletAnalogOut::setResponseExpected(int $function_id, bool $response_expected)
Parameters:
  • $function_id – Type: int, Range: See constants
  • $response_expected – Type: bool

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 constants are available for this function:

For $function_id:

  • BrickletAnalogOut::FUNCTION_SET_VOLTAGE = 1
  • BrickletAnalogOut::FUNCTION_SET_MODE = 3
void BrickletAnalogOut::setResponseExpectedAll(bool $response_expected)
Parameters:
  • $response_expected – Type: bool

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

array BrickletAnalogOut::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string
  • 'hardware_version' – Type: array(int, ...), Length: 3, Range: [0 to 255]
  • 'firmware_version' – Type: array(int, ...), Length: 3, Range: [0 to 255]
  • 'device_identifier' – Type: int, Range: [0 to 216 - 1]

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.

Constants

int BrickletAnalogOut::DEVICE_IDENTIFIER

This constant is used to identify a Analog Out Bricklet.

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

string BrickletAnalogOut::DEVICE_DISPLAY_NAME

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