Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricks / HAT Zero Brick

C/C++ - HAT Zero Brick¶

Dies ist die Beschreibung der C/C++ API Bindings für den HAT Zero Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des HAT Zero Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

#include <stdio.h>

#include "ip_connection.h"
#include "brick_hat_zero.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XXYYZZ" // Change XXYYZZ to the UID of your HAT Zero Brick

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    HATZero hz;
    hat_zero_create(&hz, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current voltage
    uint16_t voltage;
    if(hat_zero_get_usb_voltage(&hz, &voltage) < 0) {
        fprintf(stderr, "Could not get voltage, probably timeout\n");
        return 1;
    }

    printf("Voltage: %f V\n", voltage/1000.0);

    printf("Press key to exit\n");
    getchar();
    hat_zero_destroy(&hz);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

E_OK = 0
E_TIMEOUT = -1
E_NO_STREAM_SOCKET = -2
E_HOSTNAME_INVALID = -3
E_NO_CONNECT = -4
E_NO_THREAD = -5
E_NOT_ADDED = -6 (seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
E_ALREADY_CONNECTED = -7
E_NOT_CONNECTED = -8
E_INVALID_PARAMETER = -9
E_NOT_SUPPORTED = -10
E_UNKNOWN_ERROR_CODE = -11
E_STREAM_OUT_OF_SYNC = -12
E_INVALID_UID = -13
E_NON_ASCII_CHAR_IN_SECRET = -14
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void hat_zero_create(HATZero *hat_zero, const char *uid, IPConnection *ipcon)¶

Parameter:	hat_zero – Typ: HATZero * uid – Typ: const char * ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt hat_zero mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

HATZero hat_zero;
hat_zero_create(&hat_zero, "YOUR_DEVICE_UID", &ipcon);

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

void hat_zero_destroy(HATZero *hat_zero)¶

Parameter:	hat_zero – Typ: HATZero *

Entfernt das Geräteobjekt hat_zero von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int hat_zero_get_usb_voltage(HATZero *hat_zero, uint16_t *ret_voltage)¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Gibt die USB-Versorgungsspannung des Raspberry Pi zurück.

Wenn der Wert periodisch benötigt wird, kann auch der HAT_ZERO_CALLBACK_USB_VOLTAGE Callback verwendet werden. Der Callback wird mit der Funktion hat_zero_set_usb_voltage_callback_configuration() konfiguriert.

Fortgeschrittene Funktionen¶

int hat_zero_get_spitfp_error_count(HATZero *hat_zero, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int hat_zero_set_status_led_config(HATZero *hat_zero, uint8_t config)¶

Parameter:	hat_zero – Typ: HATZero * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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_ZERO_STATUS_LED_CONFIG_OFF = 0
HAT_ZERO_STATUS_LED_CONFIG_ON = 1
HAT_ZERO_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
HAT_ZERO_STATUS_LED_CONFIG_SHOW_STATUS = 3

int hat_zero_get_status_led_config(HATZero *hat_zero, uint8_t *ret_config)¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

HAT_ZERO_STATUS_LED_CONFIG_OFF = 0
HAT_ZERO_STATUS_LED_CONFIG_ON = 1
HAT_ZERO_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
HAT_ZERO_STATUS_LED_CONFIG_SHOW_STATUS = 3

int hat_zero_get_chip_temperature(HATZero *hat_zero, int16_t *ret_temperature)¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int hat_zero_reset(HATZero *hat_zero)¶

Parameter:	hat_zero – Typ: HATZero *
Rückgabe:	e_code – Typ: int

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.

int hat_zero_get_identity(HATZero *hat_zero, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['i'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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¶

void hat_zero_register_callback(HATZero *hat_zero, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	hat_zero – Typ: HATZero * callback_id – Typ: int16_t function – Typ: void ()(void) user_data* – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

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

int hat_zero_set_usb_voltage_callback_configuration(HATZero *hat_zero, uint32_t period, bool value_has_to_change, char option, uint16_t min, uint16_t max)¶

Parameter:

Parameter:	hat_zero – Typ: HATZero * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

hat_zero – Typ: HATZero *
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
max – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Die Periode ist die Periode mit der der HAT_ZERO_CALLBACK_USB_VOLTAGE 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den HAT_ZERO_CALLBACK_USB_VOLTAGE Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

HAT_ZERO_THRESHOLD_OPTION_OFF = 'x'
HAT_ZERO_THRESHOLD_OPTION_OUTSIDE = 'o'
HAT_ZERO_THRESHOLD_OPTION_INSIDE = 'i'
HAT_ZERO_THRESHOLD_OPTION_SMALLER = '<'
HAT_ZERO_THRESHOLD_OPTION_GREATER = '>'

Neu in Version 2.0.1 (Firmware).

int hat_zero_get_usb_voltage_callback_configuration(HATZero *hat_zero, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_max – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

HAT_ZERO_THRESHOLD_OPTION_OFF = 'x'
HAT_ZERO_THRESHOLD_OPTION_OUTSIDE = 'o'
HAT_ZERO_THRESHOLD_OPTION_INSIDE = 'i'
HAT_ZERO_THRESHOLD_OPTION_SMALLER = '<'
HAT_ZERO_THRESHOLD_OPTION_GREATER = '>'

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 hat_zero_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

hat_zero_register_callback(&hat_zero,
                           HAT_ZERO_CALLBACK_EXAMPLE,
                           (void (*)(void))my_callback,
                           NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen 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.

HAT_ZERO_CALLBACK_USB_VOLTAGE¶

void callback(uint16_t voltage, void *user_data)

Callback-Parameter:	voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

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

Der Parameter ist der gleiche wie hat_zero_get_usb_voltage().

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.

int hat_zero_get_api_version(HATZero *hat_zero, uint8_t ret_api_version[3])¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_api_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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.

int hat_zero_get_response_expected(HATZero *hat_zero, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	hat_zero – Typ: HATZero * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

HAT_ZERO_FUNCTION_SET_USB_VOLTAGE_CALLBACK_CONFIGURATION = 2
HAT_ZERO_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
HAT_ZERO_FUNCTION_SET_STATUS_LED_CONFIG = 239
HAT_ZERO_FUNCTION_RESET = 243
HAT_ZERO_FUNCTION_WRITE_UID = 248

int hat_zero_set_response_expected(HATZero *hat_zero, uint8_t function_id, bool response_expected)¶

Parameter:	hat_zero – Typ: HATZero * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

HAT_ZERO_FUNCTION_SET_USB_VOLTAGE_CALLBACK_CONFIGURATION = 2
HAT_ZERO_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
HAT_ZERO_FUNCTION_SET_STATUS_LED_CONFIG = 239
HAT_ZERO_FUNCTION_RESET = 243
HAT_ZERO_FUNCTION_WRITE_UID = 248

int hat_zero_set_response_expected_all(HATZero *hat_zero, bool response_expected)¶

Parameter:	hat_zero – Typ: HATZero * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

int hat_zero_set_bootloader_mode(HATZero *hat_zero, uint8_t mode, uint8_t *ret_status)¶

Parameter:	hat_zero – Typ: HATZero * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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_ZERO_BOOTLOADER_MODE_BOOTLOADER = 0
HAT_ZERO_BOOTLOADER_MODE_FIRMWARE = 1
HAT_ZERO_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
HAT_ZERO_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
HAT_ZERO_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

HAT_ZERO_BOOTLOADER_STATUS_OK = 0
HAT_ZERO_BOOTLOADER_STATUS_INVALID_MODE = 1
HAT_ZERO_BOOTLOADER_STATUS_NO_CHANGE = 2
HAT_ZERO_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
HAT_ZERO_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
HAT_ZERO_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int hat_zero_get_bootloader_mode(HATZero *hat_zero, uint8_t *ret_mode)¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

HAT_ZERO_BOOTLOADER_MODE_BOOTLOADER = 0
HAT_ZERO_BOOTLOADER_MODE_FIRMWARE = 1
HAT_ZERO_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
HAT_ZERO_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
HAT_ZERO_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int hat_zero_set_write_firmware_pointer(HATZero *hat_zero, uint32_t pointer)¶

Parameter:	hat_zero – Typ: HATZero * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für hat_zero_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.

int hat_zero_write_firmware(HATZero *hat_zero, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	hat_zero – Typ: HATZero * data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von hat_zero_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.

int hat_zero_write_uid(HATZero *hat_zero, uint32_t uid)¶

Parameter:	hat_zero – Typ: HATZero * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int hat_zero_read_uid(HATZero *hat_zero, uint32_t *ret_uid)¶

Parameter:	hat_zero – Typ: HATZero *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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_ZERO_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen HAT Zero Brick zu identifizieren.

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

HAT_ZERO_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines HAT Zero Brick dar.