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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void rs232_create(RS232 *rs232, const char *uid, IPConnection *ipcon)

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)

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)

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)

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)

Setzt die Konfiguration für die RS232-Kommunikation. Verfügbare Optionen sind:

  • Baudrate zwischen 300 und 230400 Baud.
  • Parität von None, Odd, Even und Forced Parity.
  • Stop Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8, Hard-/Software Flow Control aus.

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

  • 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
  • RS232_PARITY_NONE = 0
  • RS232_PARITY_ODD = 1
  • RS232_PARITY_EVEN = 2
  • RS232_PARITY_FORCED_PARITY_1 = 3
  • RS232_PARITY_FORCED_PARITY_0 = 4
  • RS232_STOPBITS_1 = 1
  • RS232_STOPBITS_2 = 2
  • RS232_WORDLENGTH_5 = 5
  • RS232_WORDLENGTH_6 = 6
  • RS232_WORDLENGTH_7 = 7
  • RS232_WORDLENGTH_8 = 8
  • RS232_HARDWARE_FLOWCONTROL_OFF = 0
  • RS232_HARDWARE_FLOWCONTROL_ON = 1
  • 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)

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

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

  • 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
  • RS232_PARITY_NONE = 0
  • RS232_PARITY_ODD = 1
  • RS232_PARITY_EVEN = 2
  • RS232_PARITY_FORCED_PARITY_1 = 3
  • RS232_PARITY_FORCED_PARITY_0 = 4
  • RS232_STOPBITS_1 = 1
  • RS232_STOPBITS_2 = 2
  • RS232_WORDLENGTH_5 = 5
  • RS232_WORDLENGTH_6 = 6
  • RS232_WORDLENGTH_7 = 7
  • RS232_WORDLENGTH_8 = 8
  • RS232_HARDWARE_FLOWCONTROL_OFF = 0
  • RS232_HARDWARE_FLOWCONTROL_ON = 1
  • RS232_SOFTWARE_FLOWCONTROL_OFF = 0
  • RS232_SOFTWARE_FLOWCONTROL_ON = 1
int rs232_set_break_condition(RS232 *rs232, uint16_t break_time)

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

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

int rs232_get_api_version(RS232 *rs232, 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 rs232_get_response_expected(RS232 *rs232, 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 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.

Siehe rs232_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int rs232_set_response_expected(RS232 *rs232, 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 Funktions ID Defines sind für diese Funktion verfügbar:

  • 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)

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

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)

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 rs232_register_callback(RS232 *rs232, 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.

int rs232_enable_read_callback(RS232 *rs232)

Aktiviert den RS232_CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

int rs232_disable_read_callback(RS232 *rs232)

Deaktiviert den RS232_CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert

int rs232_is_read_callback_enabled(RS232 *rs232, bool *ret_enabled)

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 Funktion rs232_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);
}

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

RS232_CALLBACK_READ
void callback(char message[60], uint8_t length, void *user_data)

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)

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

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

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

Neu in Version 2.0.1 (Plugin).

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.