Visual Basic .NET - HAT Brick

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Sleep

Download (ExampleSleep.vb)

 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

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 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 (siehe Beispiele oben).

Sub BrickHAT.SetSleepMode(ByVal powerOffDelay As Long, ByVal powerOffDuration As Long, ByVal raspberryPiOff As Boolean, ByVal brickletsOff As Boolean, ByVal enableSleepIndicator As Boolean)

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:

  • Power Off Delay: Zeit in Sekunden bis der RPi/die Bricklets ausgeschaltet werden.
  • Power Off Duration: Dauer in Sekunden für die der RPi/die Bricklets ausgeschaltet bleiben.
  • Raspberry Pi Off: RPi wird ausgeschaltet, falls auf true gesetzt.
  • Bricklets Off: Bricklets werden ausgeschaltet falls auf true gesetzt.
  • Enable Sleep Indicator: Wenn dieser Parameter auf true gesetzt wird, blinkt die Status LED während der Schlafdauer mit einem Intervall von 1s. Dies verbraucht zusätzliche 0,3mA.

Beispiel: Um den RPi und die Bricklets in 5 Sekunden für 10 Minuten mit aktivierter Indicator-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.

Sub BrickHAT.GetSleepMode(ByRef powerOffDelay As Long, ByRef powerOffDuration As Long, ByRef raspberryPiOff As Boolean, ByRef brickletsOff As Boolean, ByRef enableSleepIndicator As Boolean)

Gibt die Sleep-Mode-Einstellungen zurück, wie von SetSleepMode() gesetzt.

Sub BrickHAT.SetBrickletPower(ByVal brickletPower As Boolean)

Kann auf true/false gesetzt werden um die Spannungsversorgung der angeschlossenen Bricklets an/aus zu stellen.

Standardmäßig sind die Bricklets an.

Function BrickHAT.GetBrickletPower() As Boolean

Gibt den Status der Stromversorgung der angeschlossenen Bricklets zurück, wie von SetBrickletPower() gesetzt.

Sub BrickHAT.GetVoltages(ByRef voltageUSB As Integer, ByRef voltageDC As Integer)

Gibt die USB- und DC-Input-Versorgungsspannung in mV zurück.

Es gibt drei mögliche Kombinationen:

  • Nur USB verbunden: Die USB-Versorgungsspannung wird auf den DC-Input-Stecker zurückgespeist. Die USB-Spannung wird angezeigt und die DC-Input-Spannung ist etwas niedriger als die USB-Spannung.
  • Nur DC-Input verbunden: Die DC-Versorgungsspannung wird nicht auf den USB-Stecker zurückgespeist. Die DC-Versorgungsspannung wird angezeigt und die USB-Spannung ist 0.
  • USB und DC-Input verbunden: Beide Spannungen werden angezeigt. In diesem Fall ist die USB-Versorgungsspannung ohne Last, sie wird als Backup verwendet wenn der DC-Input getrennt wird (oder die DC-Input-Versorgungsspannung unter die USB-Spannung fällt).

Fortgeschrittene Funktionen

Function BrickHAT.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 BrickHAT.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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickHAT.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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickHAT.FUNCTION_SET_SLEEP_MODE = 1
  • BrickHAT.FUNCTION_SET_BRICKLET_POWER = 3
  • BrickHAT.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickHAT.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickHAT.FUNCTION_RESET = 243
  • BrickHAT.FUNCTION_WRITE_UID = 248
Sub BrickHAT.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickHAT.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 BrickHAT.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:

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

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

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

  • BrickHAT.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickHAT.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickHAT.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickHAT.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickHAT.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickHAT.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 BrickHAT.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 BrickHAT.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:

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

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

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

  • BrickHAT.STATUS_LED_CONFIG_OFF = 0
  • BrickHAT.STATUS_LED_CONFIG_ON = 1
  • BrickHAT.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickHAT.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickHAT.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 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.

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

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

Konstanten

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

Const BrickHAT.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines HAT Brick dar.