PHP - Dual Relay Bricklet¶

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDualRelay;

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

$ipcon = new IPConnection(); // Create IP connection
$dr = new BrickletDualRelay(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);
    $dr->setState(TRUE, FALSE);
    sleep(1);
    $dr->setState(FALSE, TRUE);
}

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

?>

Basic Functions¶

class BrickletDualRelay(string $uid, IPConnection $ipcon)¶

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$dual_relay – Type: BrickletDualRelay

Creates an object with the unique device ID $uid:

<?php   $dual_relay = new BrickletDualRelay('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletDualRelay::setState(bool $relay1, bool $relay2)¶

Parameters:	$relay1 – Type: bool, Default: FALSE $relay2 – Type: bool, Default: FALSE

Sets the state of the relays, true means on and false means off. For example: (true, false) turns relay 1 on and relay 2 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 getState() or you can use setSelectedState().

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

array BrickletDualRelay::getState()¶

Return Array:	'relay1' – Type: bool, Default: FALSE 'relay2' – Type: bool, Default: FALSE

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

Advanced Functions¶

void BrickletDualRelay::setMonoflop(int $relay, bool $state, int $time)¶

Parameters:	$relay – Type: int, Range: [1 to 2] $state – Type: bool $time – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

The first parameter can be 1 or 2 (relay 1 or relay 2). The second parameter is the desired state of the relay (true means on and false means off). The third parameter indicates the time 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 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 BrickletDualRelay::getMonoflop(int $relay)¶

Parameters:	$relay – Type: int, Range: [1 to 2]
Return Array:	'state' – 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 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.

void BrickletDualRelay::setSelectedState(int $relay, bool $state)¶

Parameters:	$relay – Type: int, Range: [1 to 2] $state – Type: bool

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

A running monoflop timer for the selected relay will be aborted if this function is called.

The other relay remains untouched.

array BrickletDualRelay::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 BrickletDualRelay::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";
}

$dual_relay->registerCallback(BrickletDualRelay::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

int BrickletDualRelay::CALLBACK_MONOFLOP_DONE¶

<?php   void callback(int $relay, bool $state [, mixed $user_data])   ?>

Callback Parameters:	$relay – Type: int, Range: [1 to 2] $state – Type: bool $user_data – Type: mixed

This callback is triggered whenever a monoflop timer reaches 0. The parameter contain the relay (1 or 2) and the current state of the relay (the state 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 BrickletDualRelay::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 BrickletDualRelay::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:

• BrickletDualRelay::FUNCTION_SET_STATE = 1
• BrickletDualRelay::FUNCTION_SET_MONOFLOP = 3
• BrickletDualRelay::FUNCTION_SET_SELECTED_STATE = 6

void BrickletDualRelay::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:

• BrickletDualRelay::FUNCTION_SET_STATE = 1
• BrickletDualRelay::FUNCTION_SET_MONOFLOP = 3
• BrickletDualRelay::FUNCTION_SET_SELECTED_STATE = 6

void BrickletDualRelay::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 BrickletDualRelay::DEVICE_IDENTIFIER¶

This constant is used to identify a Dual Relay 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 BrickletDualRelay::DEVICE_DISPLAY_NAME¶

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