MQTT - CAN Bricklet 2.0

Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

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 2.0

setup:
    # Configure transceiver for loopback mode
    publish '{"baud_rate": 1000000, "sample_point": 625, "transceiver_mode": "loopback"}' to tinkerforge/request/can_v2_bricklet/XYZ/set_transceiver_configuration

    # Handle incoming frame read callbacks
    subscribe to tinkerforge/callback/can_v2_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 == "standard_data"
                print "Frame Type: Standard Data"
            elseif frame_type == "standard_remote"
                print "Frame Type: Standard Remote"
            elseif frame_type == "extended_data"
                print "Frame Type: Extended Remote"
            elseif frame_type == "extended_remote"
                print "Frame Type: Extended Remote"
            endif

            print "Identifier: " + identifier
            print "Data: " + data
            print "\n"
        endif
    endsubscribe

    publish '{"register": true}' to tinkerforge/register/can_v2_bricklet/XYZ/frame_read # Register frame_read callback

    # Enable frame read callback
    publish '{"enabled": true}' to tinkerforge/request/can_v2_bricklet/XYZ/set_frame_read_callback_configuration

    # Write standard data frame with identifier 1742 and 3 bytes of data
    publish '{"frame_type": "standard_data", "identifier": 1742, "data": [42,23,17]}' to tinkerforge/request/can_v2_bricklet/XYZ/write_frame

cleanup:
    # If you are done, run this to clean up
    publish '{"enabled": false}' to tinkerforge/request/can_v2_bricklet/XYZ/set_frame_read_callback_configuration

API

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/....

Grundfunktionen

request/can_v2_bricklet/<UID>/write_frame
Anfrage:
  • frame_type – Typ: int, Wertebereich: Siehe Symbole
  • identifier – Typ: int, Wertebereich: [0 bis 230 - 1]
  • data – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]
Antwort:
  • success – Typ: bool

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 request/can_v2_bricklet/<UID>/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 request/can_v2_bricklet/<UID>/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 request/can_v2_bricklet/<UID>/get_error_log).

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

Für frame_type:

  • "standard_data" = 0
  • "standard_remote" = 1
  • "extended_data" = 2
  • "extended_remote" = 3
request/can_v2_bricklet/<UID>/read_frame
Anfrage:
  • keine Nutzdaten
Antwort:
  • success – Typ: bool
  • frame_type – Typ: int, Wertebereich: Siehe Symbole
  • identifier – Typ: int, Wertebereich: [0 bis 230 - 1]
  • data – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]

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 request/can_v2_bricklet/<UID>/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 request/can_v2_bricklet/<UID>/set_read_filter_configuration).

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe die request/can_v2_bricklet/<UID>/set_frame_read_callback_configuration Funktion und den register/can_v2_bricklet/<UID>/frame_read Callback.

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

Für frame_type:

  • "standard_data" = 0
  • "standard_remote" = 1
  • "extended_data" = 2
  • "extended_remote" = 3
request/can_v2_bricklet/<UID>/set_transceiver_configuration
Anfrage:
  • baud_rate – Typ: int, Einheit: 1 bit/s, Wertebereich: [10000 bis 1000000], Standardwert: 125000
  • sample_point – Typ: int, Einheit: 1/10 %, Wertebereich: [500 bis 900], Standardwert: 625
  • transceiver_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:
  • keine Antwort

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

Für transceiver_mode:

  • "normal" = 0
  • "loopback" = 1
  • "read_only" = 2
request/can_v2_bricklet/<UID>/get_transceiver_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • baud_rate – Typ: int, Einheit: 1 bit/s, Wertebereich: [10000 bis 1000000], Standardwert: 125000
  • sample_point – Typ: int, Einheit: 1/10 %, Wertebereich: [500 bis 900], Standardwert: 625
  • transceiver_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von request/can_v2_bricklet/<UID>/set_transceiver_configuration gesetzt.

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

Für transceiver_mode:

  • "normal" = 0
  • "loopback" = 1
  • "read_only" = 2

Fortgeschrittene Funktionen

request/can_v2_bricklet/<UID>/set_queue_configuration
Anfrage:
  • write_buffer_size – Typ: int, Wertebereich: [0 bis 32], Standardwert: 8
  • write_buffer_timeout – Typ: int, Wertebereich: [-1 bis 231 - 1], Standardwert: 0
  • write_backlog_size – Typ: int, Wertebereich: [0 bis 768], Standardwert: 383
  • read_buffer_sizes – Typ: [int, ...], Länge: variabel, Wertebereich: [-32 bis -1, 1 bis 32], Standardwert: [16,-8]
  • read_backlog_size – Typ: int, Wertebereich: [0 bis 768], Standardwert: 383
Antwort:
  • keine Antwort

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.

request/can_v2_bricklet/<UID>/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 request/can_v2_bricklet/<UID>/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. request/can_v2_bricklet/<UID>/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 request/can_v2_bricklet/<UID>/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 request/can_v2_bricklet/<UID>/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.

request/can_v2_bricklet/<UID>/get_queue_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • write_buffer_size – Typ: int, Wertebereich: [0 bis 32], Standardwert: 8
  • write_buffer_timeout – Typ: int, Wertebereich: [-1 bis 231 - 1], Standardwert: 0
  • write_backlog_size – Typ: int, Wertebereich: [0 bis 768], Standardwert: 383
  • read_buffer_sizes – Typ: [int, ...], Länge: variabel, Wertebereich: [-32 bis -1, 1 bis 32], Standardwert: [16,-8]
  • read_backlog_size – Typ: int, Wertebereich: [0 bis 768], Standardwert: 383

Gibt die Queue-Konfiguration zurück, wie von request/can_v2_bricklet/<UID>/set_queue_configuration gesetzt.

request/can_v2_bricklet/<UID>/set_read_filter_configuration
Anfrage:
  • buffer_index – Typ: int, Wertebereich: [0 bis 31]
  • filter_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • filter_mask – Typ: int, Wertebereich: [0 bis 230 - 1]
  • filter_identifier – Typ: int, Wertebereich: [0 bis 230 - 1]
Antwort:
  • keine Antwort

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

Für filter_mode:

  • "accept_all" = 0
  • "match_standard_only" = 1
  • "match_extended_only" = 2
  • "match_standard_and_extended" = 3
request/can_v2_bricklet/<UID>/get_read_filter_configuration
Anfrage:
  • buffer_index – Typ: int, Wertebereich: [0 bis 31]
Antwort:
  • filter_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • filter_mask – Typ: int, Wertebereich: [0 bis 230 - 1]
  • filter_identifier – Typ: int, Wertebereich: [0 bis 230 - 1]

Gibt die Lese-Filter-Konfiguration zurück, wie von request/can_v2_bricklet/<UID>/set_read_filter_configuration gesetzt.

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

Für filter_mode:

  • "accept_all" = 0
  • "match_standard_only" = 1
  • "match_extended_only" = 2
  • "match_standard_and_extended" = 3
request/can_v2_bricklet/<UID>/get_error_log
Anfrage:
  • keine Nutzdaten
Antwort:
  • transceiver_state – Typ: int, Wertebereich: Siehe Symbole
  • transceiver_write_error_level – Typ: int, Wertebereich: [0 bis 255]
  • transceiver_read_error_level – Typ: int, Wertebereich: [0 bis 255]
  • transceiver_stuffing_error_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • transceiver_format_error_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • transceiver_ack_error_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • transceiver_bit1_error_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • transceiver_bit0_error_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • transceiver_crc_error_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • write_buffer_timeout_error_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • read_buffer_overflow_error_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • read_buffer_overflow_error_occurred – Typ: [bool, ...], Länge: variabel
  • read_backlog_overflow_error_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 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 request/can_v2_bricklet/<UID>/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 request/can_v2_bricklet/<UID>/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 request/can_v2_bricklet/<UID>/read_frame Funktion aus dem Lese-Backlog entnommen werden. Die Verwendung des register/can_v2_bricklet/<UID>/frame_read 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 Symbole sind für diese Funktion verfügbar:

Für transceiver_state:

  • "active" = 0
  • "passive" = 1
  • "disabled" = 2
request/can_v2_bricklet/<UID>/set_communication_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_communication" = 3
request/can_v2_bricklet/<UID>/get_communication_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/can_v2_bricklet/<UID>/set_communication_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_communication" = 3
request/can_v2_bricklet/<UID>/set_error_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_transceiver_state" = 3
  • "show_error" = 4
request/can_v2_bricklet/<UID>/get_error_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/can_v2_bricklet/<UID>/set_error_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_transceiver_state" = 3
  • "show_error" = 4
request/can_v2_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

request/can_v2_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/can_v2_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/can_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/can_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

request/can_v2_bricklet/<UID>/reset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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.

request/can_v2_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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, ...], 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, ...], 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]
  • _display_name – Typ: string

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. 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 2.0.

Konfigurationsfunktionen für Callbacks

request/can_v2_bricklet/<UID>/set_frame_read_callback_configuration
Anfrage:
  • enabled – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Aktiviert und deaktiviert den register/can_v2_bricklet/<UID>/frame_read Callback.

Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der register/can_v2_bricklet/<UID>/frame_readable Callback deaktiviert.

request/can_v2_bricklet/<UID>/get_frame_read_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück falls der register/can_v2_bricklet/<UID>/frame_read Callback aktiviert ist, false sonst.

request/can_v2_bricklet/<UID>/set_frame_readable_callback_configuration
Anfrage:
  • enabled – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Aktiviert und deaktiviert den register/can_v2_bricklet/<UID>/frame_readable Callback.

Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der register/can_v2_bricklet/<UID>/frame_read Callback deaktiviert.

Neu in Version 2.0.3 (Plugin).

request/can_v2_bricklet/<UID>/get_frame_readable_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück falls der register/can_v2_bricklet/<UID>/frame_readable Callback aktiviert ist, false sonst.

Neu in Version 2.0.3 (Plugin).

request/can_v2_bricklet/<UID>/set_error_occurred_callback_configuration
Anfrage:
  • enabled – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Aktiviert und deaktiviert den register/can_v2_bricklet/<UID>/error_occurred Callback.

Standardmäßig ist der Callback deaktiviert.

Neu in Version 2.0.3 (Plugin).

request/can_v2_bricklet/<UID>/get_error_occurred_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück falls der register/can_v2_bricklet/<UID>/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 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_v2_bricklet/<UID>/frame_read
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • frame_type – Typ: int, Wertebereich: Siehe Symbole
  • identifier – Typ: int, Wertebereich: [0 bis 230 - 1]
  • data – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/can_v2_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_v2_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_v2_bricklet/<UID>/write_frame beschriebenen Format.

Für Details zum data Rückgabewerte siehe request/can_v2_bricklet/<UID>/read_frame.

Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames vom CAN-Transceiver überhaupt empfangen und im Lese-Queue abgelegt werden sollen (siehe request/can_v2_bricklet/<UID>/set_read_filter_configuration).

Dieser Callback kann durch request/can_v2_bricklet/<UID>/set_frame_read_callback_configuration aktiviert werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für data ausgelöst.

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

Für frame_type:

  • "standard_data" = 0
  • "standard_remote" = 1
  • "extended_data" = 2
  • "extended_remote" = 3
register/can_v2_bricklet/<UID>/frame_readable
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/can_v2_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_v2_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_v2_bricklet/<UID>/read_frame ausgelesen werden. Falls weitere Frames empfangen werden, bevor request/can_v2_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_v2_bricklet/<UID>/set_read_filter_configuration).

Dieser Callback kann durch request/can_v2_bricklet/<UID>/set_frame_readable_callback_configuration aktiviert werden.

Neu in Version 2.0.3 (Plugin).

register/can_v2_bricklet/<UID>/error_occurred
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/can_v2_bricklet/<UID>/error_occurred[/<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_v2_bricklet/<UID>/error_occurred[/<SUFFIX>]-Topic veröffentlicht.

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 request/can_v2_bricklet/<UID>/get_error_log aufgerufen wird. Diese Funktion liefert Details über aufgetretene Fehler.

Dieser Callback kann durch request/can_v2_bricklet/<UID>/set_error_occurred_callback_configuration aktiviert werden.

Neu in Version 2.0.3 (Plugin).

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.

request/can_v2_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe Symbole

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/can_v2_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/can_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/can_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/can_v2_bricklet/<UID>/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.

request/can_v2_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/can_v2_bricklet/<UID>/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.

request/can_v2_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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.

request/can_v2_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.