Dies ist die Beschreibung der Visual Basic .NET API Bindings für den HAT Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des HAT Brick 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 | Imports System
Imports Tinkerforge
Module ExampleSleep
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XXYYZZ" ' Change XXYYZZ to the UID of your HAT Brick
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim hat As New BrickHAT(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Turn Raspberry Pi and Bricklets off in 2 seconds for 30 minutes with sleep indicator enabled
hat.SetSleepMode(2, 1800, True, True, True)
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
Download (ExamplePrintVoltages.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 | Imports System
Imports Tinkerforge
Module ExamplePrintVoltages
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XXYYZZ" ' Change XXYYZZ to the UID of your HAT Brick
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim hat As New BrickHAT(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Get current get voltages
Dim voltageUSB, voltageDC As Integer
hat.GetVoltages(voltageUSB, voltageDC)
Console.WriteLine("Voltage USB: " + (voltageUSB/1000.0).ToString() + " V")
Console.WriteLine("Voltage DC: " + (voltageDC/1000.0).ToString() + " V")
Console.WriteLine("Press key to exit")
Console.ReadLine()
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.
BrickHAT
(ByVal uid As String, ByVal ipcon As IPConnection)¶Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
Dim hat As New BrickHAT("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickHAT.
SetSleepMode
(ByVal powerOffDelay As Long, ByVal powerOffDuration As Long, ByVal raspberryPiOff As Boolean, ByVal brickletsOff As Boolean, ByVal enableSleepIndicator As Boolean)¶Parameter: |
|
---|
Setzt den Schlaf-Modus.
Bemerkung
Diese Funktion schaltet die Stromversorgung des Raspberry Pis nach Power Off Delay Sekunden ab. Das Betriebssystem muss manuell heruntergefahren werden, zum Beispiel durch Ausführen von 'sudo shutdown -h now'.
Parameter:
Beispiel: Um den RPi und die Bricklets in 5 Sekunden für 10 Minuten mit aktivierter Status-LED auszuschalten, rufe (5, 60*10, true, true, true) auf.
Diese Funktion kann auch genutzt werden um einen Watchdog zu implementieren. Dazu kann ein Programm geschrieben werden, welches in einer Schleife einmal pro Sekunde folgendes aufruft: (10, 2, true, false, false). Dies führt dazu, dass das HAT den RPi nach 10 Sekunden neustartet, wenn dieser abgestürzt oder stecken geblieben ist.
BrickHAT.
GetSleepMode
(ByRef powerOffDelay As Long, ByRef powerOffDuration As Long, ByRef raspberryPiOff As Boolean, ByRef brickletsOff As Boolean, ByRef enableSleepIndicator As Boolean)¶Ausgabeparameter: |
|
---|
Gibt die Sleep-Mode-Einstellungen zurück, wie von SetSleepMode()
gesetzt.
BrickHAT.
SetBrickletPower
(ByVal brickletPower As Boolean)¶Parameter: |
|
---|
Kann auf true/false gesetzt werden um die Spannungsversorgung der angeschlossenen Bricklets an/aus zu stellen.
BrickHAT.
GetBrickletPower
() As Boolean¶Rückgabe: |
|
---|
Gibt den Status der Stromversorgung der angeschlossenen Bricklets zurück, wie von
SetBrickletPower()
gesetzt.
BrickHAT.
GetVoltages
(ByRef voltageUSB As Integer, ByRef voltageDC As Integer)¶Ausgabeparameter: |
|
---|
Gibt die USB- und DC-Input-Versorgungsspannung zurück.
Es gibt drei mögliche Kombinationen:
BrickHAT.
SetRTCDriver
(ByVal rtcDriver As Byte)¶Parameter: |
|
---|
Konfiguriert den RTC-Treiber der dem Raspberry Pi zur Nutzung gegeben wird. Aktuell werden zwei unterschiedliche RTCs verbaut:
Der korrekte Treiber wird während dem ersten Flashens von Tinkerforge gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rtcDriver:
Neu in Version 2.0.3 (Firmware).
BrickHAT.
GetRTCDriver
() As Byte¶Rückgabe: |
|
---|
Gibt den RTC-Treiber zurück, wie von SetRTCDriver()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rtcDriver:
Neu in Version 2.0.3 (Firmware).
BrickHAT.
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.
BrickHAT.
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:
BrickHAT.
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:
BrickHAT.
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.
BrickHAT.
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.
BrickHAT.
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 HAT verbunden ist (typischerweise '0' da das HAT das Wurzelgerät der Topologie ist), die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Der HAT (Zero) Brick ist immer an Position 'i'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.
BrickHAT.
SetVoltagesCallbackConfiguration
(ByVal period As Long, ByVal valueHasToChange As Boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der VoltagesCallback
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.
Neu in Version 2.0.1 (Firmware).
BrickHAT.
GetVoltagesCallbackConfiguration
(ByRef period As Long, ByRef valueHasToChange As Boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
SetVoltagesCallbackConfiguration()
gesetzt.
Neu in Version 2.0.1 (Firmware).
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 BrickHAT, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler hat.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.
BrickHAT.
VoltagesCallback
(ByVal sender As BrickHAT, ByVal voltageUSB As Integer, ByVal voltageDC As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
SetVoltagesCallbackConfiguration()
gesetzten Konfiguration
Die Parameter sind der gleiche wie GetVoltages()
.
Neu in Version 2.0.1 (Firmware).
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.
BrickHAT.
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.
BrickHAT.
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:
BrickHAT.
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:
BrickHAT.
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.
BrickHAT.
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:
BrickHAT.
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:
BrickHAT.
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.
BrickHAT.
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.
BrickHAT.
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.
BrickHAT.
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.
BrickHAT.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um einen HAT Brick 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.
BrickHAT.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines HAT Brick dar.