PHP - Remote Switch Bricklet

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

Switch Socket

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRemoteSwitch;

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

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

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

// Switch on a type A socket with house code 17 and receiver code 1.
// House code 17 is 10001 in binary (least-significant bit first)
// and means that the DIP switches 1 and 5 are on and 2-4 are off.
// Receiver code 1 is 10000 in binary (least-significant bit first)
// and means that the DIP switch A is on and B-E are off.
$rs->switchSocketA(17, 1, BrickletRemoteSwitch::SWITCH_TO_ON);

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

Creates an object with the unique device ID $uid:

<?php   $remote_switch = new BrickletRemoteSwitch('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletRemoteSwitch::switchSocket(int $house_code, int $receiver_code, int $switch_to)
Parameters:
  • $house_code – Type: int, Range: [0 to 31]
  • $receiver_code – Type: int, Range: [0 to 31]
  • $switch_to – Type: int, Range: See constants

This function is deprecated, use switchSocketA() instead.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitch::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch::SWITCH_TO_ON = 1
int BrickletRemoteSwitch::getSwitchingState()
Returns:
  • $state – Type: int, Range: See constants

Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any calls of switchSocket() until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see setRepeats().

The following constants are available for this function:

For $state:

  • BrickletRemoteSwitch::SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitch::SWITCHING_STATE_BUSY = 1
void BrickletRemoteSwitch::switchSocketA(int $house_code, int $receiver_code, int $switch_to)
Parameters:
  • $house_code – Type: int, Range: [0 to 31]
  • $receiver_code – Type: int, Range: [0 to 31]
  • $switch_to – Type: int, Range: See constants

To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the house and receiver code can be found here.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitch::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch::SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

void BrickletRemoteSwitch::switchSocketB(int $address, int $unit, int $switch_to)
Parameters:
  • $address – Type: int, Range: [0 to 67108863]
  • $unit – Type: int, Range: [0 to 15, 255]
  • $switch_to – Type: int, Range: See constants

To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.

To switch all devices with the same address use 255 for the unit.

A detailed description on how you can teach a socket the address and unit can be found here.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitch::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch::SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

void BrickletRemoteSwitch::dimSocketB(int $address, int $unit, int $dim_value)
Parameters:
  • $address – Type: int, Range: [0 to 67108863]
  • $unit – Type: int, Range: [0 to 15, 255]
  • $dim_value – Type: int, Range: [0 to 255]

To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.

A detailed description on how you can teach a dimmer the address and unit can be found here.

New in version 2.0.1 (Plugin).

void BrickletRemoteSwitch::switchSocketC(string $system_code, int $device_code, int $switch_to)
Parameters:
  • $system_code – Type: string, Range: ['A' to 'P']
  • $device_code – Type: int, Range: [1 to 16]
  • $switch_to – Type: int, Range: See constants

To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the system and device code can be found here.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitch::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch::SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

Advanced Functions

void BrickletRemoteSwitch::setRepeats(int $repeats)
Parameters:
  • $repeats – Type: int, Range: [0 to 255], Default: 5

Sets the number of times the code is send when of the switchSocket() functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed.

Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.

int BrickletRemoteSwitch::getRepeats()
Returns:
  • $repeats – Type: int, Range: [0 to 255], Default: 5

Returns the number of repeats as set by setRepeats().

array BrickletRemoteSwitch::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', 'i', '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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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 BrickletRemoteSwitch::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";
}

$remote_switch->registerCallback(BrickletRemoteSwitch::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 BrickletRemoteSwitch::CALLBACK_SWITCHING_DONE
<?php   void callback([mixed $user_data])   ?>
Callback Parameters:
  • $user_data – Type: mixed

This callback is triggered whenever the switching state changes from busy to ready, see getSwitchingState().

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 BrickletRemoteSwitch::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 BrickletRemoteSwitch::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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET = 1
  • BrickletRemoteSwitch::FUNCTION_SET_REPEATS = 4
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_A = 6
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_B = 7
  • BrickletRemoteSwitch::FUNCTION_DIM_SOCKET_B = 8
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_C = 9
void BrickletRemoteSwitch::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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET = 1
  • BrickletRemoteSwitch::FUNCTION_SET_REPEATS = 4
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_A = 6
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_B = 7
  • BrickletRemoteSwitch::FUNCTION_DIM_SOCKET_B = 8
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_C = 9
void BrickletRemoteSwitch::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 BrickletRemoteSwitch::DEVICE_IDENTIFIER

This constant is used to identify a Remote Switch 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 BrickletRemoteSwitch::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Remote Switch Bricklet.