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

Python - HAT Brick¶

Dies ist die Beschreibung der Python 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 Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Sleep¶

Download (example_sleep.py)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XXYYZZ" # Change XXYYZZ to the UID of your HAT Brick

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_hat import BrickHAT

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    hat = 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.set_sleep_mode(2, 1800, True, True, True)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Print Voltages¶

Download (example_print_voltages.py)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XXYYZZ" # Change XXYYZZ to the UID of your HAT Brick

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_hat import BrickHAT

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    hat = 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
    voltage_usb, voltage_dc = hat.get_voltages()

    print("Voltage USB: " + str(voltage_usb/1000.0) + " V")
    print("Voltage DC: " + str(voltage_dc/1000.0) + " V")

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

API¶

Prinzipiell kann jede Funktion der Python Bindings tinkerforge.ip_connection.Error Exception werfen, welche ein value und eine description Property hat. value kann verschiende Werte haben:

Error.TIMEOUT = -1
Error.NOT_ADDED = -6 (seit Python Bindings Version 2.0.0 nicht mehr verwendet)
Error.ALREADY_CONNECTED = -7
Error.NOT_CONNECTED = -8
Error.INVALID_PARAMETER = -9
Error.NOT_SUPPORTED = -10
Error.UNKNOWN_ERROR_CODE = -11
Error.STREAM_OUT_OF_SYNC = -12
Error.INVALID_UID = -13
Error.NON_ASCII_CHAR_IN_SECRET = -14
Error.WRONG_DEVICE_TYPE = -15
Error.DEVICE_REPLACED = -16
Error.WRONG_RESPONSE_LENGTH = -17

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickHAT(uid, ipcon)¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	hat – Typ: BrickHAT

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

hat = BrickHAT("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickHAT.set_sleep_mode(power_off_delay, power_off_duration, raspberry_pi_off, bricklets_off, enable_sleep_indicator)¶

Parameter:	power_off_delay – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] power_off_duration – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] raspberry_pi_off – Typ: bool bricklets_off – Typ: bool enable_sleep_indicator – Typ: bool
Rückgabe:	None

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.

BrickHAT.get_sleep_mode()¶

Rückgabeobjekt:	power_off_delay – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] power_off_duration – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] raspberry_pi_off – Typ: bool bricklets_off – Typ: bool enable_sleep_indicator – Typ: bool

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

BrickHAT.set_bricklet_power(bricklet_power)¶

Parameter:	bricklet_power – Typ: bool, Standardwert: True
Rückgabe:	None

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

BrickHAT.get_bricklet_power()¶

Rückgabe:	bricklet_power – Typ: bool, Standardwert: True

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

BrickHAT.get_voltages()¶

Rückgabeobjekt:	voltage_usb – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] voltage_dc – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

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¶

BrickHAT.set_rtc_driver(rtc_driver)¶

Parameter:	rtc_driver – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	None

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

BrickHAT.RTC_DRIVER_PCF8523 = 0
BrickHAT.RTC_DRIVER_DS1338 = 1

Neu in Version 2.0.3 (Firmware).

BrickHAT.get_rtc_driver()¶

Rückgabe:	rtc_driver – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für rtc_driver:

BrickHAT.RTC_DRIVER_PCF8523 = 0
BrickHAT.RTC_DRIVER_DS1338 = 1

Neu in Version 2.0.3 (Firmware).

BrickHAT.get_spitfp_error_count()¶

Rückgabeobjekt:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 1]

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.

BrickHAT.set_status_led_config(config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	None

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

BrickHAT.get_status_led_config()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

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

BrickHAT.get_chip_temperature()¶

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

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()¶

Rückgabe:	None

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.get_identity()¶

Rückgabeobjekt:

Rückgabeobjekt:	uid – Typ: str, Länge: bis zu 8 connected_uid – Typ: str, Länge: bis zu 8 position – Typ: chr, Wertebereich: ["i"] hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

uid – Typ: str, Länge: bis zu 8
connected_uid – Typ: str, Länge: bis zu 8
position – Typ: chr, Wertebereich: ["i"]
hardware_version – Typ: [int, ...], Länge: 3

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

firmware_version – Typ: [int, ...], Länge: 3

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

device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

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¶

BrickHAT.register_callback(callback_id, function)¶

Parameter:	callback_id – Typ: int function – Typ: callable
Rückgabe:	None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickHAT.set_voltages_callback_configuration(period, value_has_to_change)¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: False
Rückgabe:	None

Die Periode ist die Periode mit der der CALLBACK_VOLTAGES 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.get_voltages_callback_configuration()¶

Rückgabeobjekt:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: False

Gibt die Callback-Konfiguration zurück, wie mittels set_voltages_callback_configuration() 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 Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

hat.register_callback(BrickHAT.CALLBACK_EXAMPLE, my_callback)

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.CALLBACK_VOLTAGES¶

Callback-Parameter:	voltage_usb – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] voltage_dc – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

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

Die Parameter sind der gleiche wie get_voltages().

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.

BrickHAT.get_api_version()¶

Rückgabeobjekt:	api_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255]

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.get_response_expected(function_id)¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

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 set_response_expected(). 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 function_id:

BrickHAT.FUNCTION_SET_SLEEP_MODE = 1
BrickHAT.FUNCTION_SET_BRICKLET_POWER = 3
BrickHAT.FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = 6
BrickHAT.FUNCTION_SET_RTC_DRIVER = 9
BrickHAT.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickHAT.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickHAT.FUNCTION_RESET = 243
BrickHAT.FUNCTION_WRITE_UID = 248

BrickHAT.set_response_expected(function_id, response_expected)¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	None

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

BrickHAT.FUNCTION_SET_SLEEP_MODE = 1
BrickHAT.FUNCTION_SET_BRICKLET_POWER = 3
BrickHAT.FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = 6
BrickHAT.FUNCTION_SET_RTC_DRIVER = 9
BrickHAT.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickHAT.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickHAT.FUNCTION_RESET = 243
BrickHAT.FUNCTION_WRITE_UID = 248

BrickHAT.set_response_expected_all(response_expected)¶

Parameter:	response_expected – Typ: bool
Rückgabe:	None

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

BrickHAT.set_bootloader_mode(mode)¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

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:

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

Für status:

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

BrickHAT.get_bootloader_mode()¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für mode:

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.set_write_firmware_pointer(pointer)¶

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

Setzt den Firmware-Pointer für write_firmware(). 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.write_firmware(data)¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer() 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.write_uid(uid)¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	None

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.read_uid()¶

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

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

Konstanten¶

BrickHAT.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen HAT Brick zu identifizieren.

Die get_identity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickHAT.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines HAT Brick dar.