Software / API Bindings / PHP / API Reference and Examples / Bricklets / Industrial Dual 0-20mA Bricklet

PHP - Industrial Dual 0-20mA Bricklet¶

This is the description of the PHP API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA 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)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDual020mA;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

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

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

// Get current current from sensor 1
$current = $id020->getCurrent(1);
echo "Current (Sensor 1): " . $current/1000000.0 . " mA\n";

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

?>

Callback¶

Download (ExampleCallback.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDual020mA;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

// Callback function for current callback
function cb_current($sensor, $current)
{
    echo "Sensor: $sensor\n";
    echo "Current: " . $current/1000000.0 . " mA\n";
    echo "\n";
}

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

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

// Register current callback to function cb_current
$id020->registerCallback(BrickletIndustrialDual020mA::CALLBACK_CURRENT, 'cb_current');

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

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

?>

Threshold¶

Download (ExampleThreshold.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDual020mA;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

// Callback function for current reached callback
function cb_currentReached($sensor, $current)
{
    echo "Sensor: $sensor\n";
    echo "Current: " . $current/1000000.0 . " mA\n";
    echo "\n";
}

$ipcon = new IPConnection(); // Create IP connection
$id020 = new BrickletIndustrialDual020mA(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)
$id020->setDebouncePeriod(10000);

// Register current reached callback to function cb_currentReached
$id020->registerCallback(BrickletIndustrialDual020mA::CALLBACK_CURRENT_REACHED,
                         'cb_currentReached');

// Configure threshold for current (sensor 1) "greater than 10 mA"
$id020->setCurrentCallbackThreshold(1, '>', 10*1000000, 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 BrickletIndustrialDual020mA(string $uid, IPConnection $ipcon)¶

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$industrial_dual_0_20ma – Type: BrickletIndustrialDual020mA

Creates an object with the unique device ID $uid:

<?php   $industrial_dual_0_20ma = new BrickletIndustrialDual020mA('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected.

int BrickletIndustrialDual020mA::getCurrent(int $sensor)¶

Parameters:	$sensor – Type: int, Range: [0 to 1]
Returns:	$current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified sensor.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works properly.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

If you want to get the current periodically, it is recommended to use the CALLBACK_CURRENT callback and set the period with setCurrentCallbackPeriod().

Advanced Functions¶

void BrickletIndustrialDual020mA::setSampleRate(int $rate)¶

Parameters:	$rate – Type: int, Range: See constants, Default: 3

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value	Description
0	240 samples per second, 12 bit resolution
1	60 samples per second, 14 bit resolution
2	15 samples per second, 16 bit resolution
3	4 samples per second, 18 bit resolution

The following constants are available for this function:

For $rate:

BrickletIndustrialDual020mA::SAMPLE_RATE_240_SPS = 0
BrickletIndustrialDual020mA::SAMPLE_RATE_60_SPS = 1
BrickletIndustrialDual020mA::SAMPLE_RATE_15_SPS = 2
BrickletIndustrialDual020mA::SAMPLE_RATE_4_SPS = 3

int BrickletIndustrialDual020mA::getSampleRate()¶

Returns:	$rate – Type: int, Range: See constants, Default: 3

Returns the sample rate as set by setSampleRate().

The following constants are available for this function:

For $rate:

BrickletIndustrialDual020mA::SAMPLE_RATE_240_SPS = 0
BrickletIndustrialDual020mA::SAMPLE_RATE_60_SPS = 1
BrickletIndustrialDual020mA::SAMPLE_RATE_15_SPS = 2
BrickletIndustrialDual020mA::SAMPLE_RATE_4_SPS = 3

array BrickletIndustrialDual020mA::getIdentity()¶

Return Array:

Return Array:	'uid' – Type: string, Length: up to 8 'connected_uid' – Type: string, Length: up to 8 'position' – Type: string, Range: ['a' to 'h', 'z'] 'hardware_version' – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 'firmware_version' – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 'device_identifier' – Type: int, Range: [0 to 2¹⁶ - 1]

'uid' – Type: string, Length: up to 8
'connected_uid' – Type: string, Length: up to 8
'position' – Type: string, Range: ['a' to 'h', 'z']
'hardware_version' – Type: array(int, ...), Length: 3

0: $major – Type: int, Range: [0 to 255]
1: $minor – Type: int, Range: [0 to 255]
2: $revision – Type: int, Range: [0 to 255]

'firmware_version' – Type: array(int, ...), Length: 3

0: $major – Type: int, Range: [0 to 255]
1: $minor – Type: int, Range: [0 to 255]
2: $revision – Type: int, Range: [0 to 255]

'device_identifier' – Type: int, Range: [0 to 2¹⁶ - 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

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

Parameters:	$callback_id – Type: int $callback – Type: callable $user_data – Type: mixed

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 BrickletIndustrialDual020mA::setCurrentCallbackPeriod(int $sensor, int $period)¶

Parameters:	$sensor – Type: int, Range: [0 to 1] $period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CALLBACK_CURRENT callback is triggered periodically for the given sensor. A value of 0 turns the callback off.

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

int BrickletIndustrialDual020mA::getCurrentCallbackPeriod(int $sensor)¶

Parameters:	$sensor – Type: int, Range: [0 to 1]
Returns:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setCurrentCallbackPeriod().

void BrickletIndustrialDual020mA::setCurrentCallbackThreshold(int $sensor, string $option, int $min, int $max)¶

Parameters:	$sensor – Type: int, Range: [0 to 1] $option – Type: string, Range: See constants, Default: 'x' $min – Type: int, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0 $max – Type: int, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Sets the thresholds for the CALLBACK_CURRENT_REACHED callback for the given sensor.

The following options are possible:

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

The following constants are available for this function:

For $option:

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

array BrickletIndustrialDual020mA::getCurrentCallbackThreshold(int $sensor)¶

Parameters:	$sensor – Type: int, Range: [0 to 1]
Return Array:	'option' – Type: string, Range: See constants, Default: 'x' 'min' – Type: int, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0 'max' – Type: int, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by setCurrentCallbackThreshold().

The following constants are available for this function:

For $option:

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

void BrickletIndustrialDual020mA::setDebouncePeriod(int $debounce)¶

Parameters:	$debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callback

CALLBACK_CURRENT_REACHED

is triggered, if the threshold

setCurrentCallbackThreshold()

keeps being reached.

int BrickletIndustrialDual020mA::getDebouncePeriod()¶

Returns:	$debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

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";
}

$industrial_dual_0_20ma->registerCallback(BrickletIndustrialDual020mA::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 BrickletIndustrialDual020mA::CALLBACK_CURRENT¶

<?php   void callback(int $sensor, int $current [, mixed $user_data])   ?>

Callback Parameters:	$sensor – Type: int, Range: [0 to 1] $current – Type: int, Unit: 1 nA, Range: [0 to 22505322] $user_data – Type: mixed

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

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

int BrickletIndustrialDual020mA::CALLBACK_CURRENT_REACHED¶

<?php   void callback(int $sensor, int $current [, mixed $user_data])   ?>

Callback Parameters:	$sensor – Type: int, Range: [0 to 1] $current – Type: int, Unit: 1 nA, Range: [0 to 22505322] $user_data – Type: mixed

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

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

array BrickletIndustrialDual020mA::getAPIVersion()¶

Return Array:	$api_version – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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 BrickletIndustrialDual020mA::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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

BrickletIndustrialDual020mA::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
BrickletIndustrialDual020mA::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
BrickletIndustrialDual020mA::FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletIndustrialDual020mA::FUNCTION_SET_SAMPLE_RATE = 8

void BrickletIndustrialDual020mA::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.

The following constants are available for this function:

For $function_id:

BrickletIndustrialDual020mA::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
BrickletIndustrialDual020mA::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
BrickletIndustrialDual020mA::FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletIndustrialDual020mA::FUNCTION_SET_SAMPLE_RATE = 8

void BrickletIndustrialDual020mA::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.

Constants¶

int BrickletIndustrialDual020mA::DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Dual 0-20mA 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 BrickletIndustrialDual020mA::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet.