PHP - Industrial Dual Analog In Bricklet 2.0

This is the description of the PHP API bindings for the Industrial Dual Analog In Bricklet 2.0. General information and technical specifications for the Industrial Dual 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/BrickletIndustrialDualAnalogInV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDualAnalogInV2;

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

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

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

// Get current voltage from channel 0
$voltage = $idai->getVoltage(0);
echo "Voltage (Channel 0): " . $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/BrickletIndustrialDualAnalogInV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDualAnalogInV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$idai = new BrickletIndustrialDualAnalogInV2(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
$idai->registerCallback(BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE, 'cb_voltage');

// Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
$idai->setVoltageCallbackConfiguration(0, 1000, FALSE, 'x', 0, 0);

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/BrickletIndustrialDualAnalogInV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDualAnalogInV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$idai = new BrickletIndustrialDualAnalogInV2(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
$idai->registerCallback(BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE, 'cb_voltage');

// Configure threshold for voltage (channel 0) "greater than 10 V"
// with a debounce period of 10s (10000ms)
$idai->setVoltageCallbackConfiguration(0, 10000, FALSE, '>', 10*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 BrickletIndustrialDualAnalogInV2(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $industrial_dual_analog_in_v2 = new BrickletIndustrialDualAnalogInV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletIndustrialDualAnalogInV2::getVoltage(int $channel)

Returns the voltage for the given channel in mV.

If you want to get the value periodically, it is recommended to use the CALLBACK_VOLTAGE callback. You can set the callback configuration with setVoltageCallbackConfiguration().

void BrickletIndustrialDualAnalogInV2::setChannelLEDConfig(int $channel, int $config)

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.

You can configure the channel status behavior with setChannelLEDStatusConfig().

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialDualAnalogInV2::getChannelLEDConfig(int $channel)

Returns the channel LED configuration as set by setChannelLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
void BrickletIndustrialDualAnalogInV2::setChannelLEDStatusConfig(int $channel, int $min, int $max, int $config)

Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", see setChannelLEDConfig().

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in mV above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10V, the LED will turn on as soon as the voltage exceeds 10V and turn off again if it goes below 10V. For a negative threshold set the "max" parameter to the threshold value in mV below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10V, the LED will turn on as soon as the voltage goes below 10V and the LED will turn off when the voltage exceeds 10V.

In intensity mode you can define a range in mV that is used to scale the brightness of the LED. Example with min=4V, max=20V: The LED is off at 4V, on at 20V and the brightness is linearly scaled between the values 4V and 20V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

By default the channel LED status config is set to intensity with min=0V and max=10V.

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1
array BrickletIndustrialDualAnalogInV2::getChannelLEDStatusConfig(int $channel)

Returns the channel LED status configuration as set by setChannelLEDStatusConfig().

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialDualAnalogInV2::CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

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

Advanced Functions

void BrickletIndustrialDualAnalogInV2::setSampleRate(int $rate)

Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

The default value is 6 (2 samples per second).

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_1_SPS = 7
int BrickletIndustrialDualAnalogInV2::getSampleRate()

Returns the sample rate as set by setSampleRate().

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogInV2::SAMPLE_RATE_1_SPS = 7
void BrickletIndustrialDualAnalogInV2::setCalibration(array $offset, array $gain)

Sets offset and gain of MCP3911 internal calibration registers.

See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet 2.0 is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

array BrickletIndustrialDualAnalogInV2::getCalibration()

Returns the calibration as set by setCalibration().

The returned array has the keys offset and gain.

array BrickletIndustrialDualAnalogInV2::getADCValues()

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see setCalibration().

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

  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_SAMPLE_RATE = 5
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CALIBRATION = 7
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_CONFIG = 10
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDualAnalogInV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDualAnalogInV2::FUNCTION_RESET = 243
  • BrickletIndustrialDualAnalogInV2::FUNCTION_WRITE_UID = 248
void BrickletIndustrialDualAnalogInV2::setResponseExpectedAll(bool $response_expected)

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

array BrickletIndustrialDualAnalogInV2::getSPITFPErrorCount()

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

The returned array has the keys error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

int BrickletIndustrialDualAnalogInV2::setBootloaderMode(int $mode)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletIndustrialDualAnalogInV2::getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDualAnalogInV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialDualAnalogInV2::setWriteFirmwarePointer(int $pointer)

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletIndustrialDualAnalogInV2::writeFirmware(array $data)

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletIndustrialDualAnalogInV2::setStatusLEDConfig(int $config)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDualAnalogInV2::getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualAnalogInV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDualAnalogInV2::getChipTemperature()

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletIndustrialDualAnalogInV2::reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

void BrickletIndustrialDualAnalogInV2::writeUID(int $uid)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

int BrickletIndustrialDualAnalogInV2::readUID()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

array BrickletIndustrialDualAnalogInV2::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 BrickletIndustrialDualAnalogInV2::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 BrickletIndustrialDualAnalogInV2::setVoltageCallbackConfiguration(int $channel, int $period, bool $value_has_to_change, string $option, int $min, int $max)

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_VOLTAGE callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

The following constants are available for this function:

  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDualAnalogInV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletIndustrialDualAnalogInV2::getVoltageCallbackConfiguration(int $channel)

Returns the callback configuration as set by setVoltageCallbackConfiguration().

The following constants are available for this function:

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

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

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_analog_in_v2->registerCallback(BrickletIndustrialDualAnalogInV2::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 BrickletIndustrialDualAnalogInV2::CALLBACK_VOLTAGE
<?php   void callback(int $channel, int $voltage [, mixed $user_data])   ?>

This callback is triggered periodically according to the configuration set by setVoltageCallbackConfiguration().

The parameter is the same as getVoltage().

Constants

int BrickletIndustrialDualAnalogInV2::DEVICE_IDENTIFIER

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

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

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