PHP - Remote Switch Bricklet 2.0

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRemoteSwitchV2;

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

$ipcon = new IPConnection(); // Create IP connection
$rs = new BrickletRemoteSwitchV2(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, BrickletRemoteSwitchV2::SWITCH_TO_ON);

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

?>

Remote Callback

Download (ExampleRemoteCallback.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
38
39
40
41
42
43
44
45
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRemoteSwitchV2;

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

// Callback function for remote status a callback
function cb_remoteStatusA($house_code, $receiver_code, $switch_to, $repeats)
{
    echo "House Code: $house_code\n";
    echo "Receiver Code: $receiver_code\n";

    if ($switch_to == BrickletRemoteSwitchV2::SWITCH_TO_OFF) {
        echo "Switch To: Off\n";
    } elseif ($switch_to == BrickletRemoteSwitchV2::SWITCH_TO_ON) {
        echo "Switch To: On\n";
    }

    echo "Repeats: $repeats\n";
    echo "\n";
}

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

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

// Configure to receive from remote type A with minimum repeats set to 1 and enable callback
$rs->setRemoteConfiguration(BrickletRemoteSwitchV2::REMOTE_TYPE_A, 1, TRUE);

// Register remote status a callback to function cb_remoteStatusA
$rs->registerCallback(BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_A,
                      'cb_remoteStatusA');

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

Creates an object with the unique device ID $uid:

<?php   $remote_switch_v2 = new BrickletRemoteSwitchV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletRemoteSwitchV2::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 switch socket functions 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:

  • BrickletRemoteSwitchV2::SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitchV2::SWITCHING_STATE_BUSY = 1
void BrickletRemoteSwitchV2::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:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
void BrickletRemoteSwitchV2::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:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
void BrickletRemoteSwitchV2::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.

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

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
void BrickletRemoteSwitchV2::setRemoteConfiguration(int $remote_type, int $minimum_repeats, bool $callback_enabled)
Parameters:
  • $remote_type – Type: int, Range: See constants, Default: A
  • $minimum_repeats – Type: int, Range: [0 to 216 - 1], Default: 2
  • $callback_enabled – Type: bool, Default: FALSE

Sets the configuration for receiving data from a remote of type A, B or C.

The following constants are available for this function:

For $remote_type:

  • BrickletRemoteSwitchV2::REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2::REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2::REMOTE_TYPE_C = 2
array BrickletRemoteSwitchV2::getRemoteConfiguration()
Return Array:
  • 'remote_type' – Type: int, Range: See constants, Default: A
  • 'minimum_repeats' – Type: int, Range: [0 to 216 - 1], Default: 2
  • 'callback_enabled' – Type: bool, Default: FALSE

Returns the remote configuration as set by setRemoteConfiguration()

The following constants are available for this function:

For $remote_type:

  • BrickletRemoteSwitchV2::REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2::REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2::REMOTE_TYPE_C = 2
array BrickletRemoteSwitchV2::getRemoteStatusA()
Return Array:
  • 'house_code' – Type: int, Range: [0 to 31]
  • 'receiver_code' – Type: int, Range: [0 to 31]
  • 'switch_to' – Type: int, Range: See constants
  • 'repeats' – Type: int, Range: [0 to 216 - 1]

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see setRemoteConfiguration() and CALLBACK_REMOTE_STATUS_A callback.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
array BrickletRemoteSwitchV2::getRemoteStatusB()
Return Array:
  • 'address' – Type: int, Range: [0 to 67108863]
  • 'unit' – Type: int, Range: [0 to 15]
  • 'switch_to' – Type: int, Range: See constants
  • 'dim_value' – Type: int, Range: [0 to 255]
  • 'repeats' – Type: int, Range: [0 to 216 - 1]

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see setRemoteConfiguration() and CALLBACK_REMOTE_STATUS_B callback.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
array BrickletRemoteSwitchV2::getRemoteStatusC()
Return Array:
  • 'system_code' – Type: string, Range: ['A' to 'P']
  • 'device_code' – Type: int, Range: [1 to 16]
  • 'switch_to' – Type: int, Range: See constants
  • 'repeats' – Type: int, Range: [0 to 216 - 1]

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see setRemoteConfiguration() and CALLBACK_REMOTE_STATUS_C callback.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1

Advanced Functions

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

Sets the number of times the code is send when one of the Switch Socket 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 BrickletRemoteSwitchV2::getRepeats()
Returns:
  • $repeats – Type: int, Range: [0 to 255], Default: 5

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

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

int BrickletRemoteSwitchV2::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:

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

For $status:

  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_OK = 0
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletRemoteSwitchV2::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:

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

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

  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletRemoteSwitchV2::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 BrickletRemoteSwitchV2::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 BrickletRemoteSwitchV2::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 BrickletRemoteSwitchV2::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.

array BrickletRemoteSwitchV2::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 BrickletRemoteSwitchV2::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_v2->registerCallback(BrickletRemoteSwitchV2::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 BrickletRemoteSwitchV2::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().

int BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_A
<?php   void callback(int $house_code, int $receiver_code, int $switch_to, int $repeats [, mixed $user_data])   ?>
Callback Parameters:
  • $house_code – Type: int, Range: [0 to 31]
  • $receiver_code – Type: int, Range: [0 to 31]
  • $switch_to – Type: int, Range: See constants
  • $repeats – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with setRemoteConfiguration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
int BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_B
<?php   void callback(int $address, int $unit, int $switch_to, int $dim_value, int $repeats [, mixed $user_data])   ?>
Callback Parameters:
  • $address – Type: int, Range: [0 to 67108863]
  • $unit – Type: int, Range: [0 to 15, 255]
  • $switch_to – Type: int, Range: See constants
  • $dim_value – Type: int, Range: [0 to 255]
  • $repeats – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with setRemoteConfiguration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
int BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_C
<?php   void callback(string $system_code, int $device_code, int $switch_to, int $repeats [, mixed $user_data])   ?>
Callback Parameters:
  • $system_code – Type: string, Range: ['A' to 'P']
  • $device_code – Type: int, Range: [1 to 16]
  • $switch_to – Type: int, Range: See constants
  • $repeats – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with setRemoteConfiguration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For $switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1

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

  • BrickletRemoteSwitchV2::FUNCTION_SET_REPEATS = 3
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_A = 5
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_B = 6
  • BrickletRemoteSwitchV2::FUNCTION_DIM_SOCKET_B = 7
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_C = 8
  • BrickletRemoteSwitchV2::FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BrickletRemoteSwitchV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRemoteSwitchV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRemoteSwitchV2::FUNCTION_RESET = 243
  • BrickletRemoteSwitchV2::FUNCTION_WRITE_UID = 248
void BrickletRemoteSwitchV2::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:

  • BrickletRemoteSwitchV2::FUNCTION_SET_REPEATS = 3
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_A = 5
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_B = 6
  • BrickletRemoteSwitchV2::FUNCTION_DIM_SOCKET_B = 7
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_C = 8
  • BrickletRemoteSwitchV2::FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BrickletRemoteSwitchV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRemoteSwitchV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRemoteSwitchV2::FUNCTION_RESET = 243
  • BrickletRemoteSwitchV2::FUNCTION_WRITE_UID = 248
void BrickletRemoteSwitchV2::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 BrickletRemoteSwitchV2::DEVICE_IDENTIFIER

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

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