Software / API Bindings / PHP / API Referenz und Beispiele / Bricklets / Remote Switch Bricklet 2.0

PHP - Remote Switch Bricklet 2.0¶

Dies ist die Beschreibung der PHP API Bindings für das Remote Switch Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Remote Switch Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die PHP API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket¶

Download (ExampleSwitchSocket.php)

<?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)

<?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¶

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen¶

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

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$remote_switch_v2 – Typ: BrickletRemoteSwitchV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid:

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletRemoteSwitchV2::getSwitchingState()¶

Rückgabe:	$state – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand des Schaltens zurück. Wenn der aktuell Zustand busy (beschäftigt) ist, sendet das Bricklet gerade einen Code um eine Steckdose zu schalten. Weitere Aufrufe der Switch Socket Funktionen werden ignoriert bis der Zustand auf ready (fertig) wechselt.

Die Länge des Schaltvorgangs ist abhängig von der Anzahl der Wiederholungen, siehe setRepeats().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $state:

BrickletRemoteSwitchV2::SWITCHING_STATE_READY = 0
BrickletRemoteSwitchV2::SWITCHING_STATE_BUSY = 1

void BrickletRemoteSwitchV2::switchSocketA(int $house_code, int $receiver_code, int $switch_to)¶

Parameter:	$house_code – Typ: int, Wertebereich: [0 bis 31] $receiver_code – Typ: int, Wertebereich: [0 bis 31] $switch_to – Typ: int, Wertebereich: Siehe Konstanten

Um eine Typ A Steckdose zu schalten muss der Housecode, Receivercode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Eine detaillierte Beschreibung wie man den House- und Receivercode herausfinden kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $switch_to:

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

void BrickletRemoteSwitchV2::switchSocketB(int $address, int $unit, int $switch_to)¶

Parameter:	$address – Typ: int, Wertebereich: [0 bis 2²⁶ - 1] $unit – Typ: int, Wertebereich: [0 bis 15, 255] $switch_to – Typ: int, Wertebereich: Siehe Konstanten

Um eine Typ B Steckdose zu schalten muss die Adresse und Unit sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Um alle Geräte mit der selben Adresse zu schalten kann die Unit auf 255 gesetzt werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einer Steckdose anlernen kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $switch_to:

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

void BrickletRemoteSwitchV2::dimSocketB(int $address, int $unit, int $dim_value)¶

Parameter:	$address – Typ: int, Wertebereich: [0 bis 2²⁶ - 1] $unit – Typ: int, Wertebereich: [0 bis 15, 255] $dim_value – Typ: int, Wertebereich: [0 bis 255]

Um eine Typ B Dimmer zu steuern muss die Adresse und Unit sowie der Dimmwert auf der Dimmer gesetzt werden soll übergeben werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einem Dimmer anlernen kann gibt es hier.

void BrickletRemoteSwitchV2::switchSocketC(string $system_code, int $device_code, int $switch_to)¶

Parameter:	$system_code – Typ: string, Wertebereich: ['A' bis 'P'] $device_code – Typ: int, Wertebereich: [1 bis 16] $switch_to – Typ: int, Wertebereich: Siehe Konstanten

Um eine Typ C Steckdose zu schalten muss der Systemcode, Gerätecode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Eine detaillierte Beschreibung wie man den System- und Gerätecode herausfinden kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $switch_to:

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

void BrickletRemoteSwitchV2::setRemoteConfiguration(int $remote_type, int $minimum_repeats, bool $callback_enabled)¶

Parameter:	$remote_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 $minimum_repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2 $callback_enabled – Typ: bool, Standardwert: FALSE

Setzt die Konfiguration für das Empfangen von Daten von Fernbedienungen der Typen A, B und C.

Remote Type: A, B oder C abhängig vom Typ der Fernbedienung die empfangen werden soll.
Minimum Repeats: Die Mindestanzahl an wiederholten Datenpaketen bevor der Callback ausgelöst wird (falls aktiviert).
Callback Enabled: Aktiviert/Deaktivert den Callback (siehe CALLBACK_REMOTE_STATUS_A Callback, CALLBACK_REMOTE_STATUS_B Callback und CALLBACK_REMOTE_STATUS_C Callback).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $remote_type:

BrickletRemoteSwitchV2::REMOTE_TYPE_A = 0
BrickletRemoteSwitchV2::REMOTE_TYPE_B = 1
BrickletRemoteSwitchV2::REMOTE_TYPE_C = 2

array BrickletRemoteSwitchV2::getRemoteConfiguration()¶

Rückgabe-Array:	'remote_type' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 'minimum_repeats' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2 'callback_enabled' – Typ: bool, Standardwert: FALSE

Gibt die Konfiguration zurück wie von setRemoteConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $remote_type:

BrickletRemoteSwitchV2::REMOTE_TYPE_A = 0
BrickletRemoteSwitchV2::REMOTE_TYPE_B = 1
BrickletRemoteSwitchV2::REMOTE_TYPE_C = 2

array BrickletRemoteSwitchV2::getRemoteStatusA()¶

Rückgabe-Array:	'house_code' – Typ: int, Wertebereich: [0 bis 31] 'receiver_code' – Typ: int, Wertebereich: [0 bis 31] 'switch_to' – Typ: int, Wertebereich: Siehe Konstanten 'repeats' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit dem angegebenen House/Receivercode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und CALLBACK_REMOTE_STATUS_A Callback.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $switch_to:

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

array BrickletRemoteSwitchV2::getRemoteStatusB()¶

Rückgabe-Array:	'address' – Typ: int, Wertebereich: [0 bis 2²⁶ - 1] 'unit' – Typ: int, Wertebereich: [0 bis 15] 'switch_to' – Typ: int, Wertebereich: Siehe Konstanten 'dim_value' – Typ: int, Wertebereich: [0 bis 255] 'repeats' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Falls die Fernbedienung Dimmen unterstützt, dann wie der Dimmwert anstatt des Schaltzustandes verwendet.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen Address/Unit auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und CALLBACK_REMOTE_STATUS_B Callback.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $switch_to:

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

array BrickletRemoteSwitchV2::getRemoteStatusC()¶

Rückgabe-Array:	'system_code' – Typ: string, Wertebereich: ['A' bis 'P'] 'device_code' – Typ: int, Wertebereich: [1 bis 16] 'switch_to' – Typ: int, Wertebereich: Siehe Konstanten 'repeats' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen System/Gerätecode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe setRemoteConfiguration() und CALLBACK_REMOTE_STATUS_C Callback.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $switch_to:

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

Fortgeschrittene Funktionen¶

void BrickletRemoteSwitchV2::setRepeats(int $repeats)¶

Parameter:	$repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der Switch Socket Funktionen aufgerufen wird. Die Wiederholungen korrespondieren zu der Zeit die eine Taste auf der Fernbedienung gedrückt wird.

Einige Dimmer werden über die Länge des Tastendrucks kontrolliert, dies kann simuliert werden indem man die Anzahl der Wiederholungen inkrementiert.

int BrickletRemoteSwitchV2::getRepeats()¶

Rückgabe:	$repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5

Gibt die Anzahl der Wiederholungen zurück, wie von setRepeats() gesetzt.

array BrickletRemoteSwitchV2::getSPITFPErrorCount()¶

Rückgabe-Array:	'error_count_ack_checksum' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_message_checksum' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_frame' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_overflow' – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

void BrickletRemoteSwitchV2::setStatusLEDConfig(int $config)¶

Parameter:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $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()¶

Rückgabe:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $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()¶

Rückgabe:	$temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletRemoteSwitchV2::reset()¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

array BrickletRemoteSwitchV2::getIdentity()¶

Rückgabe-Array:

Rückgabe-Array:	'uid' – Typ: string, Länge: bis zu 8 'connected_uid' – Typ: string, Länge: bis zu 8 'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z'] 'hardware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'firmware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'device_identifier' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

'uid' – Typ: string, Länge: bis zu 8
'connected_uid' – Typ: string, Länge: bis zu 8
'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z']
'hardware_version' – Typ: array(int, ...), Länge: 3

0: $major – Typ: int, Wertebereich: [0 bis 255]
1: $minor – Typ: int, Wertebereich: [0 bis 255]
2: $revision – Typ: int, Wertebereich: [0 bis 255]

'firmware_version' – Typ: array(int, ...), Länge: 3

0: $major – Typ: int, Wertebereich: [0 bis 255]
1: $minor – Typ: int, Wertebereich: [0 bis 255]
2: $revision – Typ: int, Wertebereich: [0 bis 255]

'device_identifier' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

void BrickletRemoteSwitchV2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)¶

Parameter:	$callback_id – Typ: int $callback – Typ: callable $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$remote_switch_v2->registerCallback(BrickletRemoteSwitchV2::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

int BrickletRemoteSwitchV2::CALLBACK_SWITCHING_DONE¶

<?php   void callback([mixed $user_data])   ?>

Callback-Parameter:	$user_data – Typ: mixed

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe 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-Parameter:	$house_code – Typ: int, Wertebereich: [0 bis 31] $receiver_code – Typ: int, Wertebereich: [0 bis 31] $switch_to – Typ: int, Wertebereich: Siehe Konstanten $repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $user_data – Typ: mixed

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels setRemoteConfiguration(). Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $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-Parameter:	$address – Typ: int, Wertebereich: [0 bis 2²⁶ - 1] $unit – Typ: int, Wertebereich: [0 bis 15, 255] $switch_to – Typ: int, Wertebereich: Siehe Konstanten $dim_value – Typ: int, Wertebereich: [0 bis 255] $repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $user_data – Typ: mixed

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $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-Parameter:	$system_code – Typ: string, Wertebereich: ['A' bis 'P'] $device_code – Typ: int, Wertebereich: [1 bis 16] $switch_to – Typ: int, Wertebereich: Siehe Konstanten $repeats – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $user_data – Typ: mixed

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $switch_to:

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

array BrickletRemoteSwitchV2::getAPIVersion()¶

Rückgabe-Array:	$api_version – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickletRemoteSwitchV2::getResponseExpected(int $function_id)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $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)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten $response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $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)¶

Parameter:	$response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int BrickletRemoteSwitchV2::setBootloaderMode(int $mode)¶

Parameter:	$mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $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

Für $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()¶

Rückgabe:	$mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $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)¶

Parameter:	$pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int BrickletRemoteSwitchV2::writeFirmware(array $data)¶

Parameter:	$data – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	$status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

void BrickletRemoteSwitchV2::writeUID(int $uid)¶

Parameter:	$uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int BrickletRemoteSwitchV2::readUID()¶

Rückgabe:	$uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

int BrickletRemoteSwitchV2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Remote Switch Bricklet 2.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletRemoteSwitchV2::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet 2.0 dar.