PHP - Industrial Digital In 4 Bricklet 2.0

This is the description of the PHP API bindings for the Industrial Digital In 4 Bricklet 2.0. General information and technical specifications for the Industrial Digital In 4 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
28
29
30
31
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalIn4V2;

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

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

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

// Get current value
$value = $idi4->getValue();

echo "Channel 0: " . $value[0] . "\n";
echo "Channel 1: " . $value[1] . "\n";
echo "Channel 2: " . $value[2] . "\n";
echo "Channel 3: " . $value[3] . "\n";

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

?>

Edge Count

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalIn4V2;

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

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

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

// Configure rising edge count (channel 3) with 10ms debounce
$idi4->setEdgeCountConfiguration(3, 0, 10);

// Get edge count 10 times with 1s delay
for($i = 0; $i < 10; $i++) {
    sleep(1);

    // Get current edge count
    $count = $idi4->getEdgeCount(3, FALSE);
    echo "Count: $count\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
37
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalIn4V2;

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

// Callback function for value callback
function cb_value($channel, $changed, $value)
{
    echo "Channel: $channel\n";
    echo "Changed: $changed\n";
    echo "Value: $value\n";
    echo "\n";
}

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

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

// Register value callback to function cb_value
$idi4->registerCallback(BrickletIndustrialDigitalIn4V2::CALLBACK_VALUE, 'cb_value');

// Set period for value (channel 1) callback to 0.1s (100ms)
$idi4->setValueCallbackConfiguration(1, 100, FALSE);

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 BrickletIndustrialDigitalIn4V2(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $industrial_digital_in_4_v2 = new BrickletIndustrialDigitalIn4V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

array BrickletIndustrialDigitalIn4V2::getValue()

Returns the input value as bools, true refers to high and false refers to low.

void BrickletIndustrialDigitalIn4V2::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 is on if the channel is high and off otherwise.

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

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialDigitalIn4V2::getChannelLEDConfig(int $channel)

Returns the channel LED configuration as set by setChannelLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions

int BrickletIndustrialDigitalIn4V2::getEdgeCount(int $channel, bool $reset_counter)

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with setEdgeCountConfiguration().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
void BrickletIndustrialDigitalIn4V2::setEdgeCountConfiguration(int $channel, int $edge_type, int $debounce)

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

  • 0 = rising (default)
  • 1 = falling
  • 2 = both

The debounce time is given in ms.

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

Default values: 0 (edge type) and 100ms (debounce time)

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_BOTH = 2
array BrickletIndustrialDigitalIn4V2::getEdgeCountConfiguration(int $channel)

Returns the edge type and debounce time for the selected channel as set by setEdgeCountConfiguration().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2::EDGE_TYPE_BOTH = 2

The returned array has the keys edge_type and debounce.

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

  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2::FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2::FUNCTION_WRITE_UID = 248
void BrickletIndustrialDigitalIn4V2::setResponseExpectedAll(bool $response_expected)

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

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

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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:

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::readUID()

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

array BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::setValueCallbackConfiguration(int $channel, int $period, bool $value_has_to_change)

This callback can be configured per channel.

The period in ms is the period with which the CALLBACK_VALUE 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.

The default value is (0, false).

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
array BrickletIndustrialDigitalIn4V2::getValueCallbackConfiguration(int $channel)

Returns the callback configuration for the given channel as set by setValueCallbackConfiguration().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

The returned array has the keys period and value_has_to_change.

void BrickletIndustrialDigitalIn4V2::setAllValueCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms is the period with which the CALLBACK_ALL_VALUE 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.

The default value is (0, false).

array BrickletIndustrialDigitalIn4V2::getAllValueCallbackConfiguration()

Returns the callback configuration as set by setAllValueCallbackConfiguration().

The returned array has the keys period and value_has_to_change.

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_digital_in_4_v2->registerCallback(BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::CALLBACK_VALUE
<?php   void callback(int $channel, bool $changed, bool $value [, mixed $user_data])   ?>

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

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
int BrickletIndustrialDigitalIn4V2::CALLBACK_ALL_VALUE
<?php   void callback(array $changed, array $value [, mixed $user_data])   ?>

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

The parameters are the same as getValue(). Additional the changed parameter is true if the value has changed since the last callback.

Constants

int BrickletIndustrialDigitalIn4V2::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Digital In 4 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 BrickletIndustrialDigitalIn4V2::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.