Software / API Bindings / Go / API Referenz und Beispiele / Bricks / HAT Brick

Go - HAT Brick¶

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Sleep¶

Download (example_sleep.go)

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/hat_brick"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your HAT Brick.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    hat, _ := hat_brick.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // 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)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Print Voltages¶

Download (example_print_voltages.go)

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/hat_brick"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your HAT Brick.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    hat, _ := hat_brick.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get current get voltages.
    voltageUSB, voltageDC, _ := hat.GetVoltages()

    fmt.Printf("Voltage USB: %f V\n", float64(voltageUSB)/1000.0)
    fmt.Printf("Voltage DC: %f V\n", float64(voltageDC)/1000.0)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API¶

Die API des HAT Brick ist im Package github.com/Tinkerforge/go-api-bindings/hat_brick definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

ipconnection.DeviceErrorSuccess = 0
ipconnection.DeviceErrorInvalidParameter = 1
ipconnection.DeviceErrorFunctionNotSupported = 2
ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

func hat_brick.New(uid string, ipcon *IPConnection) (device HATBrick, err error)¶

Parameter:	uid – Typ: string ipcon – Typ: *IPConnection
Rückgabe:	device – Typ: HATBrick err – Typ: error

Erzeugt ein neues HATBrick-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := hat_brick.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

func (*HATBrick) SetSleepMode(powerOffDelay uint32, powerOffDuration uint32, raspberryPiOff bool, brickletsOff bool, enableSleepIndicator bool) (err error)¶

Parameter:	powerOffDelay – Typ: uint32, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] powerOffDuration – Typ: uint32, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] raspberryPiOff – Typ: bool brickletsOff – Typ: bool enableSleepIndicator – Typ: bool
Rückgabe:	err – Typ: error

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

func (*HATBrick) GetSleepMode() (powerOffDelay uint32, powerOffDuration uint32, raspberryPiOff bool, brickletsOff bool, enableSleepIndicator bool, err error)¶

Rückgabe:	powerOffDelay – Typ: uint32, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] powerOffDuration – Typ: uint32, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] raspberryPiOff – Typ: bool brickletsOff – Typ: bool enableSleepIndicator – Typ: bool err – Typ: error

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

func (*HATBrick) SetBrickletPower(brickletPower bool) (err error)¶

Parameter:	brickletPower – Typ: bool, Standardwert: true
Rückgabe:	err – Typ: error

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

func (*HATBrick) GetBrickletPower() (brickletPower bool, err error)¶

Rückgabe:	brickletPower – Typ: bool, Standardwert: true err – Typ: error

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

func (*HATBrick) GetVoltages() (voltageUSB uint16, voltageDC uint16, err error)¶

Rückgabe:	voltageUSB – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] voltageDC – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] err – Typ: error

Gibt die USB- und DC-Input-Versorgungsspannung 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¶

func (*HATBrick) SetRTCDriver(rtcDriver uint8) (err error)¶

Parameter:	rtcDriver – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	err – Typ: error

Konfiguriert den RTC-Treiber der dem Raspberry Pi zur Nutzung gegeben wird. Aktuell werden zwei unterschiedliche RTCs verbaut:

Hardwareversion <= 1.5: PCF8523
Hardwareversion 1.6: DS1338

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:

hat_brick.RTCDriverPCF8523 = 0
hat_brick.RTCDriverDS1338 = 1

Neu in Version 2.0.3 (Firmware).

func (*HATBrick) GetRTCDriver() (rtcDriver uint8, err error)¶

Rückgabe:	rtcDriver – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

Gibt den RTC-Treiber zurück, wie von SetRTCDriver() gesetzt.

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

Für rtcDriver:

hat_brick.RTCDriverPCF8523 = 0
hat_brick.RTCDriverDS1338 = 1

Neu in Version 2.0.3 (Firmware).

func (*HATBrick) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)¶

Rückgabe:	errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 2³² - 1] err – Typ: error

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.

func (*HATBrick) SetStatusLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: error

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:

hat_brick.StatusLEDConfigOff = 0
hat_brick.StatusLEDConfigOn = 1
hat_brick.StatusLEDConfigShowHeartbeat = 2
hat_brick.StatusLEDConfigShowStatus = 3

func (*HATBrick) GetStatusLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

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

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

Für config:

hat_brick.StatusLEDConfigOff = 0
hat_brick.StatusLEDConfigOn = 1
hat_brick.StatusLEDConfigShowHeartbeat = 2
hat_brick.StatusLEDConfigShowStatus = 3

func (*HATBrick) GetChipTemperature() (temperature int16, err error)¶

Rückgabe:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] err – Typ: error

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.

func (*HATBrick) Reset() (err error)¶

Rückgabe:	err – Typ: error

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.

func (*HATBrick) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶

Rückgabe:

Rückgabe:	uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: rune, Wertebereich: ['i'] hardwareVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmwareVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] err – Typ: error

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: rune, Wertebereich: ['i']
hardwareVersion – Typ: [3]uint8

0: major – Typ: uint8, Wertebereich: [0 bis 255]
1: minor – Typ: uint8, Wertebereich: [0 bis 255]
2: revision – Typ: uint8, Wertebereich: [0 bis 255]

firmwareVersion – Typ: [3]uint8

0: major – Typ: uint8, Wertebereich: [0 bis 255]
1: minor – Typ: uint8, Wertebereich: [0 bis 255]
2: revision – Typ: uint8, Wertebereich: [0 bis 255]

deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]
err – Typ: error

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.

Konfigurationsfunktionen für Callbacks¶

func (*HATBrick) SetVoltagesCallbackConfiguration(period uint32, valueHasToChange bool) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

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

func (*HATBrick) GetVoltagesCallbackConfiguration() (period uint32, valueHasToChange bool, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

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

Neu in Version 2.0.1 (Firmware).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

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.

func (*HATBrick) RegisterVoltagesCallback(func(voltageUSB uint16, voltageDC uint16)) (registrationId uint64)¶

Callback-Parameter:	voltageUSB – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] voltageDC – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	registrationId – Typ: uint64

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

Die Parameter des Callbacks sind der gleiche wie GetVoltages().

Neu in Version 2.0.1 (Firmware).

Virtuelle Funktionen¶

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.

func (*HATBrick) GetAPIVersion() (apiVersion [3]uint8, err error)¶

Rückgabe:	apiVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: error

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.

func (*HATBrick) GetResponseExpected(functionId uint8) (responseExpected bool, err error)¶

Parameter:	functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool err – Typ: error

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:

hat_brick.FunctionSetSleepMode = 1
hat_brick.FunctionSetBrickletPower = 3
hat_brick.FunctionSetVoltagesCallbackConfiguration = 6
hat_brick.FunctionSetRTCDriver = 9
hat_brick.FunctionSetWriteFirmwarePointer = 237
hat_brick.FunctionSetStatusLEDConfig = 239
hat_brick.FunctionReset = 243
hat_brick.FunctionWriteUID = 248

func (*HATBrick) SetResponseExpected(functionId uint8, responseExpected bool) (err error)¶

Parameter:	functionId – Typ: uint8, Wertebereich: Siehe Konstanten responseExpected – Typ: bool
Rückgabe:	err – Typ: error

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

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

Für functionId:

hat_brick.FunctionSetSleepMode = 1
hat_brick.FunctionSetBrickletPower = 3
hat_brick.FunctionSetVoltagesCallbackConfiguration = 6
hat_brick.FunctionSetRTCDriver = 9
hat_brick.FunctionSetWriteFirmwarePointer = 237
hat_brick.FunctionSetStatusLEDConfig = 239
hat_brick.FunctionReset = 243
hat_brick.FunctionWriteUID = 248

func (*HATBrick) SetResponseExpectedAll(responseExpected bool) (err error)¶

Parameter:	responseExpected – Typ: bool
Rückgabe:	err – Typ: error

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

Interne Funktionen¶

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.

func (*HATBrick) SetBootloaderMode(mode uint8) (status uint8, err error)¶

Parameter:	mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

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:

hat_brick.BootloaderModeBootloader = 0
hat_brick.BootloaderModeFirmware = 1
hat_brick.BootloaderModeBootloaderWaitForReboot = 2
hat_brick.BootloaderModeFirmwareWaitForReboot = 3
hat_brick.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

hat_brick.BootloaderStatusOK = 0
hat_brick.BootloaderStatusInvalidMode = 1
hat_brick.BootloaderStatusNoChange = 2
hat_brick.BootloaderStatusEntryFunctionNotPresent = 3
hat_brick.BootloaderStatusDeviceIdentifierIncorrect = 4
hat_brick.BootloaderStatusCRCMismatch = 5

func (*HATBrick) GetBootloaderMode() (mode uint8, err error)¶

Rückgabe:	mode – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

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

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

Für mode:

hat_brick.BootloaderModeBootloader = 0
hat_brick.BootloaderModeFirmware = 1
hat_brick.BootloaderModeBootloaderWaitForReboot = 2
hat_brick.BootloaderModeFirmwareWaitForReboot = 3
hat_brick.BootloaderModeFirmwareWaitForEraseAndReboot = 4

func (*HATBrick) SetWriteFirmwarePointer(pointer uint32) (err error)¶

Parameter:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	err – Typ: error

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.

func (*HATBrick) WriteFirmware(data [64]uint8) (status uint8, err error)¶

Parameter:	data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: error

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.

func (*HATBrick) WriteUID(uid uint32) (err error)¶

Parameter:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	err – Typ: error

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.

func (*HATBrick) ReadUID() (uid uint32, err error)¶

Rückgabe:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1] err – Typ: error

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

Konstanten¶

hat_brick.DeviceIdentifier¶

Diese Konstante wird verwendet um einen HAT Brick zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

hat_brick.DeviceDisplayName¶: Diese Konstante stellt den Anzeigenamen eines HAT Brick dar.