Dies ist die Beschreibung der Python 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 Python API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_loopback.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your CAN Bricklet 2.0
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_can_v2 import BrickletCANV2
# Callback function for frame read callback
def cb_frame_read(frame_type, identifier, data):
if frame_type == BrickletCANV2.FRAME_TYPE_STANDARD_DATA:
print("Frame Type: Standard Data")
elif frame_type == BrickletCANV2.FRAME_TYPE_STANDARD_REMOTE:
print("Frame Type: Standard Remote")
elif frame_type == BrickletCANV2.FRAME_TYPE_EXTENDED_DATA:
print("Frame Type: Extended Data")
elif frame_type == BrickletCANV2.FRAME_TYPE_EXTENDED_REMOTE:
print("Frame Type: Extended Remote")
print("Identifier: " + str(identifier))
print("Data (Length: " + str(len(data)) + "): " + ", ".join(map(str, data[:min(len(data), 8)])))
print("")
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
can = BrickletCANV2(UID, ipcon) # Create device object
ipcon.connect(HOST, PORT) # Connect to brickd
# Don't use device before ipcon is connected
# Configure transceiver for loopback mode
can.set_transceiver_configuration(1000000, 625, can.TRANSCEIVER_MODE_LOOPBACK)
# Register frame read callback to function cb_frame_read
can.register_callback(can.CALLBACK_FRAME_READ, cb_frame_read)
# Enable frame read callback
can.set_frame_read_callback_configuration(True)
# Write standard data frame with identifier 1742 and 3 bytes of data
can.write_frame(can.FRAME_TYPE_STANDARD_DATA, 1742, [42, 23, 17])
input("Press key to exit\n") # Use raw_input() in Python 2
can.set_frame_read_callback_configuration(False)
ipcon.disconnect()
|
Prinzipiell kann jede Funktion der Python Bindings
tinkerforge.ip_connection.Error
Exception werfen, welche ein value
und
eine description
Property hat. value
kann verschiende Werte haben:
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletCANV2
(uid, ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
can_v2 = BrickletCANV2("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletCANV2.
write_frame
(frame_type, identifier, data)¶Parameter: |
|
---|---|
Rückgabe: |
|
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
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 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 get_error_log()
).
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für frame_type:
BrickletCANV2.
read_frame
()¶Rückgabeobjekt: |
|
---|
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 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 set_read_filter_configuration()
).
Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen.
Siehe die set_frame_read_callback_configuration()
Funktion und den
CALLBACK_FRAME_READ
Callback.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für frame_type:
BrickletCANV2.
set_transceiver_configuration
(baud_rate, sample_point, transceiver_mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Transceiver-Konfiguration für die CAN-Bus-Kommunikation.
Der CAN-Transceiver hat drei verschiedene Modi:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für transceiver_mode:
BrickletCANV2.
get_transceiver_configuration
()¶Rückgabeobjekt: |
|
---|
Gibt die Konfiguration zurück, wie von set_transceiver_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für transceiver_mode:
BrickletCANV2.
set_queue_configuration
(write_buffer_size, write_buffer_timeout, write_backlog_size, read_buffer_sizes, read_backlog_size)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
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 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. 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 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
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:
Der aktuelle Inhalt der Queues geht bei einem Aufruf dieser Funktion verloren.
BrickletCANV2.
get_queue_configuration
()¶Rückgabeobjekt: |
|
---|
Gibt die Queue-Konfiguration zurück, wie von set_queue_configuration()
gesetzt.
BrickletCANV2.
set_read_filter_configuration
(buffer_index, filter_mode, filter_mask, filter_identifier)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
Filter-Maske und Filter-Identifier werden als Bitmasken verwendet. Ihre Verwendung hängt vom Filter-Modus ab:
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
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 Konstanten sind für diese Funktion verfügbar:
Für filter_mode:
BrickletCANV2.
get_read_filter_configuration
(buffer_index)¶Parameter: |
|
---|---|
Rückgabeobjekt: |
|
Gibt die Lese-Filter-Konfiguration zurück, wie von set_read_filter_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für filter_mode:
BrickletCANV2.
get_error_log
()¶Rückgabeobjekt: |
|
---|
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:
set_queue_configuration()
).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.read_frame()
Funktion aus dem Lese-Backlog entnommen werden. Die Verwendung des
CALLBACK_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 Konstanten sind für diese Funktion verfügbar:
Für transceiver_state:
BrickletCANV2.
set_communication_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
get_communication_led_config
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set_communication_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
set_error_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 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 Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
get_error_led_config
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set_error_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
get_spitfp_error_count
()¶Rückgabeobjekt: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
BrickletCANV2.
set_status_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
get_status_led_config
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set_status_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
get_chip_temperature
()¶Rückgabe: |
|
---|
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.
BrickletCANV2.
reset
()¶Rückgabe: |
|
---|
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.
BrickletCANV2.
get_identity
()¶Rückgabeobjekt: |
|
---|
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.
BrickletCANV2.
register_callback
(callback_id, function)¶Parameter: |
|
---|---|
Rückgabe: |
|
Registriert die function
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletCANV2.
set_frame_read_callback_configuration
(enabled)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert und deaktiviert den CALLBACK_FRAME_READ
Callback.
Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der CALLBACK_FRAME_READABLE
Callback deaktiviert.
BrickletCANV2.
get_frame_read_callback_configuration
()¶Rückgabe: |
|
---|
Gibt true zurück falls der CALLBACK_FRAME_READ
Callback aktiviert ist, false
sonst.
BrickletCANV2.
set_frame_readable_callback_configuration
(enabled)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert und 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.3 (Plugin).
BrickletCANV2.
get_frame_readable_callback_configuration
()¶Rückgabe: |
|
---|
Gibt true zurück falls der CALLBACK_FRAME_READABLE
Callback aktiviert ist, false
sonst.
Neu in Version 2.0.3 (Plugin).
BrickletCANV2.
set_error_occurred_callback_configuration
(enabled)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert und deaktiviert den CALLBACK_ERROR_OCCURRED
Callback.
Standardmäßig ist der Callback deaktiviert.
Neu in Version 2.0.3 (Plugin).
BrickletCANV2.
get_error_occurred_callback_configuration
()¶Rückgabe: |
|
---|
Gibt true zurück falls der CALLBACK_ERROR_OCCURRED
Callback aktiviert ist, false
sonst.
Neu in Version 2.0.3 (Plugin).
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion register_callback()
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID
und der zweite Parameter die Callback-Funktion:
def my_callback(param):
print(param)
can_v2.register_callback(BrickletCANV2.CALLBACK_EXAMPLE, my_callback)
Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.
BrickletCANV2.
CALLBACK_FRAME_READ
¶Callback-Parameter: |
|
---|
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 Details zum data
Rückgabewerte siehe read_frame()
.
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_configuration()
).
Dieser Callback kann durch set_frame_read_callback_configuration()
aktiviert werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit None für data ausgelöst.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für frame_type:
BrickletCANV2.
CALLBACK_FRAME_READABLE
¶Callback-Parameter: |
|
---|
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_configuration()
).
Dieser Callback kann durch set_frame_readable_callback_configuration()
aktiviert werden.
Neu in Version 2.0.3 (Plugin).
BrickletCANV2.
CALLBACK_ERROR_OCCURRED
¶Callback-Parameter: |
|
---|
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 get_error_log()
aufgerufen wird. Diese Funktion liefert Details
über aufgetretene Fehler.
Dieser Callback kann durch set_error_occurred_callback_configuration()
aktiviert werden.
Neu in Version 2.0.3 (Plugin).
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.
BrickletCANV2.
get_api_version
()¶Rückgabeobjekt: |
|
---|
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.
BrickletCANV2.
get_response_expected
(function_id)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 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:
BrickletCANV2.
set_response_expected
(function_id, response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
BrickletCANV2.
set_response_expected_all
(response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
BrickletCANV2.
set_bootloader_mode
(mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletCANV2.
get_bootloader_mode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletCANV2.
set_write_firmware_pointer
(pointer)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Firmware-Pointer für 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.
BrickletCANV2.
write_firmware
(data)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
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.
BrickletCANV2.
write_uid
(uid)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickletCANV2.
read_uid
()¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletCANV2.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein CAN Bricklet 2.0 zu identifizieren.
Die get_identity()
Funktion und der
IPConnection.CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletCANV2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines CAN Bricklet 2.0 dar.