PHP - Industrial Dual Relay Bricklet

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDualRelay;

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

$ipcon = new IPConnection(); // Create IP connection
$idr = new BrickletIndustrialDualRelay(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 1 second delay
for($i = 0; $i < 5; $i++) {
    sleep(1);
    $idr->setValue(TRUE, FALSE);
    sleep(1);
    $idr->setValue(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 BrickletIndustrialDualRelay(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $industrial_dual_relay = new BrickletIndustrialDualRelay('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletIndustrialDualRelay::setValue(bool $channel0, bool $channel1)

Sets the state of the relays, true means on and false means off. For example: (true, false) turns relay 0 on and relay 1 off.

If you just want to set one of the relays and don't know the current state of the other relay, you can get the state with getValue() or you can use setSelectedValue().

Running monoflop timers will be overwritten if this function is called.

The default value is (false, false).

array BrickletIndustrialDualRelay::getValue()

Returns the state of the relays, true means on and false means off.

The returned array has the keys channel0 and channel1.

Advanced Functions

void BrickletIndustrialDualRelay::setMonoflop(int $channel, bool $value, int $time)

The first parameter can be 0 or 1 (relay 0 or relay 1). The second parameter is the desired state of the relay (true means on and false means off). The third parameter indicates the time (in ms) that the relay should hold the state.

If this function is called with the parameters (1, true, 1500): Relay 1 will turn on and in 1.5s it will turn off again.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a Industrial Dual Relay Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The relay will be on all the time. If now the RS485 connection is lost, the relay will turn off in at most two seconds.

array BrickletIndustrialDualRelay::getMonoflop(int $channel)

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

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

The returned array has the keys value, time and time_remaining.

void BrickletIndustrialDualRelay::setSelectedValue(int $channel, bool $value)

Sets the state of the selected relay (0 or 1), true means on and false means off.

The other relay remains untouched.

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

  • BrickletIndustrialDualRelay::FUNCTION_SET_VALUE = 1
  • BrickletIndustrialDualRelay::FUNCTION_SET_MONOFLOP = 3
  • BrickletIndustrialDualRelay::FUNCTION_SET_SELECTED_VALUE = 6
  • BrickletIndustrialDualRelay::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDualRelay::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDualRelay::FUNCTION_RESET = 243
  • BrickletIndustrialDualRelay::FUNCTION_WRITE_UID = 248
void BrickletIndustrialDualRelay::setResponseExpectedAll(bool $response_expected)

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

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

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

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

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

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

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

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

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_relay->registerCallback(BrickletIndustrialDualRelay::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 BrickletIndustrialDualRelay::CALLBACK_MONOFLOP_DONE
<?php   void callback(int $channel, bool $value [, mixed $user_data])   ?>

This callback is triggered whenever a monoflop timer reaches 0. The parameter contain the relay (0 or 1) and the current state of the relay (the state after the monoflop).

Constants

int BrickletIndustrialDualRelay::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual Relay Bricklet.

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

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