C/C++ - Industrial Dual Relay Bricklet

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

 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_industrial_dual_relay.h"

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

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

    // Create device object
    IndustrialDualRelay idr;
    industrial_dual_relay_create(&idr, 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);
        industrial_dual_relay_set_value(&idr, true, false);
        millisleep(1000);
        industrial_dual_relay_set_value(&idr, false, true);
    }

    printf("Press key to exit\n");
    getchar();
    industrial_dual_relay_destroy(&idr);
    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 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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void industrial_dual_relay_create(IndustrialDualRelay *industrial_dual_relay, const char *uid, IPConnection *ipcon)

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

IndustrialDualRelay industrial_dual_relay;
industrial_dual_relay_create(&industrial_dual_relay, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void industrial_dual_relay_destroy(IndustrialDualRelay *industrial_dual_relay)

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

int industrial_dual_relay_set_value(IndustrialDualRelay *industrial_dual_relay, bool channel0, bool channel1)

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

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

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

Der Standardwert ist (false, false).

int industrial_dual_relay_get_value(IndustrialDualRelay *industrial_dual_relay, bool *ret_channel0, bool *ret_channel1)

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

Fortgeschrittene Funktionen

int industrial_dual_relay_set_monoflop(IndustrialDualRelay *industrial_dual_relay, uint8_t channel, bool value, uint32_t time)

Der erste Parameter kann 0 oder 1 sein (Relais 0 oder Relais 1). Der zweite Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der dritte Parameter stellt die Zeit (in ms) 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 Industrial 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 industrial_dual_relay_get_monoflop(IndustrialDualRelay *industrial_dual_relay, uint8_t channel, bool *ret_value, uint32_t *ret_time, uint32_t *ret_time_remaining)

Gibt (für das angegebene Relais) den aktuellen Zustand und die Zeit, wie von industrial_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 industrial_dual_relay_set_selected_value(IndustrialDualRelay *industrial_dual_relay, uint8_t channel, bool value)

Setzt den Zustand des ausgewählten Relais (0 oder 1), 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 unverändert.

int industrial_dual_relay_get_api_version(IndustrialDualRelay *industrial_dual_relay, uint8_t ret_api_version[3])

Gibt die Version der API Definition (Major, Minor, Revision) 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 industrial_dual_relay_get_response_expected(IndustrialDualRelay *industrial_dual_relay, uint8_t function_id, bool *ret_response_expected)

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 industrial_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:

  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_VALUE = 1
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_MONOFLOP = 3
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_SELECTED_VALUE = 6
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_RESET = 243
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_WRITE_UID = 248
int industrial_dual_relay_set_response_expected(IndustrialDualRelay *industrial_dual_relay, uint8_t function_id, bool response_expected)

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

  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_VALUE = 1
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_MONOFLOP = 3
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_SELECTED_VALUE = 6
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_RESET = 243
  • INDUSTRIAL_DUAL_RELAY_FUNCTION_WRITE_UID = 248
int industrial_dual_relay_set_response_expected_all(IndustrialDualRelay *industrial_dual_relay, bool response_expected)

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

int industrial_dual_relay_get_spitfp_error_count(IndustrialDualRelay *industrial_dual_relay, 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)

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 industrial_dual_relay_set_bootloader_mode(IndustrialDualRelay *industrial_dual_relay, uint8_t mode, uint8_t *ret_status)

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 Bootlodaer- 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:

  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_STATUS_OK = 0
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_STATUS_INVALID_MODE = 1
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_STATUS_NO_CHANGE = 2
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int industrial_dual_relay_get_bootloader_mode(IndustrialDualRelay *industrial_dual_relay, uint8_t *ret_mode)

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

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

  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_DUAL_RELAY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int industrial_dual_relay_set_write_firmware_pointer(IndustrialDualRelay *industrial_dual_relay, uint32_t pointer)

Setzt den Firmware-Pointer für industrial_dual_relay_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 industrial_dual_relay_write_firmware(IndustrialDualRelay *industrial_dual_relay, uint8_t data[64], uint8_t *ret_status)

Schreibt 64 Bytes Firmware an die Position die vorher von industrial_dual_relay_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 industrial_dual_relay_set_status_led_config(IndustrialDualRelay *industrial_dual_relay, uint8_t config)

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:

  • INDUSTRIAL_DUAL_RELAY_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DUAL_RELAY_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_DUAL_RELAY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DUAL_RELAY_STATUS_LED_CONFIG_SHOW_STATUS = 3
int industrial_dual_relay_get_status_led_config(IndustrialDualRelay *industrial_dual_relay, uint8_t *ret_config)

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

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

  • INDUSTRIAL_DUAL_RELAY_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DUAL_RELAY_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_DUAL_RELAY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DUAL_RELAY_STATUS_LED_CONFIG_SHOW_STATUS = 3
int industrial_dual_relay_get_chip_temperature(IndustrialDualRelay *industrial_dual_relay, int16_t *ret_temperature)

Gibt die Temperatur in °C, 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 industrial_dual_relay_reset(IndustrialDualRelay *industrial_dual_relay)

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 industrial_dual_relay_write_uid(IndustrialDualRelay *industrial_dual_relay, uint32_t uid)

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 industrial_dual_relay_read_uid(IndustrialDualRelay *industrial_dual_relay, uint32_t *ret_uid)

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

int industrial_dual_relay_get_identity(IndustrialDualRelay *industrial_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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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 industrial_dual_relay_register_callback(IndustrialDualRelay *industrial_dual_relay, int16_t callback_id, void (*function)(void), void *user_data)

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 Funktion industrial_dual_relay_register_callback() durchgeführt werden. Die Parameter bestehen aus dem Geräteobjekt, der Callback ID, der Callback Funktion und optionalen Benutzer Daten:

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

industrial_dual_relay_register_callback(&industrial_dual_relay, INDUSTRIAL_DUAL_RELAY_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

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

INDUSTRIAL_DUAL_RELAY_CALLBACK_MONOFLOP_DONE
void callback(uint8_t channel, bool value, void *user_data)

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Die Parameter enthalten das auslösende Relais (0 oder 1) und den aktuellen Zustand des Relais (der Zustand nach dem Monoflop).

Konstanten

INDUSTRIAL_DUAL_RELAY_DEVICE_IDENTIFIER

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

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

INDUSTRIAL_DUAL_RELAY_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Dual Relay Bricklet dar.