Dies ist die Beschreibung der Visual Basic .NET 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 Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 50 51 52 53 54 55 56 57 58 59 60 61 62 | Imports System
Imports Tinkerforge
Module ExampleLoopback
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your CAN Bricklet 2.0
' Callback subroutine for frame read callback
Sub FrameReadCB(ByVal sender As BrickletCANV2, ByVal frameType As Byte, _
ByVal identifier As Long, ByVal data As Byte())
If frameType = BrickletCANV2.FRAME_TYPE_STANDARD_DATA Then
Console.WriteLine("Frame Type: Standard Data")
Else If frameType = BrickletCANV2.FRAME_TYPE_STANDARD_REMOTE Then
Console.WriteLine("Frame Type: Standard Remote")
Else If frameType = BrickletCANV2.FRAME_TYPE_EXTENDED_DATA Then
Console.WriteLine("Frame Type: Extended Data")
Else If frameType = BrickletCANV2.FRAME_TYPE_EXTENDED_REMOTE Then
Console.WriteLine("Frame Type: Extended Remote")
End If
Console.WriteLine("Identifier: " + identifier.ToString())
Console.Write("Data (Length: " + data.Length.ToString() + "):")
Dim i As Integer
For i = 0 To Math.Min(data.Length - 1, 7)
Console.Write(" " + data(i).ToString())
Next i
Console.WriteLine("")
Console.WriteLine("")
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim can As New 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.SetTransceiverConfiguration(1000000, 625, _
BrickletCANV2.TRANSCEIVER_MODE_LOOPBACK)
' Register frame read callback to subroutine FrameReadCB
AddHandler can.FrameReadCallback, AddressOf FrameReadCB
' Enable frame read callback
can.SetFrameReadCallbackConfiguration(True)
' Write standard data frame with identifier 1742 and 3 bytes of data
can.WriteFrame(BrickletCANV2.FRAME_TYPE_STANDARD_DATA, 1742, _
new Byte(){42, 23, 17})
Console.WriteLine("Press key to exit")
Console.ReadLine()
can.SetFrameReadCallbackConfiguration(False)
ipcon.Disconnect()
End Sub
End Module
|
Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das
ByRef
Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.
Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.
BrickletCANV2
(ByVal uid As String, ByVal ipcon As IPConnection)¶Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
Dim canV2 As New BrickletCANV2("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletCANV2.
WriteFrame
(ByVal frameType As Byte, ByVal identifier As Long, ByVal data() As Byte) As Boolean¶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
SetQueueConfiguration()
).
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 SetTransceiverConfiguration()
).
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 GetErrorLog()
).
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für frameType:
BrickletCANV2.
ReadFrame
(ByRef success As Boolean, ByRef frameType As Byte, ByRef identifier As Long, ByRef data() As Byte)¶Ausgabeparameter: |
|
---|
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 WriteFrame()
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 SetReadFilterConfiguration()
).
Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen.
Siehe die SetFrameReadCallbackConfiguration()
Funktion und den
FrameReadCallback
Callback.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für frameType:
BrickletCANV2.
SetTransceiverConfiguration
(ByVal baudRate As Long, ByVal samplePoint As Integer, ByVal transceiverMode As Byte)¶Parameter: |
|
---|
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 transceiverMode:
BrickletCANV2.
GetTransceiverConfiguration
(ByRef baudRate As Long, ByRef samplePoint As Integer, ByRef transceiverMode As Byte)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetTransceiverConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für transceiverMode:
BrickletCANV2.
SetQueueConfiguration
(ByVal writeBufferSize As Byte, ByVal writeBufferTimeout As Integer, ByVal writeBacklogSize As Integer, ByVal readBufferSizes() As Short, ByVal readBacklogSize As Integer)¶Parameter: |
|
---|
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.
WriteFrame()
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 WriteFrame()
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. ReadFrame()
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 ReadFrame()
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
SetReadFilterConfiguration()
).
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.
GetQueueConfiguration
(ByRef writeBufferSize As Byte, ByRef writeBufferTimeout As Integer, ByRef writeBacklogSize As Integer, ByRef readBufferSizes() As Short, ByRef readBacklogSize As Integer)¶Ausgabeparameter: |
|
---|
Gibt die Queue-Konfiguration zurück, wie von SetQueueConfiguration()
gesetzt.
BrickletCANV2.
SetReadFilterConfiguration
(ByVal bufferIndex As Byte, ByVal filterMode As Byte, ByVal filterMask As Long, ByVal filterIdentifier As Long)¶Parameter: |
|
---|
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
SetQueueConfiguration()
) 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 filterMode:
BrickletCANV2.
GetReadFilterConfiguration
(ByVal bufferIndex As Byte, ByRef filterMode As Byte, ByRef filterMask As Long, ByRef filterIdentifier As Long)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Gibt die Lese-Filter-Konfiguration zurück, wie von SetReadFilterConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für filterMode:
BrickletCANV2.
GetErrorLog
(ByRef transceiverState As Byte, ByRef transceiverWriteErrorLevel As Byte, ByRef transceiverReadErrorLevel As Byte, ByRef transceiverStuffingErrorCount As Long, ByRef transceiverFormatErrorCount As Long, ByRef transceiverACKErrorCount As Long, ByRef transceiverBit1ErrorCount As Long, ByRef transceiverBit0ErrorCount As Long, ByRef transceiverCRCErrorCount As Long, ByRef writeBufferTimeoutErrorCount As Long, ByRef readBufferOverflowErrorCount As Long, ByRef readBufferOverflowErrorOccurred() As Boolean, ByRef readBacklogOverflowErrorCount As Long)¶Ausgabeparameter: |
|
---|
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:
SetQueueConfiguration()
).SetReadFilterConfiguration()
) 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.ReadFrame()
Funktion aus dem Lese-Backlog entnommen werden. Die Verwendung des
FrameReadCallback
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 transceiverState:
BrickletCANV2.
SetCommunicationLEDConfig
(ByVal config As Byte)¶Parameter: |
|
---|
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.
GetCommunicationLEDConfig
() As Byte¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetCommunicationLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
SetErrorLEDConfig
(ByVal config As Byte)¶Parameter: |
|
---|
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 GetErrorLog()
). 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.
GetErrorLEDConfig
() As Byte¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetErrorLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
GetSPITFPErrorCount
(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶Ausgabeparameter: |
|
---|
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.
SetStatusLEDConfig
(ByVal config As Byte)¶Parameter: |
|
---|
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.
GetStatusLEDConfig
() As Byte¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletCANV2.
GetChipTemperature
() As Short¶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
()¶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.
GetIdentity
(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶Ausgabeparameter: |
|
---|
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.
SetFrameReadCallbackConfiguration
(ByVal enabled As Boolean)¶Parameter: |
|
---|
Aktiviert und deaktiviert den FrameReadCallback
Callback.
Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der FrameReadableCallback
Callback deaktiviert.
BrickletCANV2.
GetFrameReadCallbackConfiguration
() As Boolean¶Rückgabe: |
|
---|
Gibt true zurück falls der FrameReadCallback
Callback aktiviert ist, false
sonst.
BrickletCANV2.
SetFrameReadableCallbackConfiguration
(ByVal enabled As Boolean)¶Parameter: |
|
---|
Aktiviert und deaktiviert den FrameReadableCallback
Callback.
Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der FrameReadCallback
Callback deaktiviert.
Neu in Version 2.0.3 (Plugin).
BrickletCANV2.
GetFrameReadableCallbackConfiguration
() As Boolean¶Rückgabe: |
|
---|
Gibt true zurück falls der FrameReadableCallback
Callback aktiviert ist, false
sonst.
Neu in Version 2.0.3 (Plugin).
BrickletCANV2.
SetErrorOccurredCallbackConfiguration
(ByVal enabled As Boolean)¶Parameter: |
|
---|
Aktiviert und deaktiviert den ErrorOccurredCallback
Callback.
Standardmäßig ist der Callback deaktiviert.
Neu in Version 2.0.3 (Plugin).
BrickletCANV2.
GetErrorOccurredCallbackConfiguration
() As Boolean¶Rückgabe: |
|
---|
Gibt true zurück falls der ErrorOccurredCallback
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 erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:
Sub MyCallback(ByVal sender As BrickletCANV2, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler canV2.ExampleCallback, AddressOf MyCallback
Die verfügbaren Callback Properties und ihre Parametertypen 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.
FrameReadCallback
(ByVal sender As BrickletCANV2, ByVal frameType As Byte, ByVal identifier As Long, ByVal data() As Byte)¶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 WriteFrame()
beschriebenen
Format.
Für Details zum data
Rückgabewerte siehe ReadFrame()
.
Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames
vom CAN-Transceiver überhaupt empfangen und im Lese-Queue abgelegt werden
sollen (siehe SetReadFilterConfiguration()
).
Dieser Callback kann durch SetFrameReadCallbackConfiguration()
aktiviert werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit Nothing für data ausgelöst.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für frameType:
BrickletCANV2.
FrameReadableCallback
(ByVal sender As BrickletCANV2)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom
CAN-Transceiver empfangen wurde. Der empfangene Frame kann mit ReadFrame()
ausgelesen werden. Falls weitere Frames empfangen werden, bevor ReadFrame()
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 SetReadFilterConfiguration()
).
Dieser Callback kann durch SetFrameReadableCallbackConfiguration()
aktiviert werden.
Neu in Version 2.0.3 (Plugin).
BrickletCANV2.
ErrorOccurredCallback
(ByVal sender As BrickletCANV2)¶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 GetErrorLog()
aufgerufen wird. Diese Funktion liefert Details
über aufgetretene Fehler.
Dieser Callback kann durch SetErrorOccurredCallbackConfiguration()
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.
GetAPIVersion
() As Byte()¶Ausgabeparameter: |
|
---|
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.
GetResponseExpected
(ByVal functionId As Byte) As Boolean¶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 SetResponseExpected()
. 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 functionId:
BrickletCANV2.
SetResponseExpected
(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ä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 functionId:
BrickletCANV2.
SetResponseExpectedAll
(ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ä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.
SetBootloaderMode
(ByVal mode As Byte) As Byte¶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.
GetBootloaderMode
() As Byte¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletCANV2.
SetWriteFirmwarePointer
(ByVal pointer As Long)¶Parameter: |
|
---|
Setzt den Firmware-Pointer für WriteFirmware()
. 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.
WriteFirmware
(ByVal data() As Byte) As Byte¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
SetWriteFirmwarePointer()
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.
WriteUID
(ByVal uid As Long)¶Parameter: |
|
---|
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.
ReadUID
() As Long¶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 GetIdentity()
Funktion und der
IPConnection.EnumerateCallback
Callback der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletCANV2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines CAN Bricklet 2.0 dar.