Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / RS232 Bricklet 2.0

C/C++ für Mikrocontroller - RS232 Bricklet 2.0¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das RS232 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback¶

Download (example_loopback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_rs232_v2.h"

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

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static char buffer[5] = {0}; // +1 for the null terminator

// Callback function for read callback
static void read_handler(TF_RS232V2 *device, char *message, uint16_t message_length,
                         void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    message[message_length] = '\0';

    tf_hal_printf("Message: \"%s\"\n", message);
}

static TF_RS232V2 rs232;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_rs232_v2_create(&rs232, NULL, hal), "create device object");

    // Register read callback to function read_handler
    tf_rs232_v2_register_read_callback(&rs232,
                                       read_handler,
                                       buffer,
                                       NULL);

    // Enable read callback
    check(tf_rs232_v2_enable_read_callback(&rs232), "call enable_read_callback");

    // Write "test" string
    char message[4] = {'t', 'e', 's', 't'};
    uint16_t written;
    check(tf_rs232_v2_write(&rs232, message, 4, &written), "call write");
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_rs232_v2_create(TF_RS232V2 *rs232_v2, const char *uid, TF_HAL *hal)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt rs232_v2 mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_RS232V2 rs232_v2;
tf_rs232_v2_create(&rs232_v2, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_rs232_v2_destroy(TF_RS232V2 *rs232_v2)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Rückgabe:	e_code – Typ: int

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

int tf_rs232_v2_write(TF_RS232V2 *rs232_v2, const char *message, uint16_t message_length, uint16_t *ret_message_written)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * message – Typ: const char * message_length – Typ: uint16_t
Ausgabeparameter:	ret_message_written – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Schreibt Zeichen auf die RS232-Schnittstelle. Die Zeichen können Binärdaten sein, ASCII o.ä. ist nicht notwendig.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben wurden.

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

int tf_rs232_v2_read(TF_RS232V2 *rs232_v2, uint16_t length, char *ret_message, uint16_t *ret_message_length)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * length – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_message – Typ: char * ret_message_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn der Read-Callback nicht aktiv ist. Siehe tf_rs232_v2_enable_read_callback() und Read Low Level Callback.

int tf_rs232_v2_set_configuration(TF_RS232V2 *rs232_v2, uint32_t baudrate, uint8_t parity, uint8_t stopbits, uint8_t wordlength, uint8_t flowcontrol)¶

Parameter:

Parameter:	rs232_v2 – Typ: TF_RS232V2 * baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 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 flowcontrol – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

rs232_v2 – Typ: TF_RS232V2 *
baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200
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
flowcontrol – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0

Rückgabe:

e_code – Typ: int

Setzt die Konfiguration für die RS232-Kommunikation.

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

Für parity:

TF_RS232_V2_PARITY_NONE = 0
TF_RS232_V2_PARITY_ODD = 1
TF_RS232_V2_PARITY_EVEN = 2

Für stopbits:

TF_RS232_V2_STOPBITS_1 = 1
TF_RS232_V2_STOPBITS_2 = 2

Für wordlength:

TF_RS232_V2_WORDLENGTH_5 = 5
TF_RS232_V2_WORDLENGTH_6 = 6
TF_RS232_V2_WORDLENGTH_7 = 7
TF_RS232_V2_WORDLENGTH_8 = 8

Für flowcontrol:

TF_RS232_V2_FLOWCONTROL_OFF = 0
TF_RS232_V2_FLOWCONTROL_SOFTWARE = 1
TF_RS232_V2_FLOWCONTROL_HARDWARE = 2

int tf_rs232_v2_get_configuration(TF_RS232V2 *rs232_v2, uint32_t *ret_baudrate, uint8_t *ret_parity, uint8_t *ret_stopbits, uint8_t *ret_wordlength, uint8_t *ret_flowcontrol)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 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_flowcontrol – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_parity:

TF_RS232_V2_PARITY_NONE = 0
TF_RS232_V2_PARITY_ODD = 1
TF_RS232_V2_PARITY_EVEN = 2

Für ret_stopbits:

TF_RS232_V2_STOPBITS_1 = 1
TF_RS232_V2_STOPBITS_2 = 2

Für ret_wordlength:

TF_RS232_V2_WORDLENGTH_5 = 5
TF_RS232_V2_WORDLENGTH_6 = 6
TF_RS232_V2_WORDLENGTH_7 = 7
TF_RS232_V2_WORDLENGTH_8 = 8

Für ret_flowcontrol:

TF_RS232_V2_FLOWCONTROL_OFF = 0
TF_RS232_V2_FLOWCONTROL_SOFTWARE = 1
TF_RS232_V2_FLOWCONTROL_HARDWARE = 2

Fortgeschrittene Funktionen¶

int tf_rs232_v2_set_buffer_config(TF_RS232V2 *rs232_v2, uint16_t send_buffer_size, uint16_t receive_buffer_size)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * send_buffer_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receive_buffer_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120
Rückgabe:	e_code – Typ: int

Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10KiB) haben, die Minimalgröße ist 1024 Byte (1KiB) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendebuffer hält die Daten welche über tf_rs232_v2_write() übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS232 empfangen wurden aber noch nicht über tf_rs232_v2_read() oder Read Low Level Callback an ein Nutzerprogramm übertragen werden konnten.

int tf_rs232_v2_get_buffer_config(TF_RS232V2 *rs232_v2, uint16_t *ret_send_buffer_size, uint16_t *ret_receive_buffer_size)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_send_buffer_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 ret_receive_buffer_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120
Rückgabe:	e_code – Typ: int

Gibt die Buffer-Konfiguration zurück, wie von tf_rs232_v2_set_buffer_config() gesetzt.

int tf_rs232_v2_get_buffer_status(TF_RS232V2 *rs232_v2, uint16_t *ret_send_buffer_used, uint16_t *ret_receive_buffer_used)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_send_buffer_used – Typ: uint16_t, Einheit: 1 B, Wertebereich: [0 bis 9216] ret_receive_buffer_used – Typ: uint16_t, Einheit: 1 B, Wertebereich: [0 bis 9216]
Rückgabe:	e_code – Typ: int

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe tf_rs232_v2_set_buffer_config() zur Konfiguration der Buffergrößen.

int tf_rs232_v2_get_error_count(TF_RS232V2 *rs232_v2, uint32_t *ret_error_count_overrun, uint32_t *ret_error_count_parity)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_error_count_overrun – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_parity – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

int tf_rs232_v2_get_spitfp_error_count(TF_RS232V2 *rs232_v2, 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)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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 tf_rs232_v2_set_status_led_config(TF_RS232V2 *rs232_v2, uint8_t config)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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:

Für config:

TF_RS232_V2_STATUS_LED_CONFIG_OFF = 0
TF_RS232_V2_STATUS_LED_CONFIG_ON = 1
TF_RS232_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_RS232_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_rs232_v2_get_status_led_config(TF_RS232V2 *rs232_v2, uint8_t *ret_config)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

TF_RS232_V2_STATUS_LED_CONFIG_OFF = 0
TF_RS232_V2_STATUS_LED_CONFIG_ON = 1
TF_RS232_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_RS232_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_rs232_v2_get_chip_temperature(TF_RS232V2 *rs232_v2, int16_t *ret_temperature)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur, 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 tf_rs232_v2_reset(TF_RS232V2 *rs232_v2)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Rückgabe:	e_code – Typ: int

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 tf_rs232_v2_get_identity(TF_RS232V2 *rs232_v2, 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_v2 – Typ: TF_RS232V2 *
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¶

int tf_rs232_v2_enable_read_callback(TF_RS232V2 *rs232_v2)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Rückgabe:	e_code – Typ: int

Aktiviert den Read Low Level Callback. Dies deaktiviert den Frame Readable Callback.

Im Startzustand ist der Callback deaktiviert.

int tf_rs232_v2_disable_read_callback(TF_RS232V2 *rs232_v2)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Rückgabe:	e_code – Typ: int

Deaktiviert den Read Low Level Callback.

Im Startzustand ist der Callback deaktiviert.

int tf_rs232_v2_is_read_callback_enabled(TF_RS232V2 *rs232_v2, bool *ret_enabled)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt true zurück falls Read Low Level Callback aktiviert ist, false sonst.

int tf_rs232_v2_set_frame_readable_callback_configuration(TF_RS232V2 *rs232_v2, uint16_t frame_size)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * frame_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0
Rückgabe:	e_code – Typ: int

Konfiguriert den Frame Readable Callback. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Callback auslöst. Eine Frame Size von 0 deaktiviert den Callback. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den Read Low Level Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.3 (Plugin).

int tf_rs232_v2_get_frame_readable_callback_configuration(TF_RS232V2 *rs232_v2, uint16_t *ret_frame_size)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_frame_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_rs232_v2_set_frame_readable_callback_configuration() gesetzt.

Neu in Version 2.0.3 (Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_rs232_v2_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_rs232_v2_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_rs232_v2_register_read_low_level_callback(TF_RS232V2 *rs232_v2, TF_RS232V2_ReadLowLevelHandler handler, void *user_data)¶

void handler(TF_RS232V2 *rs232_v2, uint16_t message_length, uint16_t message_chunk_offset, char message_chunk_data[60], void *user_data)

Callback-Parameter:	rs232_v2 – Typ: TF_RS232V2 * message_length – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_data – Typ: char[60] user_data – Typ: void *

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.

Dieser Callback kann durch tf_rs232_v2_enable_read_callback() aktiviert werden.

int tf_rs232_v2_register_error_count_callback(TF_RS232V2 *rs232_v2, TF_RS232V2_ErrorCountHandler handler, void *user_data)¶

void handler(TF_RS232V2 *rs232_v2, uint32_t error_count_overrun, uint32_t error_count_parity, void *user_data)

Callback-Parameter:	rs232_v2 – Typ: TF_RS232V2 * error_count_overrun – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] error_count_parity – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] user_data – Typ: void *

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.

int tf_rs232_v2_register_frame_readable_callback(TF_RS232V2 *rs232_v2, TF_RS232V2_FrameReadableHandler handler, void *user_data)¶

void handler(TF_RS232V2 *rs232_v2, uint16_t frame_count, void *user_data)

Callback-Parameter:	rs232_v2 – Typ: TF_RS232V2 * frame_count – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit tf_rs232_v2_set_frame_readable_callback_configuration() konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro tf_rs232_v2_read() Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal wenn das Callback ausgelöst wird, X Bytes mit der tf_rs232_v2_read()-Funktion gelesen werden können, ohne dass der Frame Count-Parameter geprüft werden muss.

Neu in Version 2.0.3 (Plugin).

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_rs232_v2_get_response_expected(TF_RS232V2 *rs232_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * 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 tf_rs232_v2_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:

TF_RS232_V2_FUNCTION_ENABLE_READ_CALLBACK = 3
TF_RS232_V2_FUNCTION_DISABLE_READ_CALLBACK = 4
TF_RS232_V2_FUNCTION_SET_CONFIGURATION = 6
TF_RS232_V2_FUNCTION_SET_BUFFER_CONFIG = 8
TF_RS232_V2_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
TF_RS232_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_RS232_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_RS232_V2_FUNCTION_RESET = 243
TF_RS232_V2_FUNCTION_WRITE_UID = 248

int tf_rs232_v2_set_response_expected(TF_RS232V2 *rs232_v2, uint8_t function_id, bool response_expected)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * 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:

TF_RS232_V2_FUNCTION_ENABLE_READ_CALLBACK = 3
TF_RS232_V2_FUNCTION_DISABLE_READ_CALLBACK = 4
TF_RS232_V2_FUNCTION_SET_CONFIGURATION = 6
TF_RS232_V2_FUNCTION_SET_BUFFER_CONFIG = 8
TF_RS232_V2_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
TF_RS232_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_RS232_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_RS232_V2_FUNCTION_RESET = 243
TF_RS232_V2_FUNCTION_WRITE_UID = 248

int tf_rs232_v2_set_response_expected_all(TF_RS232V2 *rs232_v2, bool response_expected)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * 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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int tf_rs232_v2_set_bootloader_mode(TF_RS232V2 *rs232_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für mode:

TF_RS232_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_RS232_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_RS232_V2_BOOTLOADER_STATUS_OK = 0
TF_RS232_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_RS232_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_RS232_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_RS232_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_RS232_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_rs232_v2_get_bootloader_mode(TF_RS232V2 *rs232_v2, uint8_t *ret_mode)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

TF_RS232_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_RS232_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_rs232_v2_set_write_firmware_pointer(TF_RS232V2 *rs232_v2, uint32_t pointer)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_rs232_v2_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 tf_rs232_v2_write_firmware(TF_RS232V2 *rs232_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_rs232_v2_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 tf_rs232_v2_write_uid(TF_RS232V2 *rs232_v2, uint32_t uid)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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 tf_rs232_v2_read_uid(TF_RS232V2 *rs232_v2, uint32_t *ret_uid)¶

Parameter:	rs232_v2 – Typ: TF_RS232V2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Konstanten¶

TF_RS232_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS232 Bricklet 2.0 zu identifizieren.

Die Funktionen tf_rs232_v2_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_RS232_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.