Spezifikationen / Modbus Protokoll / API / Bricklets / CAN Bricklet

Modbus - CAN Bricklet¶

Dies ist die Beschreibung des Modbus Protokolls für das CAN Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CAN Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletCAN.write_frame¶

Funktions-ID:	1
Anfrage:	frame_type – Typ: uint8, Wertebereich: Siehe Bedeutungen identifier – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1] data – Typ: uint8[8], Wertebereich: [0 bis 255] length – Typ: uint8, Wertebereich: [0 bis 15]
Antwort:	success – Typ: bool

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 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 get_error_log).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für frame_type:

0 = Standard Data
1 = Standard Remote
2 = Extended Data
3 = Extended Remote

BrickletCAN.read_frame¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	success – Typ: bool frame_type – Typ: uint8, Wertebereich: Siehe Bedeutungen identifier – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1] data – Typ: uint8[8], Wertebereich: [0 bis 255] length – Typ: uint8, Wertebereich: [0 bis 15]

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 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 set_read_filter).

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe die enable_frame_read_callback Funktion und den CALLBACK_FRAME_READ Callback.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für frame_type:

0 = Standard Data
1 = Standard Remote
2 = Extended Data
3 = Extended Remote

BrickletCAN.set_configuration¶

Funktions-ID:	6
Anfrage:	baud_rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3 transceiver_mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 write_timeout – Typ: int32, Wertebereich: [-1 bis 2³¹ - 1], Standardwert: 0
Antwort:	keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für baud_rate:

0 = 10kbps
1 = 20kbps
2 = 50kbps
3 = 125kbps
4 = 250kbps
5 = 500kbps
6 = 800kbps
7 = 1000kbps

Für transceiver_mode:

0 = Normal
1 = Loopback
2 = Read Only

BrickletCAN.get_configuration¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	baud_rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3 transceiver_mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 write_timeout – Typ: int32, Wertebereich: [-1 bis 2³¹ - 1], Standardwert: 0

Gibt die Konfiguration zurück, wie von set_configuration gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für baud_rate:

0 = 10kbps
1 = 20kbps
2 = 50kbps
3 = 125kbps
4 = 250kbps
5 = 500kbps
6 = 800kbps
7 = 1000kbps

Für transceiver_mode:

0 = Normal
1 = Loopback
2 = Read Only

Fortgeschrittene Funktionen¶

BrickletCAN.set_read_filter¶

Funktions-ID:	8
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 mask – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1] filter1 – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1] filter2 – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1]
Antwort:	keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = Disabled
1 = Accept All
2 = Match Standard
3 = Match Standard And Data
4 = Match Extended

BrickletCAN.get_read_filter¶

Funktions-ID:	9
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 mask – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1] filter1 – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1] filter2 – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1]

Gibt die Lesefilter zurück, wie von set_read_filter gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = Disabled
1 = Accept All
2 = Match Standard
3 = Match Standard And Data
4 = Match Extended

BrickletCAN.get_error_log¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	write_error_level – Typ: uint8, Wertebereich: [0 bis 255] read_error_level – Typ: uint8, Wertebereich: [0 bis 255] transceiver_disabled – Typ: bool write_timeout_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] read_register_overflow_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] read_buffer_overflow_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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 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 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 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 read_frame Funktion aus dem Lese-Buffer entnommen werden. Die Verwendung des CALLBACK_FRAME_READ Callbacks stellt sicher, dass der Lese-Buffer nicht überlaufen kann.

BrickletCAN.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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.

Konfigurationsfunktionen für Callbacks¶

BrickletCAN.enable_frame_read_callback¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Aktiviert den CALLBACK_FRAME_READ Callback.

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

BrickletCAN.disable_frame_read_callback¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Deaktiviert den CALLBACK_FRAME_READ Callback.

Standardmäßig ist der Callback deaktiviert.

BrickletCAN.is_frame_read_callback_enabled¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

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

BrickletCAN.set_frame_readable_callback_configuration¶

Funktions-ID:	12
Anfrage:	enabled – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Aktiviert/deaktiviert den CALLBACK_FRAME_READABLE Callback.

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

Neu in Version 2.0.1 (Plugin).

BrickletCAN.get_frame_readable_callback_configuration¶

Funktions-ID:	13
Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

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

Neu in Version 2.0.1 (Plugin).

Callbacks¶

BrickletCAN.CALLBACK_FRAME_READ¶

Funktions-ID:	11
Antwort:	frame_type – Typ: uint8, Wertebereich: Siehe Bedeutungen identifier – Typ: uint32, Wertebereich: [0 bis 2³⁰ - 1] data – Typ: uint8[8], Wertebereich: [0 bis 255] length – Typ: uint8, Wertebereich: [0 bis 15]

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

Der identifier Rückgabewerte folgt dem für 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 set_read_filter).

Dieser Callback kann durch enable_frame_read_callback aktiviert werden.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für frame_type:

0 = Standard Data
1 = Standard Remote
2 = Extended Data
3 = Extended Remote

BrickletCAN.CALLBACK_FRAME_READABLE¶

Funktions-ID:	14
Antwort:	keine Nutzdaten

Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom CAN-Transceiver empfangen wurde. Der empfangene Frame kann mit read_frame ausgelesen werden. Falls weitere Frames empfangen werden, bevor 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 set_read_filter).

Dieser Callback kann durch set_frame_readable_callback_configuration aktiviert werden.

Neu in Version 2.0.1 (Plugin).