Shell - CAN Bricklet

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

Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (example-loopback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your CAN Bricklet

# Configure transceiver for loopback mode
tinkerforge call can-bricklet $uid set-configuration baud-rate-1000kbps transceiver-mode-loopback 0

# Handle incoming frame read callbacks
tinkerforge dispatch can-bricklet $uid frame-read &

# Enable frame read callback
tinkerforge call can-bricklet $uid enable-frame-read-callback

# Write standard data frame with identifier 1742 and 3 bytes of data
tinkerforge call can-bricklet $uid write-frame frame-type-standard-data 1742 42,23,1,.. 3

echo "Press key to exit"; read dummy

tinkerforge call can-bricklet $uid disable-frame-read-callback

kill -- -$$ # Stop callback dispatch in background

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call can-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des CAN Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des CAN Bricklet an und endet dann
tinkerforge dispatch can-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des CAN Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des CAN Bricklet an und endet dann
tinkerforge call can-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch can-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call can-bricklet <uid> write-frame <frame-type> <identifier> <data> <length>
Parameter:
  • <frame-type> – Typ: Int, Wertebereich: Siehe Symbole
  • <identifier> – Typ: Int, Wertebereich: [0 bis 1073741823]
  • <data> – Typ: Int Array, Länge: 8, Wertebereich: [0 bis 255]
  • <length> – Typ: Int, Wertebereich: [0 bis 15]
Ausgabe:
  • 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 Symbole sind für diese Funktion verfügbar:

Für <frame-type>:

  • frame-type-standard-data = 0
  • frame-type-standard-remote = 1
  • frame-type-extended-data = 2
  • frame-type-extended-remote = 3
tinkerforge call can-bricklet <uid> read-frame
Ausgabe:
  • success – Typ: Bool
  • frame-type – Typ: Int, Wertebereich: Siehe Symbole
  • identifier – Typ: Int, Wertebereich: [0 bis 1073741823]
  • data – Typ: Int Array, Länge: 8, Wertebereich: [0 bis 255]
  • length – Typ: Int, 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 frame-read Callback.

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

Für frame-type:

  • frame-type-standard-data = 0
  • frame-type-standard-remote = 1
  • frame-type-extended-data = 2
  • frame-type-extended-remote = 3
tinkerforge call can-bricklet <uid> set-configuration <baud-rate> <transceiver-mode> <write-timeout>
Parameter:
  • <baud-rate> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
  • <transceiver-mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • <write-timeout> – Typ: Int, Wertebereich: [-1 bis 231 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <baud-rate>:

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

Für <transceiver-mode>:

  • transceiver-mode-normal = 0
  • transceiver-mode-loopback = 1
  • transceiver-mode-read-only = 2
tinkerforge call can-bricklet <uid> get-configuration
Ausgabe:
  • baud-rate – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
  • transceiver-mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • write-timeout – Typ: Int, Wertebereich: [-1 bis 231 - 1], Standardwert: 0

Gibt die Konfiguration zurück, wie von set-configuration gesetzt.

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

Für baud-rate:

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

Für transceiver-mode:

  • transceiver-mode-normal = 0
  • transceiver-mode-loopback = 1
  • transceiver-mode-read-only = 2

Fortgeschrittene Funktionen

tinkerforge call can-bricklet <uid> set-read-filter <mode> <mask> <filter1> <filter2>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • <mask> – Typ: Int, Wertebereich: [0 bis 1073741823]
  • <filter1> – Typ: Int, Wertebereich: [0 bis 1073741823]
  • <filter2> – Typ: Int, Wertebereich: [0 bis 1073741823]
Ausgabe:
  • keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <mode>:

  • filter-mode-disabled = 0
  • filter-mode-accept-all = 1
  • filter-mode-match-standard = 2
  • filter-mode-match-standard-and-data = 3
  • filter-mode-match-extended = 4
tinkerforge call can-bricklet <uid> get-read-filter
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • mask – Typ: Int, Wertebereich: [0 bis 1073741823]
  • filter1 – Typ: Int, Wertebereich: [0 bis 1073741823]
  • filter2 – Typ: Int, Wertebereich: [0 bis 1073741823]

Gibt die Lesefilter zurück, wie von set-read-filter gesetzt.

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

Für mode:

  • filter-mode-disabled = 0
  • filter-mode-accept-all = 1
  • filter-mode-match-standard = 2
  • filter-mode-match-standard-and-data = 3
  • filter-mode-match-extended = 4
tinkerforge call can-bricklet <uid> get-error-log
Ausgabe:
  • write-error-level – Typ: Int, Wertebereich: [0 bis 255]
  • read-error-level – Typ: Int, Wertebereich: [0 bis 255]
  • transceiver-disabled – Typ: Bool
  • write-timeout-count – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • read-register-overflow-count – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • read-buffer-overflow-count – Typ: Int, Wertebereich: [0 bis 232 - 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 frame-read Callbacks stellt sicher, dass der Lese-Buffer nicht überlaufen kann.
tinkerforge call can-bricklet <uid> get-identity
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connected-uid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: [a bis h, i, z]
  • hardware-version – Typ: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • firmware-version – Typ: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • device-identifier – Typ: Int, Wertebereich: [0 bis 216 - 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

tinkerforge call can-bricklet <uid> enable-frame-read-callback
Ausgabe:
  • keine Ausgabe

Aktiviert den frame-read Callback.

Standardmäßig ist der Callback deaktiviert.

tinkerforge call can-bricklet <uid> disable-frame-read-callback
Ausgabe:
  • keine Ausgabe

Deaktiviert den frame-read Callback.

Standardmäßig ist der Callback deaktiviert.

tinkerforge call can-bricklet <uid> is-frame-read-callback-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: false

Gibt true zurück falls der frame-read Callback aktiviert ist, false sonst.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch can-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

tinkerforge dispatch can-bricklet <uid> frame-read
Ausgabe:
  • frame-type – Typ: Int, Wertebereich: Siehe Symbole
  • identifier – Typ: Int, Wertebereich: [0 bis 1073741823]
  • data – Typ: Int Array, Länge: 8, Wertebereich: [0 bis 255]
  • length – Typ: Int, 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 Symbole sind für diese Funktion verfügbar:

Für frame-type:

  • frame-type-standard-data = 0
  • frame-type-standard-remote = 1
  • frame-type-extended-data = 2
  • frame-type-extended-remote = 3