Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets (Abgekündigt) / Solid State Relay Bricklet

C/C++ - Solid State Relay Bricklet¶

Dies ist die Beschreibung der C/C++ API Bindings für das Solid State Relay Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Solid State Relay 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).

Simple¶

Download (example_simple.c)

#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_solid_state_relay.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Solid State Relay Bricklet

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

    // Create device object
    SolidStateRelay ssr;
    solid_state_relay_create(&ssr, 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

    // Turn relay on/off 10 times with 1 second delay
    int i;
    for(i = 0; i < 5; ++i) {
        millisleep(1000);
        solid_state_relay_set_state(&ssr, true);
        millisleep(1000);
        solid_state_relay_set_state(&ssr, false);
    }

    printf("Press key to exit\n");
    getchar();
    solid_state_relay_destroy(&ssr);
    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 solid_state_relay_create(SolidStateRelay *solid_state_relay, const char *uid, IPConnection *ipcon)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay * uid – Typ: const char * ipcon – Typ: IPConnection *

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

SolidStateRelay solid_state_relay;
solid_state_relay_create(&solid_state_relay, "YOUR_DEVICE_UID", &ipcon);

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

void solid_state_relay_destroy(SolidStateRelay *solid_state_relay)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay *

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

int solid_state_relay_set_state(SolidStateRelay *solid_state_relay, bool state)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay * state – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Setzt den Zustand des Relais, true bedeutet ein und false aus.

Ein laufender Monoflop Timer wird abgebrochen, wenn diese Funktion aufgerufen wird.

int solid_state_relay_get_state(SolidStateRelay *solid_state_relay, bool *ret_state)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay *
Ausgabeparameter:	ret_state – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt den Zustand der Relais zurück, true bedeutet ein und false aus.

Fortgeschrittene Funktionen¶

int solid_state_relay_set_monoflop(SolidStateRelay *solid_state_relay, bool state, uint32_t time)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay * state – Typ: bool time – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Der erste Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der zweite Parameter stellt die Zeit dar, welche das Relais den Zustand halten soll.

Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Das Relais wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Dual Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Das Relais wird die gesamte Zeit ein sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird das Relais nach spätestens zwei Sekunden ausschalten.

int solid_state_relay_get_monoflop(SolidStateRelay *solid_state_relay, bool *ret_state, uint32_t *ret_time, uint32_t *ret_time_remaining)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay *
Ausgabeparameter:	ret_state – Typ: bool ret_time – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1] ret_time_remaining – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Zustand und die Zeit, wie von solid_state_relay_set_monoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

int solid_state_relay_get_identity(SolidStateRelay *solid_state_relay, 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:	solid_state_relay – Typ: SolidStateRelay *
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 solid_state_relay_register_callback(SolidStateRelay *solid_state_relay, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay * 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 solid_state_relay_register_callback() Funktion durchgeführt werden:

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

solid_state_relay_register_callback(&solid_state_relay,
                                    SOLID_STATE_RELAY_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.

SOLID_STATE_RELAY_CALLBACK_MONOFLOP_DONE¶

void callback(bool state, void *user_data)

Callback-Parameter:	state – Typ: bool user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Der Parameter ist der aktuellen Zustand des Relais (der Zustand nach dem Monoflop).

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 solid_state_relay_get_api_version(SolidStateRelay *solid_state_relay, uint8_t ret_api_version[3])¶

Parameter:	solid_state_relay – Typ: SolidStateRelay *
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 solid_state_relay_get_response_expected(SolidStateRelay *solid_state_relay, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay * 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 solid_state_relay_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:

SOLID_STATE_RELAY_FUNCTION_SET_STATE = 1
SOLID_STATE_RELAY_FUNCTION_SET_MONOFLOP = 3

int solid_state_relay_set_response_expected(SolidStateRelay *solid_state_relay, uint8_t function_id, bool response_expected)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay * 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:

SOLID_STATE_RELAY_FUNCTION_SET_STATE = 1
SOLID_STATE_RELAY_FUNCTION_SET_MONOFLOP = 3

int solid_state_relay_set_response_expected_all(SolidStateRelay *solid_state_relay, bool response_expected)¶

Parameter:	solid_state_relay – Typ: SolidStateRelay * 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.

Konstanten¶

SOLID_STATE_RELAY_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Solid State Relay Bricklet zu identifizieren.

Die solid_state_relay_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.

SOLID_STATE_RELAY_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Solid State Relay Bricklet dar.