C/C++ - Dual Relay Bricklet¶

Simple¶

Download (example_simple.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
39
40
41
42

#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_dual_relay.h"

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

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

    // Create device object
    DualRelay dr;
    dual_relay_create(&dr, 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 relays alternating on/off 10 times with 1 second delay
    int i;
    for(i = 0; i < 5; ++i) {
        millisleep(1000);
        dual_relay_set_state(&dr, true, false);
        millisleep(1000);
        dual_relay_set_state(&dr, false, true);
    }

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

Grundfunktionen¶

void dual_relay_create(DualRelay *dual_relay, const char *uid, IPConnection *ipcon)¶

Parameter:	dual_relay – Typ: DualRelay * uid – Typ: const char * ipcon – Typ: IPConnection *

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

DualRelay dual_relay;
dual_relay_create(&dual_relay, "YOUR_DEVICE_UID", &ipcon);

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

void dual_relay_destroy(DualRelay *dual_relay)¶

Parameter:	dual_relay – Typ: DualRelay *

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

int dual_relay_set_state(DualRelay *dual_relay, bool relay1, bool relay2)¶

Parameter:	dual_relay – Typ: DualRelay * relay1 – Typ: bool, Standardwert: false relay2 – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Setzt den Zustand der Relais, true bedeutet ein und false aus. Beispiel: (true, false) schaltet Relais 1 ein und Relais 2 aus.

Wenn nur eines der Relais gesetzt werden soll und der aktuelle Zustand des anderen Relais nicht bekannt ist, dann kann der Zustand mit dual_relay_get_state() ausgelesen werden oder es kann dual_relay_set_selected_state() genutzt werden.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

int dual_relay_get_state(DualRelay *dual_relay, bool *ret_relay1, bool *ret_relay2)¶

Parameter:	dual_relay – Typ: DualRelay *
Ausgabeparameter:	ret_relay1 – Typ: bool, Standardwert: false ret_relay2 – 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 dual_relay_set_monoflop(DualRelay *dual_relay, uint8_t relay, bool state, uint32_t time)¶

Parameter:	dual_relay – Typ: DualRelay * relay – Typ: uint8_t, Wertebereich: [1 bis 2] state – Typ: bool time – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

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

Wenn diese Funktion mit den Parametern (1, true, 1500) aufgerufen wird: Relais 1 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 dual_relay_get_monoflop(DualRelay *dual_relay, uint8_t relay, bool *ret_state, uint32_t *ret_time, uint32_t *ret_time_remaining)¶

Parameter:	dual_relay – Typ: DualRelay * relay – Typ: uint8_t, Wertebereich: [1 bis 2]
Ausgabeparameter:	ret_state – Typ: bool ret_time – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] ret_time_remaining – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:	e_code – Typ: int

Gibt (für das angegebene Relais) den aktuellen Zustand und die Zeit, wie von dual_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 dual_relay_set_selected_state(DualRelay *dual_relay, uint8_t relay, bool state)¶

Parameter:	dual_relay – Typ: DualRelay * relay – Typ: uint8_t, Wertebereich: [1 bis 2] state – Typ: bool
Rückgabe:	e_code – Typ: int

Setzt den Zustand des ausgewählte Relais (1 oder 2), true bedeutet ein und false aus.

Ein laufender Monoflop Timer für das ausgewählte Relais wird abgebrochen, wenn diese Funktion aufgerufen wird.

Das andere Relais bleibt unangetastet.

int dual_relay_get_identity(DualRelay *dual_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:	dual_relay – Typ: DualRelay *
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 216 - 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 dual_relay_register_callback(DualRelay *dual_relay, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	dual_relay – Typ: DualRelay * 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 dual_relay_register_callback() Funktion durchgeführt werden:

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

dual_relay_register_callback(&dual_relay,
                             DUAL_RELAY_CALLBACK_EXAMPLE,
                             (void (*)(void))my_callback,
                             NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

DUAL_RELAY_CALLBACK_MONOFLOP_DONE¶

void callback(uint8_t relay, bool state, void *user_data)

Callback-Parameter:	relay – Typ: uint8_t, Wertebereich: [1 bis 2] state – Typ: bool user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Die Parameter enthalten das auslösende Relais (1 oder 2) und den 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 dual_relay_get_api_version(DualRelay *dual_relay, uint8_t ret_api_version[3])¶

Parameter:	dual_relay – Typ: DualRelay *
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 dual_relay_get_response_expected(DualRelay *dual_relay, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	dual_relay – Typ: DualRelay * 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 dual_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:

• DUAL_RELAY_FUNCTION_SET_STATE = 1
• DUAL_RELAY_FUNCTION_SET_MONOFLOP = 3
• DUAL_RELAY_FUNCTION_SET_SELECTED_STATE = 6

int dual_relay_set_response_expected(DualRelay *dual_relay, uint8_t function_id, bool response_expected)¶

Parameter:	dual_relay – Typ: DualRelay * 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.

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:

• DUAL_RELAY_FUNCTION_SET_STATE = 1
• DUAL_RELAY_FUNCTION_SET_MONOFLOP = 3
• DUAL_RELAY_FUNCTION_SET_SELECTED_STATE = 6

int dual_relay_set_response_expected_all(DualRelay *dual_relay, bool response_expected)¶

Parameter:	dual_relay – Typ: DualRelay * 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¶

DUAL_RELAY_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Dual Relay Bricklet zu identifizieren.

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

DUAL_RELAY_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Dual Relay Bricklet dar.