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

C/C++ - Remote Switch Bricklet 2.0¶

Dies ist die Beschreibung der C/C++ 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 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)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_remote_switch_v2.h"

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

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

    // Create device object
    RemoteSwitchV2 rs;
    remote_switch_v2_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_v2_switch_socket_a(&rs, 17, 1, REMOTE_SWITCH_V2_SWITCH_TO_ON);

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

Remote Callback¶

Download (example_remote_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_remote_switch_v2.h"

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

// Callback function for remote status a callback
void cb_remote_status_a(uint8_t house_code, uint8_t receiver_code, uint8_t switch_to,
                        uint16_t repeats, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("House Code: %u\n", house_code);
    printf("Receiver Code: %u\n", receiver_code);

    if(switch_to == REMOTE_SWITCH_V2_SWITCH_TO_OFF) {
        printf("Switch To: Off\n");
    } else if(switch_to == REMOTE_SWITCH_V2_SWITCH_TO_ON) {
        printf("Switch To: On\n");
    }

    printf("Repeats: %u\n", repeats);
    printf("\n");
}

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

    // Create device object
    RemoteSwitchV2 rs;
    remote_switch_v2_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

    // Configure to receive from remote type A with minimum repeats set to 1 and enable callback
    remote_switch_v2_set_remote_configuration(&rs, REMOTE_SWITCH_V2_REMOTE_TYPE_A, 1,
                                              true);

    // Register remote status a callback to function cb_remote_status_a
    remote_switch_v2_register_callback(&rs,
                                       REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_A,
                                       (void (*)(void))cb_remote_status_a,
                                       NULL);

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

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. 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 (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_v2_create(RemoteSwitchV2 *remote_switch_v2, const char *uid, IPConnection *ipcon)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

RemoteSwitchV2 remote_switch_v2;
remote_switch_v2_create(&remote_switch_v2, "YOUR_DEVICE_UID", &ipcon);

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

void remote_switch_v2_destroy(RemoteSwitchV2 *remote_switch_v2)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *

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

int remote_switch_v2_get_switching_state(RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_state)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_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 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 remote_switch_v2_set_repeats().

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

Für ret_state:

REMOTE_SWITCH_V2_SWITCHING_STATE_READY = 0
REMOTE_SWITCH_V2_SWITCHING_STATE_BUSY = 1

int remote_switch_v2_switch_socket_a(RemoteSwitchV2 *remote_switch_v2, uint8_t house_code, uint8_t receiver_code, uint8_t switch_to)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * 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:	e_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_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int remote_switch_v2_switch_socket_b(RemoteSwitchV2 *remote_switch_v2, uint32_t address, uint8_t unit, uint8_t switch_to)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * address – Typ: uint32_t, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: uint8_t, Wertebereich: [0 bis 15, 255] switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_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_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int remote_switch_v2_dim_socket_b(RemoteSwitchV2 *remote_switch_v2, uint32_t address, uint8_t unit, uint8_t dim_value)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * address – Typ: uint32_t, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: uint8_t, Wertebereich: [0 bis 15, 255] dim_value – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_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.

int remote_switch_v2_switch_socket_c(RemoteSwitchV2 *remote_switch_v2, char system_code, uint8_t device_code, uint8_t switch_to)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * 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:	e_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_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int remote_switch_v2_set_remote_configuration(RemoteSwitchV2 *remote_switch_v2, uint8_t remote_type, uint16_t minimum_repeats, bool callback_enabled)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * remote_type – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 minimum_repeats – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2 callback_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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 REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_A Callback, REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_B Callback und REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_C Callback).

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

Für remote_type:

REMOTE_SWITCH_V2_REMOTE_TYPE_A = 0
REMOTE_SWITCH_V2_REMOTE_TYPE_B = 1
REMOTE_SWITCH_V2_REMOTE_TYPE_C = 2

int remote_switch_v2_get_remote_configuration(RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_remote_type, uint16_t *ret_minimum_repeats, bool *ret_callback_enabled)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_remote_type – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_minimum_repeats – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2 ret_callback_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

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

Für ret_remote_type:

REMOTE_SWITCH_V2_REMOTE_TYPE_A = 0
REMOTE_SWITCH_V2_REMOTE_TYPE_B = 1
REMOTE_SWITCH_V2_REMOTE_TYPE_C = 2

int remote_switch_v2_get_remote_status_a(RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_house_code, uint8_t *ret_receiver_code, uint8_t *ret_switch_to, uint16_t *ret_repeats)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_house_code – Typ: uint8_t, Wertebereich: [0 bis 31] ret_receiver_code – Typ: uint8_t, Wertebereich: [0 bis 31] ret_switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_repeats – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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 remote_switch_v2_set_remote_configuration() und REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_A Callback.

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

Für ret_switch_to:

REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int remote_switch_v2_get_remote_status_b(RemoteSwitchV2 *remote_switch_v2, uint32_t *ret_address, uint8_t *ret_unit, uint8_t *ret_switch_to, uint8_t *ret_dim_value, uint16_t *ret_repeats)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_address – Typ: uint32_t, Wertebereich: [0 bis 2²⁶ - 1] ret_unit – Typ: uint8_t, Wertebereich: [0 bis 15] ret_switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_dim_value – Typ: uint8_t, Wertebereich: [0 bis 255] ret_repeats – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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 remote_switch_v2_set_remote_configuration() und REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_B Callback.

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

Für ret_switch_to:

REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int remote_switch_v2_get_remote_status_c(RemoteSwitchV2 *remote_switch_v2, char *ret_system_code, uint8_t *ret_device_code, uint8_t *ret_switch_to, uint16_t *ret_repeats)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_system_code – Typ: char, Wertebereich: ['A' bis 'P'] ret_device_code – Typ: uint8_t, Wertebereich: [1 bis 16] ret_switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_repeats – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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 remote_switch_v2_set_remote_configuration() und REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_C Callback.

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

Für ret_switch_to:

REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

Fortgeschrittene Funktionen¶

int remote_switch_v2_set_repeats(RemoteSwitchV2 *remote_switch_v2, uint8_t repeats)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * repeats – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 5
Rückgabe:	e_code – Typ: int

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 remote_switch_v2_get_repeats(RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_repeats)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_repeats – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 5
Rückgabe:	e_code – Typ: int

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

int remote_switch_v2_get_spitfp_error_count(RemoteSwitchV2 *remote_switch_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int remote_switch_v2_set_status_led_config(RemoteSwitchV2 *remote_switch_v2, uint8_t config)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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:

REMOTE_SWITCH_V2_STATUS_LED_CONFIG_OFF = 0
REMOTE_SWITCH_V2_STATUS_LED_CONFIG_ON = 1
REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int remote_switch_v2_get_status_led_config(RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_config)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

REMOTE_SWITCH_V2_STATUS_LED_CONFIG_OFF = 0
REMOTE_SWITCH_V2_STATUS_LED_CONFIG_ON = 1
REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int remote_switch_v2_get_chip_temperature(RemoteSwitchV2 *remote_switch_v2, int16_t *ret_temperature)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int remote_switch_v2_reset(RemoteSwitchV2 *remote_switch_v2)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Rückgabe:	e_code – Typ: int

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.

int remote_switch_v2_get_identity(RemoteSwitchV2 *remote_switch_v2, 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_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 1]
Rückgabe:	e_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 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 remote_switch_v2_register_callback(RemoteSwitchV2 *remote_switch_v2, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * 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_v2_register_callback() Funktion durchgeführt werden:

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

remote_switch_v2_register_callback(&remote_switch_v2,
                                   REMOTE_SWITCH_V2_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_V2_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_v2_get_switching_state().

REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_A¶

void callback(uint8_t house_code, uint8_t receiver_code, uint8_t switch_to, uint16_t repeats, void *user_data)

Callback-Parameter:	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 repeats – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

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

REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_B¶

void callback(uint32_t address, uint8_t unit, uint8_t switch_to, uint8_t dim_value, uint16_t repeats, void *user_data)

Callback-Parameter:	address – Typ: uint32_t, Wertebereich: [0 bis 2²⁶ - 1] unit – Typ: uint8_t, Wertebereich: [0 bis 15, 255] switch_to – Typ: uint8_t, Wertebereich: Siehe Konstanten dim_value – Typ: uint8_t, Wertebereich: [0 bis 255] repeats – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

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:

REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

REMOTE_SWITCH_V2_CALLBACK_REMOTE_STATUS_C¶

void callback(char system_code, uint8_t device_code, uint8_t switch_to, uint16_t repeats, void *user_data)

Callback-Parameter:	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 repeats – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

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:

REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
REMOTE_SWITCH_V2_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.

int remote_switch_v2_get_api_version(RemoteSwitchV2 *remote_switch_v2, uint8_t ret_api_version[3])¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
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:	e_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_v2_get_response_expected(RemoteSwitchV2 *remote_switch_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_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_v2_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_V2_FUNCTION_SET_REPEATS = 3
REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_A = 5
REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_B = 6
REMOTE_SWITCH_V2_FUNCTION_DIM_SOCKET_B = 7
REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_C = 8
REMOTE_SWITCH_V2_FUNCTION_SET_REMOTE_CONFIGURATION = 9
REMOTE_SWITCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
REMOTE_SWITCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
REMOTE_SWITCH_V2_FUNCTION_RESET = 243
REMOTE_SWITCH_V2_FUNCTION_WRITE_UID = 248

int remote_switch_v2_set_response_expected(RemoteSwitchV2 *remote_switch_v2, uint8_t function_id, bool response_expected)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_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.

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

Für function_id:

REMOTE_SWITCH_V2_FUNCTION_SET_REPEATS = 3
REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_A = 5
REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_B = 6
REMOTE_SWITCH_V2_FUNCTION_DIM_SOCKET_B = 7
REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_C = 8
REMOTE_SWITCH_V2_FUNCTION_SET_REMOTE_CONFIGURATION = 9
REMOTE_SWITCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
REMOTE_SWITCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
REMOTE_SWITCH_V2_FUNCTION_RESET = 243
REMOTE_SWITCH_V2_FUNCTION_WRITE_UID = 248

int remote_switch_v2_set_response_expected_all(RemoteSwitchV2 *remote_switch_v2, bool response_expected)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ä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 remote_switch_v2_set_bootloader_mode(RemoteSwitchV2 *remote_switch_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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:

REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

REMOTE_SWITCH_V2_BOOTLOADER_STATUS_OK = 0
REMOTE_SWITCH_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
REMOTE_SWITCH_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
REMOTE_SWITCH_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
REMOTE_SWITCH_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
REMOTE_SWITCH_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int remote_switch_v2_get_bootloader_mode(RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_mode)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int remote_switch_v2_set_write_firmware_pointer(RemoteSwitchV2 *remote_switch_v2, uint32_t pointer)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für remote_switch_v2_write_firmware(). 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 remote_switch_v2_write_firmware(RemoteSwitchV2 *remote_switch_v2, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von remote_switch_v2_set_write_firmware_pointer() 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.

int remote_switch_v2_write_uid(RemoteSwitchV2 *remote_switch_v2, uint32_t uid)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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 remote_switch_v2_read_uid(RemoteSwitchV2 *remote_switch_v2, uint32_t *ret_uid)¶

Parameter:	remote_switch_v2 – Typ: RemoteSwitchV2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Konstanten¶

REMOTE_SWITCH_V2_DEVICE_IDENTIFIER¶

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

Die remote_switch_v2_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_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet 2.0 dar.