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

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

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

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

static bool frame_readable = false;
// Callback function for frame readable callback
static void frame_readable_handler(TF_CANV2 *device, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    frame_readable = true;
}

static TF_CANV2 can;

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

    // Configure transceiver for loopback mode
    check(tf_can_v2_set_transceiver_configuration(&can, 1000000, 625,
                                                  TF_CAN_V2_TRANSCEIVER_MODE_LOOPBACK), "call set_transceiver_configuration");
    // Register frame readable callback to function frame_readable_handler
    tf_can_v2_register_frame_readable_callback(&can,
                                               frame_readable_handler,
                                               NULL);
    // Enable frame readable callback
    check(tf_can_v2_set_frame_readable_callback_configuration(&can,
                                                              true), "call set_frame_readable_callback_configuration");
    // Write standard data frame with identifier 1742 and 3 bytes of data
    uint8_t data[3] = {42, 23, 17};
    bool success;
    check(tf_can_v2_write_frame(&can, TF_CAN_V2_FRAME_TYPE_STANDARD_DATA, 1742,
                                data, 3, &success), "call write_frame");
    if(!success)
        tf_hal_printf("Failed to write frame.\n");
}

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

    if(!frame_readable)
        return;

    frame_readable = false;

    bool success;
    uint8_t frame_type;
    uint32_t identifier;
    uint8_t data[15];
    uint8_t data_length;

    // Frame readable will only trigger once, even if there are multiple frames readable, so we use a loop to
    // read frames until there are none left.
    check(tf_can_v2_read_frame(&can, &success, &frame_type, &identifier, data, &data_length), "read frame");
    while (success) {
        if(frame_type == TF_CAN_V2_FRAME_TYPE_STANDARD_DATA) {
            tf_hal_printf("Frame Type: Standard Data\n");
        } else if(frame_type == TF_CAN_V2_FRAME_TYPE_STANDARD_REMOTE) {
            tf_hal_printf("Frame Type: Standard Remote\n");
        } else if(frame_type == TF_CAN_V2_FRAME_TYPE_EXTENDED_DATA) {
            tf_hal_printf("Frame Type: Extended Data\n");
        } else if(frame_type == TF_CAN_V2_FRAME_TYPE_EXTENDED_REMOTE) {
            tf_hal_printf("Frame Type: Extended Remote\n");
        }

        tf_hal_printf("Identifier: %I32u\n", identifier);
        tf_hal_printf("Data (Length: %I8d):", data_length);

        uint8_t i;
        for (i = 0; i < data_length && i < 8; ++i) {
            tf_hal_printf(" %I8d", data[i]);
        }

        tf_hal_printf("\n");
        check(tf_can_v2_read_frame(&can, &success, &frame_type, &identifier, data, &data_length), "read frame");
    }
}

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_can_v2_create(TF_CANV2 *can_v2, const char *uid, TF_HAL *hal)¶

Parameter:	can_v2 – Typ: TF_CANV2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_CANV2 can_v2;
tf_can_v2_create(&can_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_can_v2_destroy(TF_CANV2 *can_v2)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
Rückgabe:	e_code – Typ: int

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

int tf_can_v2_write_frame(TF_CANV2 *can_v2, uint8_t frame_type, uint32_t identifier, const uint8_t *data, uint8_t data_length, bool *ret_success)¶

Parameter:	can_v2 – Typ: TF_CANV2 * frame_type – Typ: uint8_t, Wertebereich: Siehe Konstanten identifier – Typ: uint32_t, Wertebereich: [0 bis 2³⁰ - 1] data – Typ: const uint8_t , Wertebereich: [0 bis 255] data_length* – Typ: uint8_t
Ausgabeparameter:	ret_success – Typ: bool
Rückgabe:	e_code – Typ: int

Schreibt einen Data- oder Remote-Frame in den Schreib-Queue, damit dieser über den CAN-Transceiver übertragen wird.

Das Bricklet unterstützt die Standard 11-Bit (CAN 2.0A) und die zusätzlichen Extended 29-Bit (CAN 2.0B) Identifier. Für Standard-Frames verwendet das Bricklet Bit 0 bis 10 des identifier Parameters als Standard 11-Bit Identifier. Für Extended-Frames verwendet das Bricklet Bit 0 bis 28 des identifier Parameters als Extended 29-Bit Identifier.

Der data Parameter kann bis zu 15 Bytes lang sein. Für Data-Frames werden davon bis zu 8 Bytes als die eigentlichen Daten verwendet. Das Längenfeld (DLC) im Daten- oder Remote-Frame wird auf die eigentliche Länge des data Parameters gesetzt. Dies erlaubt es Daten- und Remote-Frames mit Überlänge zu übertragen. Für Remote-Frames wird nur die Länge data Parameters verwendet. Die eigentlichen data Bytes werden ignoriert.

Gibt true zurück, wenn der Frame dem Schreib-Queue erfolgreich hinzugefügt wurde. Gibt false zurück wenn Frame nicht hinzugefügt werden konnte, weil der Schreib-Queue bereits voll ist oder weil der Schreib-Buffer oder das Schreib-Backlog mit einer Länge von Null konfiguriert sind (siehe tf_can_v2_set_queue_configuration()).

Das Schreib-Queue kann überlaufen, wenn Frames schneller geschrieben werden als das Bricklet sie über deb CAN-Transceiver übertragen kann. Dies kann dadurch passieren, dass der CAN-Transceiver als nur-lesend oder mit einer niedrigen Baudrate konfiguriert ist (siehe tf_can_v2_set_transceiver_configuration()). Es kann auch sein, dass der CAN-Bus stark belastet ist und der Frame nicht übertragen werden kann, da er immer wieder die Arbitrierung verliert. Ein anderer Grund kann sein, dass der CAN-Transceiver momentan deaktiviert ist, bedingt durch ein hohes Schreib-Fehlerlevel (siehe tf_can_v2_get_error_log()).

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

Für frame_type:

TF_CAN_V2_FRAME_TYPE_STANDARD_DATA = 0
TF_CAN_V2_FRAME_TYPE_STANDARD_REMOTE = 1
TF_CAN_V2_FRAME_TYPE_EXTENDED_DATA = 2
TF_CAN_V2_FRAME_TYPE_EXTENDED_REMOTE = 3

int tf_can_v2_read_frame(TF_CANV2 *can_v2, bool *ret_success, uint8_t *ret_frame_type, uint32_t *ret_identifier, uint8_t *ret_data, uint8_t *ret_data_length)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
Ausgabeparameter:	ret_success – Typ: bool ret_frame_type – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_identifier – Typ: uint32_t, Wertebereich: [0 bis 2³⁰ - 1] ret_data – Typ: uint8_t , Wertebereich: [0 bis 255] ret_data_length* – Typ: uint8_t
Rückgabe:	e_code – Typ: int

Versucht den nächsten Data- oder Remote-Frame aus dem Lese-Queue zu lesen und zurückzugeben. Falls ein Frame erfolgreich gelesen wurde, dann wird der success Rückgabewert auf true gesetzt und die anderen Rückgabewerte beinhalte den gelesenen Frame. Falls der Lese-Queue leer ist und kein Frame gelesen werden konnte, dann wird der success Rückgabewert auf false gesetzt und die anderen Rückgabewerte beinhalte ungültige Werte.

Der identifier Rückgabewerte folgt dem für tf_can_v2_write_frame() beschriebenen Format.

Der data Rückgabewerte kann bis zu 15 Bytes lang sein. Bei Data-Frames sind davon bis zu 8 Byte die eigentlich empfangenen Daten. Alle Bytes nach dem 8ten Byte sind immer Null und dienen nur der Wiedergabe der Länge von Data- und Remote-Frames mit Überlänge. Für Remote-Frames stellt die Länge des data Rückgabewertes die angefragte Länge dar. Die eigentlichen data Bytes sind immer Null.

Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames vom CAN-Transceiver überhaupt empfangen und im Lese-Queue abgelegt werden sollen (siehe tf_can_v2_set_read_filter_configuration()).

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe die tf_can_v2_set_frame_read_callback_configuration() Funktion und den Frame Read Low Level Callback.

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

Für ret_frame_type:

TF_CAN_V2_FRAME_TYPE_STANDARD_DATA = 0
TF_CAN_V2_FRAME_TYPE_STANDARD_REMOTE = 1
TF_CAN_V2_FRAME_TYPE_EXTENDED_DATA = 2
TF_CAN_V2_FRAME_TYPE_EXTENDED_REMOTE = 3

int tf_can_v2_set_transceiver_configuration(TF_CANV2 *can_v2, uint32_t baud_rate, uint16_t sample_point, uint8_t transceiver_mode)¶

Parameter:	can_v2 – Typ: TF_CANV2 * baud_rate – Typ: uint32_t, Einheit: 1 bit/s, Wertebereich: [10000 bis 1000000], Standardwert: 125000 sample_point – Typ: uint16_t, Einheit: 1/10 %, Wertebereich: [500 bis 900], Standardwert: 625 transceiver_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die Transceiver-Konfiguration für die CAN-Bus-Kommunikation.

Der CAN-Transceiver hat drei verschiedene Modi:

Normal: Es wird vom CAN-Bus gelesen und auf den CAN-Bus geschrieben und aktiv an der Bus-Fehlererkennung und dem Acknowledgement mitgewirkt.
Loopback: Alle Lese- und Schreiboperationen werden intern durchgeführt. Der Transceiver ist nicht mit dem eigentlichen CAN-Bus verbunden.
Read-Only: Es wird nur vom CAN-Bus gelesen, allerdings ohne aktiv an der Bus-Fehlererkennung oder dem Acknowledgement mitzuwirken. Nur der empfangende Teil des Transceivers ist mit dem CAN-Bus verbunden.

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

Für transceiver_mode:

TF_CAN_V2_TRANSCEIVER_MODE_NORMAL = 0
TF_CAN_V2_TRANSCEIVER_MODE_LOOPBACK = 1
TF_CAN_V2_TRANSCEIVER_MODE_READ_ONLY = 2

int tf_can_v2_get_transceiver_configuration(TF_CANV2 *can_v2, uint32_t *ret_baud_rate, uint16_t *ret_sample_point, uint8_t *ret_transceiver_mode)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
Ausgabeparameter:	ret_baud_rate – Typ: uint32_t, Einheit: 1 bit/s, Wertebereich: [10000 bis 1000000], Standardwert: 125000 ret_sample_point – Typ: uint16_t, Einheit: 1/10 %, Wertebereich: [500 bis 900], Standardwert: 625 ret_transceiver_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_transceiver_mode:

TF_CAN_V2_TRANSCEIVER_MODE_NORMAL = 0
TF_CAN_V2_TRANSCEIVER_MODE_LOOPBACK = 1
TF_CAN_V2_TRANSCEIVER_MODE_READ_ONLY = 2

Fortgeschrittene Funktionen¶

int tf_can_v2_set_queue_configuration(TF_CANV2 *can_v2, uint8_t write_buffer_size, int32_t write_buffer_timeout, uint16_t write_backlog_size, const int8_t *read_buffer_sizes, uint8_t read_buffer_sizes_length, uint16_t read_backlog_size)¶

Parameter:

Parameter:	can_v2 – Typ: TF_CANV2 * write_buffer_size – Typ: uint8_t, Wertebereich: [0 bis 32], Standardwert: 8 write_buffer_timeout – Typ: int32_t, Wertebereich: [-1 bis 2³¹ - 1], Standardwert: 0 write_backlog_size – Typ: uint16_t, Wertebereich: [0 bis 768], Standardwert: 383 read_buffer_sizes – Typ: const int8_t , Wertebereich: [-32 bis -1, 1 bis 32], Standardwert: {16, -8} read_buffer_sizes_length* – Typ: uint8_t read_backlog_size – Typ: uint16_t, Wertebereich: [0 bis 768], Standardwert: 383
Rückgabe:	e_code – Typ: int

can_v2 – Typ: TF_CANV2 *
write_buffer_size – Typ: uint8_t, Wertebereich: [0 bis 32], Standardwert: 8
write_buffer_timeout – Typ: int32_t, Wertebereich: [-1 bis 2³¹ - 1], Standardwert: 0
write_backlog_size – Typ: uint16_t, Wertebereich: [0 bis 768], Standardwert: 383
read_buffer_sizes – Typ: const int8_t *, Wertebereich: [-32 bis -1, 1 bis 32], Standardwert: {16, -8}
read_buffer_sizes_length – Typ: uint8_t
read_backlog_size – Typ: uint16_t, Wertebereich: [0 bis 768], Standardwert: 383

Rückgabe:

e_code – Typ: int

Setzt die Schreibe- und Lese-Queue-Konfiguration.

Der CAN-Transceiver hat insgesamt 32 Buffer in Hardware für das Übertragen und Empfangen von Frames. Zusätzlich hat das Bricklet ein Backlog für insgesamt 768 Frames in Software. Die Buffer und das Backlog können frei in Schreib- und Lese-Queues aufgeteilt werden.

tf_can_v2_write_frame() schreibt einen Frame in das Schreib-Backlog. Das Bricklet überträgt den Frame vom Backlog in einen freien Schreib-Buffer. Der CAN-Transceiver überträgt dann den Frame vom Schreib-Buffer über den CAN-Bus. Falls kein Schreib-Buffer (write_buffer_size ist Null) oder kein Schreib-Backlog (write_backlog_size ist Null) vorhanden ist dann kann kein Frame übertragen werden und tf_can_v2_write_frame() gibt immer false zurück.

Der CAN-Transceiver empfängt einen Frame vom CAN-Bus und speichert ihn in einem freien Lese-Buffer. Das Bricklet übertragt den Frame vom Lese-Buffer in das Lese-Backlog. tf_can_v2_read_frame() liest den Frame aus dem Lese-Backlog und gibt ihn zurück. Falls keine Lese-Buffer (read_buffer_sizes ist leer) oder kein Lese-Backlog (read_backlog_size ist Null) vorhanden ist dann kann kein Frame empfangen werden und tf_can_v2_read_frame() gibt immer false zurück.

Es kann mehrere Lese-Buffer geben, da der CAN-Transceiver nicht Data- und Remote-Frames in den gleichen Lese-Buffer empfangen kann. Eine positive Lese-Buffer-Größe stellt einen Data-Frame-Lese-Buffer dar und eine negative Lese-Buffer-Größe stellt einen Remote-Frame-Lese-Buffer dar. Eine Lese-Buffer-Länge von Null ist nicht erlaubt. Standardmäßig ist der erste Lese-Buffer für Data-Frames konfiguriert und der zweite Lese-Buffer ist für Remote-Frames konfiguriert. Es kann bis zu 32 verschiedene Lese-Buffer geben, unter der Annahme, dass kein Schreib-Buffer verwendet wird. Jeder Lese-Buffer hat seine eigene Filter-Konfiguration (siehe tf_can_v2_set_read_filter_configuration()).

Eine gültige Queue-Konfiguration erfüllt diese Bedingungen:

write_buffer_size + abs(read_buffer_size_0) + abs(read_buffer_size_1) + ... + abs(read_buffer_size_31) <= 32
write_backlog_size + read_backlog_size <= 768

Der Schreib-Timeout hat drei verschiedene Modi, die festlegen wie mit einer fehlgeschlagen Frame-Übertragung umgegangen werden soll:

Single-Shot (= -1): Es wird nur ein Übertragungsversuch durchgeführt. Falls die Übertragung fehlschlägt wird der Frame verworfen.
Infinite (= 0): Es werden unendlich viele Übertragungsversuche durchgeführt. Der Frame wird niemals verworfen.
Milliseconds (> 0): Es wird eine beschränkte Anzahl Übertragungsversuche durchgeführt. Falls der Frame nach der eingestellten Anzahl Millisekunden noch nicht erfolgreich übertragen wurde, dann wird er verworfen.

Der aktuelle Inhalt der Queues geht bei einem Aufruf dieser Funktion verloren.

int tf_can_v2_get_queue_configuration(TF_CANV2 *can_v2, uint8_t *ret_write_buffer_size, int32_t *ret_write_buffer_timeout, uint16_t *ret_write_backlog_size, int8_t *ret_read_buffer_sizes, uint8_t *ret_read_buffer_sizes_length, uint16_t *ret_read_backlog_size)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
Ausgabeparameter:	ret_write_buffer_size – Typ: uint8_t, Wertebereich: [0 bis 32], Standardwert: 8 ret_write_buffer_timeout – Typ: int32_t, Wertebereich: [-1 bis 2³¹ - 1], Standardwert: 0 ret_write_backlog_size – Typ: uint16_t, Wertebereich: [0 bis 768], Standardwert: 383 ret_read_buffer_sizes – Typ: int8_t , Wertebereich: [-32 bis -1, 1 bis 32], Standardwert: {16, -8} ret_read_buffer_sizes_length* – Typ: uint8_t ret_read_backlog_size – Typ: uint16_t, Wertebereich: [0 bis 768], Standardwert: 383
Rückgabe:	e_code – Typ: int

Gibt die Queue-Konfiguration zurück, wie von tf_can_v2_set_queue_configuration() gesetzt.

int tf_can_v2_set_read_filter_configuration(TF_CANV2 *can_v2, uint8_t buffer_index, uint8_t filter_mode, uint32_t filter_mask, uint32_t filter_identifier)¶

Parameter:	can_v2 – Typ: TF_CANV2 * buffer_index – Typ: uint8_t, Wertebereich: [0 bis 31] filter_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 filter_mask – Typ: uint32_t, Wertebereich: [0 bis 2³⁰ - 1] filter_identifier – Typ: uint32_t, Wertebereich: [0 bis 2³⁰ - 1]
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration für den Lesefilter des angegebenen Lese-Buffers. Damit kann festgelegt werden, welche Frames von der CAN-Transceiver überhaupt empfangen und im Lese-Buffer abgelegt werden sollen.

Der Lesefilter hat vier verschiedene Modi, die festlegen ob und wie die Filter-Maske und der Filter-Identifier angewendet werden:

Accept-All: Alle Frames werden empfangen.
Match-Standard-Only: Nur Standard-Frames mit übereinstimmendem Identifier werden empfangen.
Match-Extended-Only: Nur Extended-Frames mit übereinstimmendem Identifier werden empfangen.
Match-Standard-And-Extended: Standard- und Extended-Frames mit übereinstimmendem Identifier werden empfangen.

Filter-Maske und Filter-Identifier werden als Bitmasken verwendet. Ihre Verwendung hängt vom Filter-Modus ab:

Accept-All: Filter-Maske und Filter-Identifier werden ignoriert.
Match-Standard-Only: Bit 0 bis 10 (11 Bits) der Filter-Maske und des Filter-Identifiers werden zum Abgleich mit dem 11-Bit Identifier von Standard-Frames verwendet.
Match-Extended-Only: Bit 0 bis 28 (29 Bits) der Filter-Maske und des Filter-Identifiers Abgleich mit dem 29-Bit Identifier von Extended-Frames verwendet.
Match-Standard-And-Extended: Bit 18 bis 28 (11 Bits) der Filter-Maske und des Filter-Identifiers werden zum Abgleich mit dem 11-Bit Identifier von Standard-Frames verwendet, Bit 0 bis 17 (18 Bits) werden in diesem Fall ignoriert. Bit 0 bis 28 (29 Bits) der Filter-Maske und des Filter-Identifiers werden zum Abgleich mit dem 29-Bit Identifier von Extended-Frames verwendet.

Filter-Maske und Filter-Identifier werden auf diese Weise angewendet: Mit der Filter-Maske werden die Frame-Identifier-Bits ausgewählt, die mit den entsprechenden Filter-Identifier-Bits verglichen werden sollen. Alle nicht-ausgewählten Bits werden automatisch akzeptiert. Alle ausgewählten Bits müssen dem Filter-Identifier entsprechen, um akzeptiert zu werden. Wenn alle Bits für den ausgewählte Modus akzeptiert wurden, dann ist der Frame akzeptiert und wird im Lese-Buffer abgelegt.

Filter-Masken-Bit	Filter-Identifier-Bit	Frame-Identifier-Bit	Ergebnis
0	X	X	akzeptiert
1	0	0	akzeptiert
1	0	1	verworfen
1	1	0	verworfen
1	1	1	akzeptiert

Ein Beispiel: Um nur Standard-Frames mit Identifier 0x123 zu empfangen kann der Modus auf Match-Standard-Only mit 0x7FF als Filter-Maske und 0x123 als Filter-Identifier eingestellt werden. Die Maske 0x7FF wählt alle 11 Identifier-Bits zum Abgleich aus, so dass der Identifier exakt 0x123 sein muss um akzeptiert zu werden.

Da bis zu 32 Lese-Buffer konfiguriert werden können (siehe tf_can_v2_set_queue_configuration()) können auch bis zu 32 verschiedenen Lesefilter gleichzeitig konfiguriert werden.

Der Standardmodus ist Accept-All für alle Lese-Buffer.

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

Für filter_mode:

TF_CAN_V2_FILTER_MODE_ACCEPT_ALL = 0
TF_CAN_V2_FILTER_MODE_MATCH_STANDARD_ONLY = 1
TF_CAN_V2_FILTER_MODE_MATCH_EXTENDED_ONLY = 2
TF_CAN_V2_FILTER_MODE_MATCH_STANDARD_AND_EXTENDED = 3

int tf_can_v2_get_read_filter_configuration(TF_CANV2 *can_v2, uint8_t buffer_index, uint8_t *ret_filter_mode, uint32_t *ret_filter_mask, uint32_t *ret_filter_identifier)¶

Parameter:	can_v2 – Typ: TF_CANV2 * buffer_index – Typ: uint8_t, Wertebereich: [0 bis 31]
Ausgabeparameter:	ret_filter_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_filter_mask – Typ: uint32_t, Wertebereich: [0 bis 2³⁰ - 1] ret_filter_identifier – Typ: uint32_t, Wertebereich: [0 bis 2³⁰ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Lese-Filter-Konfiguration zurück, wie von tf_can_v2_set_read_filter_configuration() gesetzt.

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

Für ret_filter_mode:

TF_CAN_V2_FILTER_MODE_ACCEPT_ALL = 0
TF_CAN_V2_FILTER_MODE_MATCH_STANDARD_ONLY = 1
TF_CAN_V2_FILTER_MODE_MATCH_EXTENDED_ONLY = 2
TF_CAN_V2_FILTER_MODE_MATCH_STANDARD_AND_EXTENDED = 3

int tf_can_v2_get_error_log(TF_CANV2 *can_v2, uint8_t *ret_transceiver_state, uint8_t *ret_transceiver_write_error_level, uint8_t *ret_transceiver_read_error_level, uint32_t *ret_transceiver_stuffing_error_count, uint32_t *ret_transceiver_format_error_count, uint32_t *ret_transceiver_ack_error_count, uint32_t *ret_transceiver_bit1_error_count, uint32_t *ret_transceiver_bit0_error_count, uint32_t *ret_transceiver_crc_error_count, uint32_t *ret_write_buffer_timeout_error_count, uint32_t *ret_read_buffer_overflow_error_count, bool *ret_read_buffer_overflow_error_occurred, uint8_t *ret_read_buffer_overflow_error_occurred_length, uint32_t *ret_read_backlog_overflow_error_count)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
Ausgabeparameter:	ret_transceiver_state – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_transceiver_write_error_level – Typ: uint8_t, Wertebereich: [0 bis 255] ret_transceiver_read_error_level – Typ: uint8_t, Wertebereich: [0 bis 255] ret_transceiver_stuffing_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_transceiver_format_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_transceiver_ack_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_transceiver_bit1_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_transceiver_bit0_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_transceiver_crc_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_write_buffer_timeout_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_read_buffer_overflow_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_read_buffer_overflow_error_occurred – Typ: bool * ret_read_buffer_overflow_error_occurred_length – Typ: uint8_t ret_read_backlog_overflow_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt Informationen über verschiedene Fehlerarten zurück.

Die Schreib- und Lesefehler-Level geben Aufschluss über das aktuelle Level der Stuffing-, Form-, Acknowledgement-, Bit-, und Prüfsummen-Fehler während CAN-Bus Schreib- und Leseoperationen. Für jede dieser Fehlerarten ist jeweils auch ein eigener Zähler vorhanden.

Wenn das Schreibfehler-Level 255 überschreitet dann wird der CAN-Transceiver deaktiviert und es können keine Frames mehr übertragen und empfangen werden. Wenn auf dem CAN-Bus für eine Weile Ruhe herrscht, dann wird der CAN-Transceiver automatisch wieder aktiviert.

Die Werte für Schreib-Buffer-Timeout, Lese-Buffer- und Lese-Backlog-Überlauf zählen die Anzahl dieser Fehler:

Ein Schreib-Buffer-Timeout tritt dann auf, wenn ein Frame nicht übertragen werden konnte bevor der eingestellte Schreib-Buffer-Timeout abgelaufen ist (siehe tf_can_v2_set_queue_configuration()).
Ein Lese-Buffer-Überlauf tritt dann auf, wenn in einem der Lese-Buffer des CAN-Transceiver noch der zuletzt empfangen Frame steht wenn der nächste Frame ankommt. In diesem Fall geht der zuletzt empfangen Frame verloren. Dies passiert, wenn der CAN-Transceiver mehr Frames empfängt als das Bricklet behandeln kann. Mit Hilfe des Lesefilters (siehe tf_can_v2_set_read_filter_configuration()) kann die Anzahl der empfangen Frames verringert werden. Dieser Zähler ist nicht exakt, sondern stellt eine untere Grenze da. Es kann vorkommen, dass das Bricklet nicht alle Überläufe erkennt, wenn diese in schneller Abfolge auftreten.
Ein Lese-Backlog-Überlauf tritt dann auf, wenn das Lese-Backlog des Bricklets bereits voll ist und noch ein Frame von einem Lese-Buffer des CAN-Transceiver gelesen werden soll. In diesem Fall geht der Frame im Lese-Buffer verloren. Dies passiert, wenn der CAN-Transceiver mehr Frames empfängt, die dem Lese-Backlog hinzugefügt werden sollen, als Frames mit der tf_can_v2_read_frame() Funktion aus dem Lese-Backlog entnommen werden. Die Verwendung des Frame Read Low Level Callbacks stellt sicher, dass der Lese-Backlog nicht überlaufen kann.

Der Lese-Buffer-Überlauf-Zähler zählt die Überläuft aller konfigurierten Lese-Buffer. In welchem Lese-Buffer seit dem letzten Aufruf dieser Funktion ein Überlauf aufgetreten ist kann an der Liste des Lese-Buffer-Überlauf-Auftretens (read_buffer_overflow_error_occurred) abgelesen werden. Auslesen des Fehler-Logs setzt diese Liste zurück.

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

Für ret_transceiver_state:

TF_CAN_V2_TRANSCEIVER_STATE_ACTIVE = 0
TF_CAN_V2_TRANSCEIVER_STATE_PASSIVE = 1
TF_CAN_V2_TRANSCEIVER_STATE_DISABLED = 2

int tf_can_v2_set_communication_led_config(TF_CANV2 *can_v2, uint8_t config)¶

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

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal pro 40 empfangenen oder gesendeten Frames.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

TF_CAN_V2_COMMUNICATION_LED_CONFIG_OFF = 0
TF_CAN_V2_COMMUNICATION_LED_CONFIG_ON = 1
TF_CAN_V2_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_CAN_V2_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_can_v2_get_communication_led_config(TF_CANV2 *can_v2, uint8_t *ret_config)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
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_can_v2_set_communication_led_config() gesetzt.

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

Für ret_config:

TF_CAN_V2_COMMUNICATION_LED_CONFIG_OFF = 0
TF_CAN_V2_COMMUNICATION_LED_CONFIG_ON = 1
TF_CAN_V2_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_CAN_V2_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_can_v2_set_error_led_config(TF_CANV2 *can_v2, uint8_t config)¶

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

Setzt die Konfiguration der Error-LED.

Standardmäßig (Show-Transceiver-State) geht die LED an, wenn der CAN-Transceiver im Passive oder Disabled Zustand ist (siehe tf_can_v2_get_error_log()). Wenn der CAN-Transceiver im Active Zustand ist, dann geht die LED aus.

Wenn die LED als Show-Error konfiguriert ist, dann geht die LED an wenn ein Error auftritt. Wenn diese Funktion danach nochmal mit der Show-Error-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

TF_CAN_V2_ERROR_LED_CONFIG_OFF = 0
TF_CAN_V2_ERROR_LED_CONFIG_ON = 1
TF_CAN_V2_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_CAN_V2_ERROR_LED_CONFIG_SHOW_TRANSCEIVER_STATE = 3
TF_CAN_V2_ERROR_LED_CONFIG_SHOW_ERROR = 4

int tf_can_v2_get_error_led_config(TF_CANV2 *can_v2, uint8_t *ret_config)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
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_can_v2_set_error_led_config() gesetzt.

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

Für ret_config:

TF_CAN_V2_ERROR_LED_CONFIG_OFF = 0
TF_CAN_V2_ERROR_LED_CONFIG_ON = 1
TF_CAN_V2_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_CAN_V2_ERROR_LED_CONFIG_SHOW_TRANSCEIVER_STATE = 3
TF_CAN_V2_ERROR_LED_CONFIG_SHOW_ERROR = 4

int tf_can_v2_get_spitfp_error_count(TF_CANV2 *can_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:	can_v2 – Typ: TF_CANV2 *
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_can_v2_set_status_led_config(TF_CANV2 *can_v2, uint8_t config)¶

Parameter:	can_v2 – Typ: TF_CANV2 * 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_CAN_V2_STATUS_LED_CONFIG_OFF = 0
TF_CAN_V2_STATUS_LED_CONFIG_ON = 1
TF_CAN_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_CAN_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_can_v2_get_status_led_config(TF_CANV2 *can_v2, uint8_t *ret_config)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
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_can_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_CAN_V2_STATUS_LED_CONFIG_OFF = 0
TF_CAN_V2_STATUS_LED_CONFIG_ON = 1
TF_CAN_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_CAN_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_can_v2_get_chip_temperature(TF_CANV2 *can_v2, int16_t *ret_temperature)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
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_can_v2_reset(TF_CANV2 *can_v2)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
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_can_v2_get_identity(TF_CANV2 *can_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:	can_v2 – Typ: TF_CANV2 *
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_can_v2_set_frame_read_callback_configuration(TF_CANV2 *can_v2, bool enabled)¶

Parameter:	can_v2 – Typ: TF_CANV2 * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert und deaktiviert den Frame Read Low Level Callback.

Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der Frame Readable Callback deaktiviert.

int tf_can_v2_get_frame_read_callback_configuration(TF_CANV2 *can_v2, bool *ret_enabled)¶

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

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

int tf_can_v2_set_frame_readable_callback_configuration(TF_CANV2 *can_v2, bool enabled)¶

Parameter:	can_v2 – Typ: TF_CANV2 * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert und deaktiviert den Frame Readable Callback.

Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der Frame Read Low Level Callback deaktiviert.

Neu in Version 2.0.3 (Plugin).

int tf_can_v2_get_frame_readable_callback_configuration(TF_CANV2 *can_v2, bool *ret_enabled)¶

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

Gibt true zurück falls der Frame Readable Callback aktiviert ist, false sonst.

Neu in Version 2.0.3 (Plugin).

int tf_can_v2_set_error_occurred_callback_configuration(TF_CANV2 *can_v2, bool enabled)¶

Parameter:	can_v2 – Typ: TF_CANV2 * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert und deaktiviert den Error Occurred Callback.

Standardmäßig ist der Callback deaktiviert.

Neu in Version 2.0.3 (Plugin).

int tf_can_v2_get_error_occurred_callback_configuration(TF_CANV2 *can_v2, bool *ret_enabled)¶

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

Gibt true zurück falls der Error Occurred Callback aktiviert ist, false sonst.

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_can_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_can_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_can_v2_register_frame_read_low_level_callback(TF_CANV2 *can_v2, TF_CANV2_FrameReadLowLevelHandler handler, void *user_data)¶

void handler(TF_CANV2 *can_v2, uint8_t frame_type, uint32_t identifier, uint8_t data_length, uint8_t data_data[15], void *user_data)

Callback-Parameter:	can_v2 – Typ: TF_CANV2 * frame_type – Typ: uint8_t, Wertebereich: Siehe Konstanten identifier – Typ: uint32_t, Wertebereich: [0 bis 2³⁰ - 1] data_length – Typ: uint8_t, Wertebereich: [0 bis 15] data_data – Typ: uint8_t[15], Wertebereich: [0 bis 255] user_data – Typ: void *

Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom CAN-Transceiver empfangen wurde.

Der identifier Rückgabewerte folgt dem für tf_can_v2_write_frame() beschriebenen Format.

Für Details zum data Rückgabewerte siehe tf_can_v2_read_frame().

Dieser Callback kann durch tf_can_v2_set_frame_read_callback_configuration() aktiviert werden.

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

Für frame_type:

TF_CAN_V2_FRAME_TYPE_STANDARD_DATA = 0
TF_CAN_V2_FRAME_TYPE_STANDARD_REMOTE = 1
TF_CAN_V2_FRAME_TYPE_EXTENDED_DATA = 2
TF_CAN_V2_FRAME_TYPE_EXTENDED_REMOTE = 3

int tf_can_v2_register_frame_readable_callback(TF_CANV2 *can_v2, TF_CANV2_FrameReadableHandler handler, void *user_data)¶

void handler(TF_CANV2 *can_v2, void *user_data)

Callback-Parameter:	can_v2 – Typ: TF_CANV2 * user_data – Typ: void *

Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom CAN-Transceiver empfangen wurde. Der empfangene Frame kann mit tf_can_v2_read_frame() ausgelesen werden. Falls weitere Frames empfangen werden, bevor tf_can_v2_read_frame() aufgerufen wurde, wird der Callback nicht erneut ausgelöst.

Dieser Callback kann durch tf_can_v2_set_frame_readable_callback_configuration() aktiviert werden.

Neu in Version 2.0.3 (Plugin).

int tf_can_v2_register_error_occurred_callback(TF_CANV2 *can_v2, TF_CANV2_ErrorOccurredHandler handler, void *user_data)¶

void handler(TF_CANV2 *can_v2, void *user_data)

Callback-Parameter:	can_v2 – Typ: TF_CANV2 * user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn ein Fehler während des Schreibens, Lesens oder Empfangens von CAN-Frames auftritt.

Der Callback wird nur einmal ausgelöst, bis tf_can_v2_get_error_log() aufgerufen wird. Diese Funktion liefert Details über aufgetretene Fehler.

Dieser Callback kann durch tf_can_v2_set_error_occurred_callback_configuration() aktiviert werden.

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_can_v2_get_response_expected(TF_CANV2 *can_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	can_v2 – Typ: TF_CANV2 * 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_can_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_CAN_V2_FUNCTION_SET_FRAME_READ_CALLBACK_CONFIGURATION = 3
TF_CAN_V2_FUNCTION_SET_TRANSCEIVER_CONFIGURATION = 5
TF_CAN_V2_FUNCTION_SET_QUEUE_CONFIGURATION = 7
TF_CAN_V2_FUNCTION_SET_READ_FILTER_CONFIGURATION = 9
TF_CAN_V2_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
TF_CAN_V2_FUNCTION_SET_ERROR_LED_CONFIG = 14
TF_CAN_V2_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 17
TF_CAN_V2_FUNCTION_SET_ERROR_OCCURRED_CALLBACK_CONFIGURATION = 20
TF_CAN_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_CAN_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_CAN_V2_FUNCTION_RESET = 243
TF_CAN_V2_FUNCTION_WRITE_UID = 248

int tf_can_v2_set_response_expected(TF_CANV2 *can_v2, uint8_t function_id, bool response_expected)¶

Parameter:	can_v2 – Typ: TF_CANV2 * 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_CAN_V2_FUNCTION_SET_FRAME_READ_CALLBACK_CONFIGURATION = 3
TF_CAN_V2_FUNCTION_SET_TRANSCEIVER_CONFIGURATION = 5
TF_CAN_V2_FUNCTION_SET_QUEUE_CONFIGURATION = 7
TF_CAN_V2_FUNCTION_SET_READ_FILTER_CONFIGURATION = 9
TF_CAN_V2_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
TF_CAN_V2_FUNCTION_SET_ERROR_LED_CONFIG = 14
TF_CAN_V2_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 17
TF_CAN_V2_FUNCTION_SET_ERROR_OCCURRED_CALLBACK_CONFIGURATION = 20
TF_CAN_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_CAN_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_CAN_V2_FUNCTION_RESET = 243
TF_CAN_V2_FUNCTION_WRITE_UID = 248

int tf_can_v2_set_response_expected_all(TF_CANV2 *can_v2, bool response_expected)¶

Parameter:	can_v2 – Typ: TF_CANV2 * 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_can_v2_set_bootloader_mode(TF_CANV2 *can_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	can_v2 – Typ: TF_CANV2 * 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_CAN_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_CAN_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_CAN_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_CAN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_CAN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_CAN_V2_BOOTLOADER_STATUS_OK = 0
TF_CAN_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_CAN_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_CAN_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_CAN_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_CAN_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_can_v2_get_bootloader_mode(TF_CANV2 *can_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_CAN_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_CAN_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_CAN_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_CAN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_CAN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_can_v2_set_write_firmware_pointer(TF_CANV2 *can_v2, uint32_t pointer)¶

Parameter:	can_v2 – Typ: TF_CANV2 * 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_can_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_can_v2_write_firmware(TF_CANV2 *can_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	can_v2 – Typ: TF_CANV2 * 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_can_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_can_v2_write_uid(TF_CANV2 *can_v2, uint32_t uid)¶

Parameter:	can_v2 – Typ: TF_CANV2 * 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_can_v2_read_uid(TF_CANV2 *can_v2, uint32_t *ret_uid)¶

Parameter:	can_v2 – Typ: TF_CANV2 *
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_CAN_V2_DEVICE_IDENTIFIER¶

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

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

TF_CAN_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines CAN Bricklet 2.0 dar.