Visual Basic .NET - Isolator Bricklet

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

Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Isolator Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim i As New BrickletIsolator(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Get current statistics
        Dim messagesFromBrick, messagesFromBricklet As Long
        Dim connectedBrickletDeviceIdentifier As Integer
        Dim connectedBrickletUID As String

        i.GetStatistics(messagesFromBrick, messagesFromBricklet, _
                        connectedBrickletDeviceIdentifier, connectedBrickletUID)

        Console.WriteLine("Messages From Brick: " + messagesFromBrick.ToString())
        Console.WriteLine("Messages From Bricklet: " + messagesFromBricklet.ToString())
        Console.WriteLine("Connected Bricklet Device Identifier: " + connectedBrickletDeviceIdentifier.ToString())
        Console.WriteLine("Connected Bricklet UID: " + connectedBrickletUID)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

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.

Grundfunktionen

Class BrickletIsolator(ByVal uid As String, ByVal ipcon As IPConnection)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

Dim isolator As New BrickletIsolator("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Sub BrickletIsolator.GetStatistics(ByRef messagesFromBrick As Long, ByRef messagesFromBricklet As Long, ByRef connectedBrickletDeviceIdentifier As Integer, ByRef connectedBrickletUID As String)

Gibt Statistken des Isolator Bricklets zurück.

Fortgeschrittene Funktionen

Sub BrickletIsolator.SetSPITFPBaudrateConfig(ByVal enableDynamicBaudrate As Boolean, ByVal minimumDynamicBaudrate As Long)

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht das Isolator Bricklet die Baudrate anhand des Datenaufkommens zwischen Isolator Bricklet und Bricklet anzupassen.

Die Baudratenkonfiguration für die Kommunikation zwischen Brick und Isolator Bricklet kann in der API des Bricks eingestellt werden.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion SetSPITFPBaudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von SetSPITFPBaudrate() gesetzt statisch verwendet.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Sub BrickletIsolator.GetSPITFPBaudrateConfig(ByRef enableDynamicBaudrate As Boolean, ByRef minimumDynamicBaudrate As Long)

Gibt die Baudratenkonfiguration zurück, siehe SetSPITFPBaudrateConfig().

Sub BrickletIsolator.SetSPITFPBaudrate(ByVal baudrate As Long)

Setzt die Baudrate für die Kommunikation zwischen Isolator Bricklet und angeschlossenem Bricklet. Die Baudrate für die Kommunikation zwischen Brick und Isolator Bricklet kann in der API des Bricks eingestellt werden.

Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe GetSPITFPErrorCount()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe SetSPITFPBaudrateConfig()).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Die Standardbaudrate für alle Ports ist 1400000.

Function BrickletIsolator.GetSPITFPBaudrate() As Long

Gibt die Baudrate zurück, siehe SetSPITFPBaudrate().

Sub BrickletIsolator.GetIsolatorSPITFPErrorCount(ByRef errorCountACKChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Isolator Bricklet und Bricklet aufgetreten sind zurück. Rufe GetSPITFPErrorCount() um die Anzahl der Fehler zwischen Isolator Bricklet und Brick zu bekommen.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.
Function BrickletIsolator.GetAPIVersion() As Byte()

Gibt die Version der API Definition (Major, Minor, Revision) 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.

Function BrickletIsolator.GetResponseExpected(ByVal functionId As Byte) As Boolean

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:

  • BrickletIsolator.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
  • BrickletIsolator.FUNCTION_SET_SPITFP_BAUDRATE = 4
  • BrickletIsolator.FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION = 7
  • BrickletIsolator.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIsolator.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIsolator.FUNCTION_RESET = 243
  • BrickletIsolator.FUNCTION_WRITE_UID = 248
Sub BrickletIsolator.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)

Ä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:

  • BrickletIsolator.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
  • BrickletIsolator.FUNCTION_SET_SPITFP_BAUDRATE = 4
  • BrickletIsolator.FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION = 7
  • BrickletIsolator.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIsolator.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIsolator.FUNCTION_RESET = 243
  • BrickletIsolator.FUNCTION_WRITE_UID = 248
Sub BrickletIsolator.SetResponseExpectedAll(ByVal responseExpected As Boolean)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Sub BrickletIsolator.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)

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.

Function BrickletIsolator.SetBootloaderMode(ByVal mode As Byte) As Byte

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 Bootlodaer- 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:

  • BrickletIsolator.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIsolator.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIsolator.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIsolator.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIsolator.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletIsolator.BOOTLOADER_STATUS_OK = 0
  • BrickletIsolator.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIsolator.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIsolator.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIsolator.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIsolator.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletIsolator.GetBootloaderMode() As Byte

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

  • BrickletIsolator.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIsolator.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIsolator.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIsolator.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIsolator.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletIsolator.SetWriteFirmwarePointer(ByVal pointer As Long)

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.

Function BrickletIsolator.WriteFirmware(ByVal data() As Byte) As Byte

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.

Sub BrickletIsolator.SetStatusLEDConfig(ByVal config As Byte)

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:

  • BrickletIsolator.STATUS_LED_CONFIG_OFF = 0
  • BrickletIsolator.STATUS_LED_CONFIG_ON = 1
  • BrickletIsolator.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIsolator.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletIsolator.GetStatusLEDConfig() As Byte

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

  • BrickletIsolator.STATUS_LED_CONFIG_OFF = 0
  • BrickletIsolator.STATUS_LED_CONFIG_ON = 1
  • BrickletIsolator.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIsolator.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletIsolator.GetChipTemperature() As Short

Gibt die Temperatur in °C, 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.

Sub BrickletIsolator.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.

Sub BrickletIsolator.WriteUID(ByVal uid As Long)

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.

Function BrickletIsolator.ReadUID() As Long

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

Sub BrickletIsolator.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)

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

Sub BrickletIsolator.SetStatisticsCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)

Die Periode in ms ist die Periode mit der der StatisticsCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Der Standardwert ist (0, false).

Neu in Version 2.0.2 (Plugin).

Sub BrickletIsolator.GetStatisticsCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)

Gibt die Callback-Konfiguration zurück, wie mittels SetStatisticsCallbackConfiguration() gesetzt.

Neu in Version 2.0.2 (Plugin).

Callbacks

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 BrickletIsolator, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler isolator.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.

Event BrickletIsolator.StatisticsCallback(ByVal sender As BrickletIsolator, ByVal messagesFromBrick As Long, ByVal messagesFromBricklet As Long, ByVal connectedBrickletDeviceIdentifier As Integer, ByVal connectedBrickletUID As String)

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetStatisticsCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der gleiche wie GetStatistics().

Neu in Version 2.0.2 (Plugin).

Konstanten

Const BrickletIsolator.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Isolator Bricklet 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.

Const BrickletIsolator.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Isolator Bricklet dar.