PHP - Analog In Bricklet 2.0

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAnalogInV2;

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

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

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

// Get current voltage
$voltage = $ai->getVoltage();
echo "Voltage: " . $voltage/1000.0 . " V\n";

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

?>

Callback

Download (ExampleCallback.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
29
30
31
32
33
34
35
36
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAnalogInV2;

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

// Callback function for voltage callback
function cb_voltage($voltage)
{
    echo "Voltage: " . $voltage/1000.0 . " V\n";
}

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

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

// Register voltage callback to function cb_voltage
$ai->registerCallback(BrickletAnalogInV2::CALLBACK_VOLTAGE, 'cb_voltage');

// Set period for voltage callback to 1s (1000ms)
// Note: The voltage callback is only called every second
//       if the voltage has changed since the last call!
$ai->setVoltageCallbackPeriod(1000);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Threshold

Download (ExampleThreshold.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
29
30
31
32
33
34
35
36
37
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAnalogInV2;

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

// Callback function for voltage reached callback
function cb_voltageReached($voltage)
{
    echo "Voltage: " . $voltage/1000.0 . " V\n";
}

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

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

// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$ai->setDebouncePeriod(10000);

// Register voltage reached callback to function cb_voltageReached
$ai->registerCallback(BrickletAnalogInV2::CALLBACK_VOLTAGE_REACHED, 'cb_voltageReached');

// Configure threshold for voltage "smaller than 5 V"
$ai->setVoltageCallbackThreshold('<', 5*1000, 0);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

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

Basic Functions

class BrickletAnalogInV2(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $analog_in_v2 = new BrickletAnalogInV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletAnalogInV2::getVoltage()

Returns the measured voltage. The value is in mV and between 0V and 42V. The resolution is approximately 10mV.

If you want to get the voltage periodically, it is recommended to use the CALLBACK_VOLTAGE callback and set the period with setVoltageCallbackPeriod().

Advanced Functions

int BrickletAnalogInV2::getAnalogValue()

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

If you want the analog value periodically, it is recommended to use the CALLBACK_ANALOG_VALUE callback and set the period with setAnalogValueCallbackPeriod().

void BrickletAnalogInV2::setMovingAverage(int $average)

Sets the length of a moving averaging for the voltage.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

The range for the averaging is 1-50.

The default value is 50.

int BrickletAnalogInV2::getMovingAverage()

Returns the length of the moving average as set by setMovingAverage().

array BrickletAnalogInV2::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 BrickletAnalogInV2::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 BrickletAnalogInV2::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:

  • BrickletAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • BrickletAnalogInV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • BrickletAnalogInV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletAnalogInV2::FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletAnalogInV2::FUNCTION_SET_MOVING_AVERAGE = 13
void BrickletAnalogInV2::setResponseExpectedAll(bool $response_expected)

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

array BrickletAnalogInV2::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.

Callback Configuration Functions

void BrickletAnalogInV2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

void BrickletAnalogInV2::setVoltageCallbackPeriod(int $period)

Sets the period in ms with which the CALLBACK_VOLTAGE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

The default value is 0.

int BrickletAnalogInV2::getVoltageCallbackPeriod()

Returns the period as set by setVoltageCallbackPeriod().

void BrickletAnalogInV2::setAnalogValueCallbackPeriod(int $period)

Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has changed since the last triggering.

The default value is 0.

int BrickletAnalogInV2::getAnalogValueCallbackPeriod()

Returns the period as set by setAnalogValueCallbackPeriod().

void BrickletAnalogInV2::setVoltageCallbackThreshold(string $option, int $min, int $max)

Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the voltage is outside the min and max values
'i' Callback is triggered when the voltage is inside the min and max values
'<' Callback is triggered when the voltage is smaller than the min value (max is ignored)
'>' Callback is triggered when the voltage is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletAnalogInV2::getVoltageCallbackThreshold()

Returns the threshold as set by setVoltageCallbackThreshold().

The following constants are available for this function:

  • BrickletAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV2::THRESHOLD_OPTION_GREATER = '>'

The returned array has the keys option, min and max.

void BrickletAnalogInV2::setAnalogValueCallbackThreshold(string $option, int $min, int $max)

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the analog value is outside the min and max values
'i' Callback is triggered when the analog value is inside the min and max values
'<' Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>' Callback is triggered when the analog value is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletAnalogInV2::getAnalogValueCallbackThreshold()

Returns the threshold as set by setAnalogValueCallbackThreshold().

The following constants are available for this function:

  • BrickletAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAnalogInV2::THRESHOLD_OPTION_GREATER = '>'

The returned array has the keys option, min and max.

void BrickletAnalogInV2::setDebouncePeriod(int $debounce)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

int BrickletAnalogInV2::getDebouncePeriod()

Returns the debounce period as set by setDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$analog_in_v2->registerCallback(BrickletAnalogInV2::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.

int BrickletAnalogInV2::CALLBACK_VOLTAGE
<?php   void callback(int $voltage [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setVoltageCallbackPeriod(). The parameter is the voltage of the sensor.

Der CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

int BrickletAnalogInV2::CALLBACK_ANALOG_VALUE
<?php   void callback(int $value [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setAnalogValueCallbackPeriod(). The parameter is the analog value of the sensor.

The CALLBACK_ANALOG_VALUE callback is only triggered if the voltage has changed since the last triggering.

int BrickletAnalogInV2::CALLBACK_VOLTAGE_REACHED
<?php   void callback(int $voltage [, mixed $user_data])   ?>

This callback is triggered when the threshold as set by setVoltageCallbackThreshold() is reached. The parameter is the voltage of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

int BrickletAnalogInV2::CALLBACK_ANALOG_VALUE_REACHED
<?php   void callback(int $value [, mixed $user_data])   ?>

This callback is triggered when the threshold as set by setAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

Constants

int BrickletAnalogInV2::DEVICE_IDENTIFIER

This constant is used to identify a Analog In Bricklet 2.0.

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 BrickletAnalogInV2::DEVICE_DISPLAY_NAME

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