C/C++ - RS232 Bricklet

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

Loopback

Download (example_loopback.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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#include <stdio.h>

// For this example connect the RX1 and TX pin to receive the send message

#include "ip_connection.h"
#include "bricklet_rs232.h"

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

// Callback function for read callback
void cb_read(char message[60], uint8_t length, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    // Assume that the message consists of ASCII characters and
    // convert it from an array of chars to a NUL-terminated string
    char buffer[61]; // +1 for the NUL-terminator
    memcpy(buffer, message, length);
    buffer[length] = '\0';

    printf("Message (Length: %d): \"%s\"\n", length, buffer);
}

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

    // Create device object
    RS232 rs232;
    rs232_create(&rs232, 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

    // Register read callback to function cb_read
    rs232_register_callback(&rs232,
                            RS232_CALLBACK_READ,
                            (void (*)(void))cb_read,
                            NULL);

    // Enable read callback
    rs232_enable_read_callback(&rs232);

    // Write "test" string
    char buffer[60] = "test";
    uint8_t written;
    rs232_write(&rs232, buffer, 4, &written);

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void rs232_create(RS232 *rs232, const char *uid, IPConnection *ipcon)
Parameter:
  • rs232 – Typ: RS232 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

RS232 rs232;
rs232_create(&rs232, "YOUR_DEVICE_UID", &ipcon);

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

void rs232_destroy(RS232 *rs232)
Parameter:
  • rs232 – Typ: RS232 *

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

int rs232_write(RS232 *rs232, char message[60], uint8_t length, uint8_t *ret_written)
Parameter:
  • rs232 – Typ: RS232 *
  • message – Typ: char[60]
  • length – Typ: uint8_t, Wertebereich: [0 bis 60]
Ausgabeparameter:
  • ret_written – Typ: uint8_t, Wertebereich: [0 bis 60]
Rückgabe:
  • error_code – Typ: int

Schreibt einen String aus bis zu 60 Zeichen auf die RS232-Schnittstelle. Der String kann aus Binärdaten bestehen, ASCII o.ä. ist nicht notwendig.

Die Länge des Strings muss als ein zusätzlicher Parameter angegeben werden.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben werden konnten.

Siehe rs232_set_configuration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

int rs232_read(RS232 *rs232, char ret_message[60], uint8_t *ret_length)
Parameter:
  • rs232 – Typ: RS232 *
Ausgabeparameter:
  • ret_message – Typ: char[60]
  • ret_length – Typ: uint8_t, Wertebereich: [0 bis 60]
Rückgabe:
  • error_code – Typ: int

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die Länge als 0 gegeben wird, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe rs232_enable_read_callback() und RS232_CALLBACK_READ Callback.

int rs232_set_configuration(RS232 *rs232, uint8_t baudrate, uint8_t parity, uint8_t stopbits, uint8_t wordlength, uint8_t hardware_flowcontrol, uint8_t software_flowcontrol)
Parameter:
  • rs232 – Typ: RS232 *
  • baudrate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 11
  • parity – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stopbits – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
  • wordlength – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 8
  • hardware_flowcontrol – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
  • software_flowcontrol – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Konfiguration für die RS232-Kommunikation.

Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

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

Für baudrate:

  • RS232_BAUDRATE_300 = 0
  • RS232_BAUDRATE_600 = 1
  • RS232_BAUDRATE_1200 = 2
  • RS232_BAUDRATE_2400 = 3
  • RS232_BAUDRATE_4800 = 4
  • RS232_BAUDRATE_9600 = 5
  • RS232_BAUDRATE_14400 = 6
  • RS232_BAUDRATE_19200 = 7
  • RS232_BAUDRATE_28800 = 8
  • RS232_BAUDRATE_38400 = 9
  • RS232_BAUDRATE_57600 = 10
  • RS232_BAUDRATE_115200 = 11
  • RS232_BAUDRATE_230400 = 12

Für parity:

  • RS232_PARITY_NONE = 0
  • RS232_PARITY_ODD = 1
  • RS232_PARITY_EVEN = 2
  • RS232_PARITY_FORCED_PARITY_1 = 3
  • RS232_PARITY_FORCED_PARITY_0 = 4

Für stopbits:

  • RS232_STOPBITS_1 = 1
  • RS232_STOPBITS_2 = 2

Für wordlength:

  • RS232_WORDLENGTH_5 = 5
  • RS232_WORDLENGTH_6 = 6
  • RS232_WORDLENGTH_7 = 7
  • RS232_WORDLENGTH_8 = 8

Für hardware_flowcontrol:

  • RS232_HARDWARE_FLOWCONTROL_OFF = 0
  • RS232_HARDWARE_FLOWCONTROL_ON = 1

Für software_flowcontrol:

  • RS232_SOFTWARE_FLOWCONTROL_OFF = 0
  • RS232_SOFTWARE_FLOWCONTROL_ON = 1
int rs232_get_configuration(RS232 *rs232, uint8_t *ret_baudrate, uint8_t *ret_parity, uint8_t *ret_stopbits, uint8_t *ret_wordlength, uint8_t *ret_hardware_flowcontrol, uint8_t *ret_software_flowcontrol)
Parameter:
  • rs232 – Typ: RS232 *
Ausgabeparameter:
  • ret_baudrate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 11
  • ret_parity – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
  • ret_stopbits – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
  • ret_wordlength – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 8
  • ret_hardware_flowcontrol – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
  • ret_software_flowcontrol – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_baudrate:

  • RS232_BAUDRATE_300 = 0
  • RS232_BAUDRATE_600 = 1
  • RS232_BAUDRATE_1200 = 2
  • RS232_BAUDRATE_2400 = 3
  • RS232_BAUDRATE_4800 = 4
  • RS232_BAUDRATE_9600 = 5
  • RS232_BAUDRATE_14400 = 6
  • RS232_BAUDRATE_19200 = 7
  • RS232_BAUDRATE_28800 = 8
  • RS232_BAUDRATE_38400 = 9
  • RS232_BAUDRATE_57600 = 10
  • RS232_BAUDRATE_115200 = 11
  • RS232_BAUDRATE_230400 = 12

Für ret_parity:

  • RS232_PARITY_NONE = 0
  • RS232_PARITY_ODD = 1
  • RS232_PARITY_EVEN = 2
  • RS232_PARITY_FORCED_PARITY_1 = 3
  • RS232_PARITY_FORCED_PARITY_0 = 4

Für ret_stopbits:

  • RS232_STOPBITS_1 = 1
  • RS232_STOPBITS_2 = 2

Für ret_wordlength:

  • RS232_WORDLENGTH_5 = 5
  • RS232_WORDLENGTH_6 = 6
  • RS232_WORDLENGTH_7 = 7
  • RS232_WORDLENGTH_8 = 8

Für ret_hardware_flowcontrol:

  • RS232_HARDWARE_FLOWCONTROL_OFF = 0
  • RS232_HARDWARE_FLOWCONTROL_ON = 1

Für ret_software_flowcontrol:

  • RS232_SOFTWARE_FLOWCONTROL_OFF = 0
  • RS232_SOFTWARE_FLOWCONTROL_ON = 1
int rs232_set_break_condition(RS232 *rs232, uint16_t break_time)
Parameter:
  • rs232 – Typ: RS232 *
  • break_time – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt eine Break Condition (die TX-Ausgabe wird fest of logisch 0 gezwungen). Der Parameter setzt die Haltezeit der Break Condition.

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

int rs232_get_identity(RS232 *rs232, 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:
  • rs232 – Typ: RS232 *
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 rs232_register_callback(RS232 *rs232, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • rs232 – Typ: RS232 *
  • 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.

int rs232_enable_read_callback(RS232 *rs232)
Parameter:
  • rs232 – Typ: RS232 *
Rückgabe:
  • error_code – Typ: int

Aktiviert den RS232_CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

int rs232_disable_read_callback(RS232 *rs232)
Parameter:
  • rs232 – Typ: RS232 *
Rückgabe:
  • error_code – Typ: int

Deaktiviert den RS232_CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

int rs232_is_read_callback_enabled(RS232 *rs232, bool *ret_enabled)
Parameter:
  • rs232 – Typ: RS232 *
Ausgabeparameter:
  • ret_enabled – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt true zurück falls RS232_CALLBACK_READ Callback aktiviert ist, false sonst.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der rs232_register_callback() Funktion durchgeführt werden:

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

rs232_register_callback(&rs232,
                        RS232_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.

RS232_CALLBACK_READ
void callback(char message[60], uint8_t length, void *user_data)
Callback-Parameter:
  • message – Typ: char[60]
  • length – Typ: uint8_t, Wertebereich: [1 bis 60]
  • user_data – Typ: void *

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen. Die Nachricht hat eine Maximalgröße von 60 Zeichen. Die Länge der Nachricht wird zusätzlich übergeben.

Dieser Callback kann durch rs232_enable_read_callback() aktiviert werden.

RS232_CALLBACK_ERROR
void callback(uint8_t error, void *user_data)
Callback-Parameter:
  • error – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • user_data – Typ: void *

Dieser Callback wird aufgerufen wenn ein Fehler auftritt. Mögliche Fehler sind Overrun-, Parity- oder Framing-Fehler.

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

Für error:

  • RS232_ERROR_OVERRUN = 1
  • RS232_ERROR_PARITY = 2
  • RS232_ERROR_FRAMING = 4

Neu in Version 2.0.1 (Plugin).

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 rs232_get_api_version(RS232 *rs232, uint8_t ret_api_version[3])
Parameter:
  • rs232 – Typ: RS232 *
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 rs232_get_response_expected(RS232 *rs232, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • rs232 – Typ: RS232 *
  • 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 rs232_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:

  • RS232_FUNCTION_ENABLE_READ_CALLBACK = 3
  • RS232_FUNCTION_DISABLE_READ_CALLBACK = 4
  • RS232_FUNCTION_SET_CONFIGURATION = 6
  • RS232_FUNCTION_SET_BREAK_CONDITION = 10
int rs232_set_response_expected(RS232 *rs232, uint8_t function_id, bool response_expected)
Parameter:
  • rs232 – Typ: RS232 *
  • 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:

  • RS232_FUNCTION_ENABLE_READ_CALLBACK = 3
  • RS232_FUNCTION_DISABLE_READ_CALLBACK = 4
  • RS232_FUNCTION_SET_CONFIGURATION = 6
  • RS232_FUNCTION_SET_BREAK_CONDITION = 10
int rs232_set_response_expected_all(RS232 *rs232, bool response_expected)
Parameter:
  • rs232 – Typ: RS232 *
  • 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

RS232_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS232 Bricklet zu identifizieren.

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

RS232_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.