C/C++ - Remote Switch Bricklet

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

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket

Download (example_switch_socket.c)

 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_remote_switch.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Remote Switch Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    RemoteSwitch rs;
    remote_switch_create(&rs, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // 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.
    remote_switch_switch_socket_a(&rs, 17, 1, REMOTE_SWITCH_SWITCH_TO_ON);

    printf("Press key to exit\n");
    getchar();
    remote_switch_destroy(&rs);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14
  • E_WRONG_DEVICE_TYPE = -15
  • E_DEVICE_REPLACED = -16
  • E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void remote_switch_create(RemoteSwitch *remote_switch, const char *uid, IPConnection *ipcon)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt remote_switch mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

RemoteSwitch remote_switch;
remote_switch_create(&remote_switch, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void remote_switch_destroy(RemoteSwitch *remote_switch)
Parameter:
  • remote_switch – Typ: RemoteSwitch *

Entfernt das Geräteobjekt remote_switch von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int remote_switch_switch_socket(RemoteSwitch *remote_switch, uint8_t house_code, uint8_t receiver_code, uint8_t switch_to)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • house_code – Typ: uint8_t, Wertebereich: [0 bis 31]
  • receiver_code – Typ: uint8_t, Wertebereich: [0 bis 31]
  • switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Diese Funktion ist veraltet und wurde durch remote_switch_switch_socket_a() ersetzt.

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

Für switch_to:

  • REMOTE_SWITCH_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_SWITCH_TO_ON = 1
int remote_switch_get_switching_state(RemoteSwitch *remote_switch, uint8_t *ret_state)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
Ausgabeparameter:
  • ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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 Schaltanforderungen werden ignoriert bis der Zustand auf ready (fertig) wechselt.

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

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

Für ret_state:

  • REMOTE_SWITCH_SWITCHING_STATE_READY = 0
  • REMOTE_SWITCH_SWITCHING_STATE_BUSY = 1
int remote_switch_switch_socket_a(RemoteSwitch *remote_switch, uint8_t house_code, uint8_t receiver_code, uint8_t switch_to)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • house_code – Typ: uint8_t, Wertebereich: [0 bis 31]
  • receiver_code – Typ: uint8_t, Wertebereich: [0 bis 31]
  • switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • REMOTE_SWITCH_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

int remote_switch_switch_socket_b(RemoteSwitch *remote_switch, uint32_t address, uint8_t unit, uint8_t switch_to)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • address – Typ: uint32_t, Wertebereich: [0 bis 226 - 1]
  • unit – Typ: uint8_t, Wertebereich: [0 bis 15, 255]
  • switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • REMOTE_SWITCH_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

int remote_switch_dim_socket_b(RemoteSwitch *remote_switch, uint32_t address, uint8_t unit, uint8_t dim_value)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • address – Typ: uint32_t, Wertebereich: [0 bis 226 - 1]
  • unit – Typ: uint8_t, Wertebereich: [0 bis 15, 255]
  • dim_value – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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.

Neu in Version 2.0.1 (Plugin).

int remote_switch_switch_socket_c(RemoteSwitch *remote_switch, char system_code, uint8_t device_code, uint8_t switch_to)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • system_code – Typ: char, Wertebereich: ['A' bis 'P']
  • device_code – Typ: uint8_t, Wertebereich: [1 bis 16]
  • switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • REMOTE_SWITCH_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

int remote_switch_set_repeats(RemoteSwitch *remote_switch, uint8_t repeats)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • repeats – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 5
Rückgabe:
  • error_code – Typ: int

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der Schalt-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 remote_switch_get_repeats(RemoteSwitch *remote_switch, uint8_t *ret_repeats)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
Ausgabeparameter:
  • ret_repeats – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 5
Rückgabe:
  • error_code – Typ: int

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

int remote_switch_get_identity(RemoteSwitch *remote_switch, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 remote_switch_register_callback(RemoteSwitch *remote_switch, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die 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 remote_switch_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

remote_switch_register_callback(&remote_switch,
                                REMOTE_SWITCH_CALLBACK_EXAMPLE,
                                (void (*)(void))my_callback,
                                NULL);

Die verfügbaren Konstanten mit den zugehö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.

REMOTE_SWITCH_CALLBACK_SWITCHING_DONE
void callback(void *user_data)
Callback-Parameter:
  • user_data – Typ: void *

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe remote_switch_get_switching_state().

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.

int remote_switch_get_api_version(RemoteSwitch *remote_switch, uint8_t ret_api_version[3])
Parameter:
  • remote_switch – Typ: RemoteSwitch *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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.

int remote_switch_get_response_expected(RemoteSwitch *remote_switch, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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 remote_switch_set_response_expected(). 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:

  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET = 1
  • REMOTE_SWITCH_FUNCTION_SET_REPEATS = 4
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_A = 6
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_B = 7
  • REMOTE_SWITCH_FUNCTION_DIM_SOCKET_B = 8
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_C = 9
int remote_switch_set_response_expected(RemoteSwitch *remote_switch, uint8_t function_id, bool response_expected)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ä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.

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:

  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET = 1
  • REMOTE_SWITCH_FUNCTION_SET_REPEATS = 4
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_A = 6
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_B = 7
  • REMOTE_SWITCH_FUNCTION_DIM_SOCKET_B = 8
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_C = 9
int remote_switch_set_response_expected_all(RemoteSwitch *remote_switch, bool response_expected)
Parameter:
  • remote_switch – Typ: RemoteSwitch *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

Konstanten

REMOTE_SWITCH_DEVICE_IDENTIFIER

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

Die remote_switch_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

REMOTE_SWITCH_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet dar.