Deutsch
English
Menu
Software / API Bindings / PHP / API Reference and Examples / Bricklets / Industrial Quad Relay Bricklet 2.0

PHP - Industrial Quad Relay Bricklet 2.0

This is the description of the PHP API bindings for the Industrial Quad Relay Bricklet 2.0. General information and technical specifications for the Industrial Quad Relay 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
32
33
34
35
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialQuadRelayV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Industrial Quad Relay Bricklet 2.0

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

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

// Turn relays alternating on/off 10 times with 100 ms delay
for($i = 0; $i < 10; $i++) {
    usleep(100*1000);
    $iqr->setValue(array(TRUE, FALSE, FALSE, FALSE));
    usleep(100*1000);
    $iqr->setValue(array(FALSE, TRUE, FALSE, FALSE));
    usleep(100*1000);
    $iqr->setValue(array(FALSE, FALSE, TRUE, FALSE));
    usleep(100*1000);
    $iqr->setValue(array(FALSE, FALSE, FALSE, TRUE));
}

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 BrickletIndustrialQuadRelayV2(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $industrial_quad_relay_v2 – Type: BrickletIndustrialQuadRelayV2

Creates an object with the unique device ID $uid:

<?php   $industrial_quad_relay_v2 = new BrickletIndustrialQuadRelayV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletIndustrialQuadRelayV2::setValue(array $value)
Parameters:
  • $value – Type: array(bool, ...), Length: 4

Sets the value of all four relays. A value of true closes the relay and a value of false opens the relay.

Use setSelectedValue() to only change one relay.

All running monoflop timers will be aborted if this function is called.

array BrickletIndustrialQuadRelayV2::getValue()
Returns:
  • $value – Type: array(bool, ...), Length: 4

Returns the values as set by setValue().

void BrickletIndustrialQuadRelayV2::setChannelLEDConfig(int $channel, int $config)
Parameters:
  • $channel – Type: int, Range: [0 to 3]
  • $config – Type: int, Range: See constants, Default: 3

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.

The following constants are available for this function:

For $config:

  • BrickletIndustrialQuadRelayV2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialQuadRelayV2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialQuadRelayV2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialQuadRelayV2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialQuadRelayV2::getChannelLEDConfig(int $channel)
Parameters:
  • $channel – Type: int, Range: [0 to 3]
Returns:
  • $config – Type: int, Range: See constants, Default: 3

Returns the channel LED configuration as set by setChannelLEDConfig()

The following constants are available for this function:

For $config:

  • BrickletIndustrialQuadRelayV2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialQuadRelayV2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialQuadRelayV2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialQuadRelayV2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions

void BrickletIndustrialQuadRelayV2::setMonoflop(int $channel, bool $value, int $time)
Parameters:
  • $channel – Type: int, Range: [0 to 3]
  • $value – Type: bool
  • $time – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

Configures a monoflop of the specified channel.

The second parameter is the desired value of the specified channel. A true means relay closed and a false means relay open.

The third parameter indicates the time that the channels should hold the value.

If this function is called with the parameters (0, 1, 1500) channel 0 will close and in 1.5s channel 0 will open again

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Industrial Quad Relay Bricklet 2.0 connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and channel 0 closed. Channel 0 will be closed all the time. If now the RS485 connection is lost, then channel 0 will be opened in at most two seconds.

array BrickletIndustrialQuadRelayV2::getMonoflop(int $channel)
Parameters:
  • $channel – Type: int, Range: [0 to 3]
Return Array:
  • 'value' – Type: bool
  • 'time' – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]
  • 'time_remaining' – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

Returns (for the given channel) the current value and the time as set by setMonoflop() as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

void BrickletIndustrialQuadRelayV2::setSelectedValue(int $channel, bool $value)
Parameters:
  • $channel – Type: int, Range: [0 to 3]
  • $value – Type: bool

Sets the output value of the specified channel without affecting the other channels.

A running monoflop timer for the specified channel will be aborted if this function is called.

array BrickletIndustrialQuadRelayV2::getSPITFPErrorCount()
Return Array:
  • 'error_count_ack_checksum' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_message_checksum' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_frame' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_overflow' – Type: int, Range: [0 to 232 - 1]

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.

void BrickletIndustrialQuadRelayV2::setStatusLEDConfig(int $config)
Parameters:
  • $config – Type: int, Range: See constants, Default: 3

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:

For $config:

  • BrickletIndustrialQuadRelayV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialQuadRelayV2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialQuadRelayV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialQuadRelayV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialQuadRelayV2::getStatusLEDConfig()
Returns:
  • $config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For $config:

  • BrickletIndustrialQuadRelayV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialQuadRelayV2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialQuadRelayV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialQuadRelayV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialQuadRelayV2::getChipTemperature()
Returns:
  • $temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature 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 BrickletIndustrialQuadRelayV2::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!

array BrickletIndustrialQuadRelayV2::getIdentity()
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 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', '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 BrickletIndustrialQuadRelayV2::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.

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_quad_relay_v2->registerCallback(BrickletIndustrialQuadRelayV2::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 BrickletIndustrialQuadRelayV2::CALLBACK_MONOFLOP_DONE
<?php   void callback(int $channel, bool $value [, mixed $user_data])   ?>
Callback Parameters:
  • $channel – Type: int, Range: [0 to 3]
  • $value – Type: bool
  • $user_data – Type: mixed

This callback is triggered whenever a monoflop timer reaches 0. The parameters contain the channel and the current value of the channel (the value after the monoflop).

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 BrickletIndustrialQuadRelayV2::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 BrickletIndustrialQuadRelayV2::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:

  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_VALUE = 1
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_MONOFLOP = 3
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_SELECTED_VALUE = 5
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_CHANNEL_LED_CONFIG = 6
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialQuadRelayV2::FUNCTION_RESET = 243
  • BrickletIndustrialQuadRelayV2::FUNCTION_WRITE_UID = 248
void BrickletIndustrialQuadRelayV2::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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_VALUE = 1
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_MONOFLOP = 3
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_SELECTED_VALUE = 5
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_CHANNEL_LED_CONFIG = 6
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialQuadRelayV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialQuadRelayV2::FUNCTION_RESET = 243
  • BrickletIndustrialQuadRelayV2::FUNCTION_WRITE_UID = 248
void BrickletIndustrialQuadRelayV2::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.

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletIndustrialQuadRelayV2::setBootloaderMode(int $mode)
Parameters:
  • $mode – Type: int, Range: See constants
Returns:
  • $status – Type: int, Range: See constants

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:

For $mode:

  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For $status:

  • BrickletIndustrialQuadRelayV2::BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletIndustrialQuadRelayV2::getBootloaderMode()
Returns:
  • $mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For $mode:

  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialQuadRelayV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialQuadRelayV2::setWriteFirmwarePointer(int $pointer)
Parameters:
  • $pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]

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 BrickletIndustrialQuadRelayV2::writeFirmware(array $data)
Parameters:
  • $data – Type: array(int, ...), Length: 64, Range: [0 to 255]
Returns:
  • $status – Type: int, Range: [0 to 255]

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 BrickletIndustrialQuadRelayV2::writeUID(int $uid)
Parameters:
  • $uid – Type: int, Range: [0 to 232 - 1]

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 BrickletIndustrialQuadRelayV2::readUID()
Returns:
  • $uid – Type: int, Range: [0 to 232 - 1]

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

Constants

int BrickletIndustrialQuadRelayV2::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Quad Relay 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 BrickletIndustrialQuadRelayV2::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Quad Relay Bricklet 2.0.