Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example-loopback.txt)
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 | # Change XYZ to the UID of your CAN Bricklet
setup:
# Configure transceiver for loopback mode
publish '{"baud_rate": "1000kbps", "transceiver_mode": "loopback", "write_timeout": 0}' to tinkerforge/request/can_bricklet/XYZ/set_configuration
# Handle incoming frame read callbacks
subscribe to tinkerforge/callback/can_bricklet/XYZ/frame_read
if a message arrives:
# message contains frame_type as int with symbols, identifier as int and data as int array
if frame_type == "StandardData"
print "Frame Type: Standard Data"
elseif frame_type == "StandardRemote"
print "Frame Type: Standard Remote"
elseif frame_type == "ExtendedData"
print "Frame Type: Extended Remote"
elseif frame_type == "ExtendedRemote"
print "Frame Type: Extended Remote"
endif
print "Identifier: " + identifier
print "Data: " + data
print "\n"
endif
endsubscribe
publish '{"register": true}' to tinkerforge/register/can_bricklet/XYZ/frame_read # Register frame_read callback
# Enable frame read callback
publish '' to tinkerforge/request/can_bricklet/XYZ/enable_frame_read_callback
# Write standard data frame with identifier 1742 and 3 bytes of data
publish '{"frame_type": "StandardData", "identifier": 1742, "data": [42, 23, 17, 0, 0, 0, 0, 0], "length": 3}' to tinkerforge/request/can_bricklet/XYZ/write_frame
cleanup:
# If you are done, run this to clean up
publish '' to tinkerforge/request/can_bricklet/XYZ/disable_frame_read_callback
|
Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.
Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR
-Member enthält.
Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/...
für .../request/...
und .../callback/...
für .../register/...
.
request/
can_bricklet/
<UID>/
write_frame
¶Anfrage: |
|
---|---|
Antwort: |
|
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 request/can_bricklet/<UID>/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 request/can_bricklet/<UID>/get_error_log
).
Die folgenden Symbole sind für diese Funktion verfügbar:
Für frame_type:
request/
can_bricklet/
<UID>/
read_frame
¶Anfrage: |
|
---|---|
Antwort: |
|
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 request/can_bricklet/<UID>/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 request/can_bricklet/<UID>/set_read_filter
).
Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen.
Siehe die request/can_bricklet/<UID>/enable_frame_read_callback
Funktion und den register/can_bricklet/<UID>/frame_read
Callback.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für frame_type:
request/
can_bricklet/
<UID>/
set_configuration
¶Anfrage: |
|
---|---|
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:
Der Schreib-Timeout hat drei verschiedene Modi, die festlegen wie mit einer fehlgeschlagen Frame-Übertragung umgegangen werden soll:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für baud_rate:
Für transceiver_mode:
request/
can_bricklet/
<UID>/
get_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/can_bricklet/<UID>/set_configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für baud_rate:
Für transceiver_mode:
request/
can_bricklet/
<UID>/
set_read_filter
¶Anfrage: |
|
---|---|
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:
Maske und Filter werden als Bitmasken verwendet. Ihre Verwendung hängt vom Modus ab:
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:
request/
can_bricklet/
<UID>/
get_read_filter
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Lesefilter zurück, wie von request/can_bricklet/<UID>/set_read_filter
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
can_bricklet/
<UID>/
get_error_log
¶Anfrage: |
|
---|---|
Antwort: |
|
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 request/can_bricklet/<UID>/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:
request/can_bricklet/<UID>/set_configuration
).request/can_bricklet/<UID>/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.request/can_bricklet/<UID>/read_frame
Funktion aus dem Lese-Buffer entnommen werden. Die Verwendung des
register/can_bricklet/<UID>/frame_read
Callbacks stellt sicher, dass der Lese-Buffer nicht
überlaufen kann.request/
can_bricklet/
<UID>/
get_identity
¶Anfrage: |
|
---|---|
Antwort: |
|
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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.
Der Display Name enthält den Anzeigenamen des CAN.
request/
can_bricklet/
<UID>/
enable_frame_read_callback
¶Anfrage: |
|
---|---|
Antwort: |
|
Aktiviert den register/can_bricklet/<UID>/frame_read
Callback.
Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der register/can_bricklet/<UID>/frame_readable
Callback deaktiviert.
request/
can_bricklet/
<UID>/
disable_frame_read_callback
¶Anfrage: |
|
---|---|
Antwort: |
|
Deaktiviert den register/can_bricklet/<UID>/frame_read
Callback.
Standardmäßig ist der Callback deaktiviert.
request/
can_bricklet/
<UID>/
is_frame_read_callback_enabled
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt true zurück falls der register/can_bricklet/<UID>/frame_read
Callback aktiviert ist, false
sonst.
request/
can_bricklet/
<UID>/
set_frame_readable_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Aktiviert/deaktiviert den register/can_bricklet/<UID>/frame_readable
Callback.
Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der register/can_bricklet/<UID>/frame_read
Callback deaktiviert.
Neu in Version 2.0.1 (Plugin).
request/
can_bricklet/
<UID>/
get_frame_readable_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt true zurück falls der register/can_bricklet/<UID>/frame_readable
Callback aktiviert ist, false
sonst.
Neu in Version 2.0.1 (Plugin).
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit dem entsprechenden .../register/...
-Topic und einem optionalen Suffix durchgeführt werden.
Mit diesem Suffix kann das Callback später deregistriert werden.
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.
register/
can_bricklet/
<UID>/
frame_read
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/can_bricklet/<UID>/frame_read[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/can_bricklet/<UID>/frame_read[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom CAN-Transceiver empfangen wurde.
Der identifier
Rückgabewerte folgt dem für request/can_bricklet/<UID>/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
request/can_bricklet/<UID>/set_read_filter
).
Dieser Callback kann durch request/can_bricklet/<UID>/enable_frame_read_callback
aktiviert werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für frame_type:
register/
can_bricklet/
<UID>/
frame_readable
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/can_bricklet/<UID>/frame_readable[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/can_bricklet/<UID>/frame_readable[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom
CAN-Transceiver empfangen wurde. Der empfangene Frame kann mit request/can_bricklet/<UID>/read_frame
ausgelesen werden. Falls weitere Frames empfangen werden, bevor request/can_bricklet/<UID>/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 request/can_bricklet/<UID>/set_read_filter
).
Dieser Callback kann durch request/can_bricklet/<UID>/set_frame_readable_callback_configuration
aktiviert werden.
Neu in Version 2.0.1 (Plugin).