C/C++ - CAN Bricklet¶

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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_can.h"

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

// Callback function for frame read callback
void cb_frame_read(uint8_t frame_type, uint32_t identifier, uint8_t data[8],
                   uint8_t length, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    if(frame_type == CAN_FRAME_TYPE_STANDARD_DATA) {
        printf("Frame Type: Standard Data\n");
    } else if(frame_type == CAN_FRAME_TYPE_STANDARD_REMOTE) {
        printf("Frame Type: Standard Remote\n");
    } else if(frame_type == CAN_FRAME_TYPE_EXTENDED_DATA) {
        printf("Frame Type: Extended Data\n");
    } else if(frame_type == CAN_FRAME_TYPE_EXTENDED_REMOTE) {
        printf("Frame Type: Extended Remote\n");
    }

    printf("Identifier: %u\n", identifier);
    printf("Data (Length: %d):", length);

    uint8_t i;
    for (i = 0; i < length && i < 8; ++i) {
        printf(" %d", data[i]);
    }

    printf("\n");
    printf("\n");
}

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

    // Create device object
    CAN can;
    can_create(&can, 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

    // Configure transceiver for loopback mode
    can_set_configuration(&can, CAN_BAUD_RATE_1000KBPS, CAN_TRANSCEIVER_MODE_LOOPBACK, 0);

    // Register frame read callback to function cb_frame_read
    can_register_callback(&can,
                          CAN_CALLBACK_FRAME_READ,
                          (void (*)(void))cb_frame_read,
                          NULL);

    // Enable frame read callback
    can_enable_frame_read_callback(&can);

    // Write standard data frame with identifier 1742 and 3 bytes of data
    uint8_t data[8] = {42, 23, 17, 0, 0, 0, 0, 0};
    bool success;
    can_write_frame(&can, CAN_FRAME_TYPE_STANDARD_DATA, 1742, data, 3, &success);

    printf("Press key to exit\n");
    getchar();

    can_disable_frame_read_callback(&can);

    can_destroy(&can);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Grundfunktionen¶

void can_create(CAN *can, const char *uid, IPConnection *ipcon)¶

Parameter:	can – Typ: CAN * uid – Typ: const char * ipcon – Typ: IPConnection *

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

CAN can;
can_create(&can, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void can_destroy(CAN *can)¶

Parameter:	can – Typ: CAN *

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

int can_write_frame(CAN *can, uint8_t frame_type, uint32_t identifier, uint8_t data[8], uint8_t length, bool *ret_success)¶

Parameter:	can – Typ: CAN * frame_type – Typ: uint8_t, Wertebereich: Siehe Konstanten identifier – Typ: uint32_t, Wertebereich: [0 bis 230 - 1] data – Typ: uint8_t[8], Wertebereich: [0 bis 255] length – Typ: uint8_t, Wertebereich: [0 bis 15]
Ausgabeparameter:	ret_success – Typ: bool
Rückgabe:	e_code – Typ: int

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

Das Bricklet unterstützt die Standard 11-Bit (CAN 2.0A) und die zusätzlichen Extended 18-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 zusätzlich Bit 11 bis 28 des identifier Parameters als Extended 18-Bit Identifier.

Für Remote-Frames wird der data Parameter ignoriert.

Gibt true zurück, wenn der Frame dem Schreib-Buffer erfolgreich hinzugefügt wurde. Gibt false zurück wenn Frame nicht hinzugefügt werden konnte, weil der Schreib-Buffer bereits voll ist.

Der Schreib-Buffer 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 can_set_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 duch ein hohes Schreib-Fehlerlevel (siehe can_get_error_log()).

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

Für frame_type:

• CAN_FRAME_TYPE_STANDARD_DATA = 0
• CAN_FRAME_TYPE_STANDARD_REMOTE = 1
• CAN_FRAME_TYPE_EXTENDED_DATA = 2
• CAN_FRAME_TYPE_EXTENDED_REMOTE = 3

int can_read_frame(CAN *can, bool *ret_success, uint8_t *ret_frame_type, uint32_t *ret_identifier, uint8_t ret_data[8], uint8_t *ret_length)¶

Parameter:	can – Typ: CAN *
Ausgabeparameter:	ret_success – Typ: bool ret_frame_type – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_identifier – Typ: uint32_t, Wertebereich: [0 bis 230 - 1] ret_data – Typ: uint8_t[8], Wertebereich: [0 bis 255] ret_length – Typ: uint8_t, Wertebereich: [0 bis 15]
Rückgabe:	e_code – Typ: int

Versucht den nächsten Data- oder Remote-Frame aus dem Lese-Buffer 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-Buffer 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 can_write_frame() beschriebenen Format.

Für Remote-Frames beinhalte der data Rückgabewerte immer ungültigen Werte.

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

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe die can_enable_frame_read_callback() Funktion und den CAN_CALLBACK_FRAME_READ Callback.

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

Für ret_frame_type:

• CAN_FRAME_TYPE_STANDARD_DATA = 0
• CAN_FRAME_TYPE_STANDARD_REMOTE = 1
• CAN_FRAME_TYPE_EXTENDED_DATA = 2
• CAN_FRAME_TYPE_EXTENDED_REMOTE = 3

int can_set_configuration(CAN *can, uint8_t baud_rate, uint8_t transceiver_mode, int32_t write_timeout)¶

Parameter:	can – Typ: CAN * baud_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3 transceiver_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 write_timeout – Typ: int32_t, Wertebereich: [-1 bis 231 - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

Die Baudrate kann in Schritten zwischen 10 und 1000 kBit/s eingestellt werden.

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.

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

• One-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.

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

Für baud_rate:

• CAN_BAUD_RATE_10KBPS = 0
• CAN_BAUD_RATE_20KBPS = 1
• CAN_BAUD_RATE_50KBPS = 2
• CAN_BAUD_RATE_125KBPS = 3
• CAN_BAUD_RATE_250KBPS = 4
• CAN_BAUD_RATE_500KBPS = 5
• CAN_BAUD_RATE_800KBPS = 6
• CAN_BAUD_RATE_1000KBPS = 7

Für transceiver_mode:

• CAN_TRANSCEIVER_MODE_NORMAL = 0
• CAN_TRANSCEIVER_MODE_LOOPBACK = 1
• CAN_TRANSCEIVER_MODE_READ_ONLY = 2

int can_get_configuration(CAN *can, uint8_t *ret_baud_rate, uint8_t *ret_transceiver_mode, int32_t *ret_write_timeout)¶

Parameter:	can – Typ: CAN *
Ausgabeparameter:	ret_baud_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3 ret_transceiver_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_write_timeout – Typ: int32_t, Wertebereich: [-1 bis 231 - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_baud_rate:

• CAN_BAUD_RATE_10KBPS = 0
• CAN_BAUD_RATE_20KBPS = 1
• CAN_BAUD_RATE_50KBPS = 2
• CAN_BAUD_RATE_125KBPS = 3
• CAN_BAUD_RATE_250KBPS = 4
• CAN_BAUD_RATE_500KBPS = 5
• CAN_BAUD_RATE_800KBPS = 6
• CAN_BAUD_RATE_1000KBPS = 7

Für ret_transceiver_mode:

• CAN_TRANSCEIVER_MODE_NORMAL = 0
• CAN_TRANSCEIVER_MODE_LOOPBACK = 1
• CAN_TRANSCEIVER_MODE_READ_ONLY = 2

Fortgeschrittene Funktionen¶

int can_set_read_filter(CAN *can, uint8_t mode, uint32_t mask, uint32_t filter1, uint32_t filter2)¶

Parameter:	can – Typ: CAN * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1 mask – Typ: uint32_t, Wertebereich: [0 bis 230 - 1] filter1 – Typ: uint32_t, Wertebereich: [0 bis 230 - 1] filter2 – Typ: uint32_t, Wertebereich: [0 bis 230 - 1]
Rückgabe:	e_code – Typ: int

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

Der Lesefilter hat fünf verschiedene Modi, die festlegen ob und wie die Maske und die beiden Filter angewendet werden:

• Disabled: Es wird keinerlei Filterung durchgeführt. Alle Frames inklusive unvollständiger und fehlerhafter Frames werden empfangen. Dieser Modus sollte nur für Debugging-Zwecke verwendet werden.
• Accept-All: Alle vollständigen und fehlerfreien Frames werden empfangen.
• Match-Standard: Nur Standard-Frames, deren Identifier der eingestellten Maske und Filtern entspricht, werden empfangen.
• Match-Standard-and-Data: Nur Standard-Frames, deren Identifier und Daten der eingestellten Maske und Filtern entspricht, werden empfangen.
• Match-Extended: Nur Extended-Frames, deren Identifier der eingestellten Maske und Filtern entspricht, werden empfangen.

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

• Disabled: Maske und Filter werden ignoriert.
• Accept-All: Maske und Filter werden ignoriert.
• Match-Standard: Bit 0 bis 10 (11 Bits) der Maske und Filter werden zum Abgleich mit dem 11-Bit Identifier von Standard-Frames verwendet.
• Match-Standard-and-Data: Bit 0 bis 10 (11 Bits) der Maske und Filter werden zum Abgleich mit dem 11-Bit Identifier von Standard-Frames verwendet. Bit 11 bis 18 (8 Bits) und Bit 19 bis 26 (8 Bits) der Maske und Filter werden zum Abgleich mit dem ersten und zweiten Daten-Byte (sofern vorhanden) von Standard-Frames verwendet.
• Match-Extended: Bit 0 bis 10 (11 Bits) der Maske und Filter werden zum Abgleich mit dem Standard 11-Bit Identifier-Teil von Extended-Frames verwendet. Bit 11 bis 28 (18 Bits) der Maske und Filter werden zum Abgleich mit dem Extended 18-Bit Identifier-Teil von Extended-Frames verwendet.

Maske und Filter werden auf diese Weise angewendet: Mit der Maske werden die Identifier- und Daten-Bits ausgewählt, die mit den entsprechenden Filter-Bits verglichen werden sollen. Alle nicht-ausgewählten Bits werden automatisch akzeptiert. Alle ausgewählten Bits müssen einem der beiden Filter 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.

Masken-Bit	Filter-Bit	Identifier/Daten-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 mit 0x7FF als Maske und 0x123 als Filter 1 und Filter 2 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.

Um Identifier 0x123 und 0x456 gleichzeitig zu akzeptieren kann Filter 2 auf 0x456 gesetzt und die Maske und Filter 1 beibehalten werden.

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

Für mode:

• CAN_FILTER_MODE_DISABLED = 0
• CAN_FILTER_MODE_ACCEPT_ALL = 1
• CAN_FILTER_MODE_MATCH_STANDARD = 2
• CAN_FILTER_MODE_MATCH_STANDARD_AND_DATA = 3
• CAN_FILTER_MODE_MATCH_EXTENDED = 4

int can_get_read_filter(CAN *can, uint8_t *ret_mode, uint32_t *ret_mask, uint32_t *ret_filter1, uint32_t *ret_filter2)¶

Parameter:	can – Typ: CAN *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1 ret_mask – Typ: uint32_t, Wertebereich: [0 bis 230 - 1] ret_filter1 – Typ: uint32_t, Wertebereich: [0 bis 230 - 1] ret_filter2 – Typ: uint32_t, Wertebereich: [0 bis 230 - 1]
Rückgabe:	e_code – Typ: int

Gibt die Lesefilter zurück, wie von can_set_read_filter() gesetzt.

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

Für ret_mode:

• CAN_FILTER_MODE_DISABLED = 0
• CAN_FILTER_MODE_ACCEPT_ALL = 1
• CAN_FILTER_MODE_MATCH_STANDARD = 2
• CAN_FILTER_MODE_MATCH_STANDARD_AND_DATA = 3
• CAN_FILTER_MODE_MATCH_EXTENDED = 4

int can_get_error_log(CAN *can, uint8_t *ret_write_error_level, uint8_t *ret_read_error_level, bool *ret_transceiver_disabled, uint32_t *ret_write_timeout_count, uint32_t *ret_read_register_overflow_count, uint32_t *ret_read_buffer_overflow_count)¶

Parameter:	can – Typ: CAN *
Ausgabeparameter:	ret_write_error_level – Typ: uint8_t, Wertebereich: [0 bis 255] ret_read_error_level – Typ: uint8_t, Wertebereich: [0 bis 255] ret_transceiver_disabled – Typ: bool ret_write_timeout_count – Typ: uint32_t, Wertebereich: [0 bis 232 - 1] ret_read_register_overflow_count – Typ: uint32_t, Wertebereich: [0 bis 232 - 1] ret_read_buffer_overflow_count – Typ: uint32_t, Wertebereich: [0 bis 232 - 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 Prüfsummen-, Acknowledgement-, Form-, Bit- und Stuffing-Fehler während CAN-Bus Schreib- und Leseoperationen.

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 Schreib- und Lesefehler-Level Werte sind im Read-Only Transceiver-Modus nicht verfügbar (see can_set_configuration()). Außerdem werden sie als Seiteneffekt von Konfigurations- und Lesefilteränderungen auf 0 zurückgesetzt.

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

• Ein Schreib-Timeout tritt dann auf, wenn ein Frame nicht übertragen werden konnte bevor der eingestellte Schreib-Timeout abgelaufen ist (siehe can_set_configuration()).
• Ein Lese-Register-Überlauf tritt dann auf, wenn im Lese-Register des CAN-Transceiver noch der zuletzt empfangen Frame steht wenn der nächste Frame ankommt. In diesem Fall geht der neu ankommende Frame verloren. Dies passiert, wenn der CAN-Transceiver mehr Frames empfängt als das Bricklet behandeln kann. Mit Hilfe des Lesefilters (siehe can_set_read_filter()) 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-Buffer-Überlauf tritt dann auf, wenn der Lese-Buffer des Bricklets bereits voll ist und noch ein Frame vom Lese-Register des CAN-Transceiver gelesen werden soll. In diesem Fall geht der Frame im Lese-Register verloren. Dies passiert, wenn der CAN-Transceiver mehr Frames empfängt, die dem Lese-Buffer hinzugefügt werden sollen, als Frames mit der can_read_frame() Funktion aus dem Lese-Buffer entnommen werden. Die Verwendung des CAN_CALLBACK_FRAME_READ Callbacks stellt sicher, dass der Lese-Buffer nicht überlaufen kann.

int can_get_identity(CAN *can, 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 – Typ: CAN *
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 216 - 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¶

void can_register_callback(CAN *can, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	can – Typ: CAN * 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 can_enable_frame_read_callback(CAN *can)¶

Parameter:	can – Typ: CAN *
Rückgabe:	e_code – Typ: int

Aktiviert den CAN_CALLBACK_FRAME_READ Callback.

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

int can_disable_frame_read_callback(CAN *can)¶

Parameter:	can – Typ: CAN *
Rückgabe:	e_code – Typ: int

Deaktiviert den CAN_CALLBACK_FRAME_READ Callback.

Standardmäßig ist der Callback deaktiviert.

int can_is_frame_read_callback_enabled(CAN *can, bool *ret_enabled)¶

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

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

int can_set_frame_readable_callback_configuration(CAN *can, bool enabled)¶

Parameter:	can – Typ: CAN * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert/deaktiviert den CAN_CALLBACK_FRAME_READABLE Callback.

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

Neu in Version 2.0.1 (Plugin).

int can_get_frame_readable_callback_configuration(CAN *can, bool *ret_enabled)¶

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

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

Neu in Version 2.0.1 (Plugin).

Callbacks¶

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

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

can_register_callback(&can,
                      CAN_CALLBACK_EXAMPLE,
                      (void (*)(void))my_callback,
                      NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

CAN_CALLBACK_FRAME_READ¶

void callback(uint8_t frame_type, uint32_t identifier, uint8_t data[8], uint8_t length, void *user_data)

Callback-Parameter:	frame_type – Typ: uint8_t, Wertebereich: Siehe Konstanten identifier – Typ: uint32_t, Wertebereich: [0 bis 230 - 1] data – Typ: uint8_t[8], Wertebereich: [0 bis 255] length – Typ: uint8_t, Wertebereich: [0 bis 15] 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 can_write_frame() beschriebenen Format.

Für Remote-Frames beinhalte der data Rückgabewerte immer ungültigen Werte.

Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames von der CAN-Transceiver überhaupt empfangen werden sollen (siehe can_set_read_filter()).

Dieser Callback kann durch can_enable_frame_read_callback() aktiviert werden.

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

Für frame_type:

• CAN_FRAME_TYPE_STANDARD_DATA = 0
• CAN_FRAME_TYPE_STANDARD_REMOTE = 1
• CAN_FRAME_TYPE_EXTENDED_DATA = 2
• CAN_FRAME_TYPE_EXTENDED_REMOTE = 3

CAN_CALLBACK_FRAME_READABLE¶

void callback(void *user_data)

Callback-Parameter:	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 can_read_frame() ausgelesen werden. Falls weitere Frames empfangen werden, bevor can_read_frame() aufgerufen wurde, wird der Callback nicht erneut ausgelöst.

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

Dieser Callback kann durch can_set_frame_readable_callback_configuration() aktiviert werden.

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 can_get_api_version(CAN *can, uint8_t ret_api_version[3])¶

Parameter:	can – Typ: CAN *
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:	e_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 can_get_response_expected(CAN *can, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	can – Typ: CAN * 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 can_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:

• CAN_FUNCTION_ENABLE_FRAME_READ_CALLBACK = 3
• CAN_FUNCTION_DISABLE_FRAME_READ_CALLBACK = 4
• CAN_FUNCTION_SET_CONFIGURATION = 6
• CAN_FUNCTION_SET_READ_FILTER = 8
• CAN_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 12

int can_set_response_expected(CAN *can, uint8_t function_id, bool response_expected)¶

Parameter:	can – Typ: CAN * 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.

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:

• CAN_FUNCTION_ENABLE_FRAME_READ_CALLBACK = 3
• CAN_FUNCTION_DISABLE_FRAME_READ_CALLBACK = 4
• CAN_FUNCTION_SET_CONFIGURATION = 6
• CAN_FUNCTION_SET_READ_FILTER = 8
• CAN_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 12

int can_set_response_expected_all(CAN *can, bool response_expected)¶

Parameter:	can – Typ: CAN * 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.

Konstanten¶

CAN_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein CAN Bricklet zu identifizieren.

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

CAN_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines CAN Bricklet dar.