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

C/C++ - HAT Brick¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Sleep¶

Download (example_sleep.c)

#include <stdio.h>

#include "ip_connection.h"
#include "brick_hat.h"

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

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

    // Create device object
    HAT hat;
    hat_create(&hat, 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

    // Turn Raspberry Pi and Bricklets off in 2 seconds for 30 minutes with sleep indicator enabled
    hat_set_sleep_mode(&hat, 2, 1800, true, true, true);

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

Print Voltages¶

Download (example_print_voltages.c)

#include <stdio.h>

#include "ip_connection.h"
#include "brick_hat.h"

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

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

    // Create device object
    HAT hat;
    hat_create(&hat, 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 get voltages
    uint16_t voltage_usb, voltage_dc;
    if(hat_get_voltages(&hat, &voltage_usb, &voltage_dc) < 0) {
        fprintf(stderr, "Could not get get voltages, probably timeout\n");
        return 1;
    }

    printf("Voltage USB: %f V\n", voltage_usb/1000.0);
    printf("Voltage DC: %f V\n", voltage_dc/1000.0);

    printf("Press key to exit\n");
    getchar();
    hat_destroy(&hat);
    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_create(HAT *hat, const char *uid, IPConnection *ipcon)¶

Parameter:	hat – Typ: HAT * uid – Typ: const char * ipcon – Typ: IPConnection *

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

HAT hat;
hat_create(&hat, "YOUR_DEVICE_UID", &ipcon);

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

void hat_destroy(HAT *hat)¶

Parameter:	hat – Typ: HAT *

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

int hat_set_sleep_mode(HAT *hat, uint32_t power_off_delay, uint32_t power_off_duration, bool raspberry_pi_off, bool bricklets_off, bool enable_sleep_indicator)¶

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

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.

int hat_get_sleep_mode(HAT *hat, uint32_t *ret_power_off_delay, uint32_t *ret_power_off_duration, bool *ret_raspberry_pi_off, bool *ret_bricklets_off, bool *ret_enable_sleep_indicator)¶

Parameter:	hat – Typ: HAT *
Ausgabeparameter:	ret_power_off_delay – Typ: uint32_t, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] ret_power_off_duration – Typ: uint32_t, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1] ret_raspberry_pi_off – Typ: bool ret_bricklets_off – Typ: bool ret_enable_sleep_indicator – Typ: bool
Rückgabe:	e_code – Typ: int

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

int hat_set_bricklet_power(HAT *hat, bool bricklet_power)¶

Parameter:	hat – Typ: HAT * bricklet_power – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

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

int hat_get_bricklet_power(HAT *hat, bool *ret_bricklet_power)¶

Parameter:	hat – Typ: HAT *
Ausgabeparameter:	ret_bricklet_power – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

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

int hat_get_voltages(HAT *hat, uint16_t *ret_voltage_usb, uint16_t *ret_voltage_dc)¶

Parameter:	hat – Typ: HAT *
Ausgabeparameter:	ret_voltage_usb – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] ret_voltage_dc – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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¶

int hat_set_rtc_driver(HAT *hat, uint8_t rtc_driver)¶

Parameter:	hat – Typ: HAT * rtc_driver – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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:

HAT_RTC_DRIVER_PCF8523 = 0
HAT_RTC_DRIVER_DS1338 = 1

Neu in Version 2.0.3 (Firmware).

int hat_get_rtc_driver(HAT *hat, uint8_t *ret_rtc_driver)¶

Parameter:	hat – Typ: HAT *
Ausgabeparameter:	ret_rtc_driver – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

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

Für ret_rtc_driver:

HAT_RTC_DRIVER_PCF8523 = 0
HAT_RTC_DRIVER_DS1338 = 1

Neu in Version 2.0.3 (Firmware).

int hat_get_spitfp_error_count(HAT *hat, 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 – Typ: HAT *
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_set_status_led_config(HAT *hat, uint8_t config)¶

Parameter:	hat – Typ: HAT * 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_STATUS_LED_CONFIG_OFF = 0
HAT_STATUS_LED_CONFIG_ON = 1
HAT_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
HAT_STATUS_LED_CONFIG_SHOW_STATUS = 3

int hat_get_status_led_config(HAT *hat, uint8_t *ret_config)¶

Parameter:	hat – Typ: HAT *
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_set_status_led_config() gesetzt.

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

Für ret_config:

HAT_STATUS_LED_CONFIG_OFF = 0
HAT_STATUS_LED_CONFIG_ON = 1
HAT_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
HAT_STATUS_LED_CONFIG_SHOW_STATUS = 3

int hat_get_chip_temperature(HAT *hat, int16_t *ret_temperature)¶

Parameter:	hat – Typ: HAT *
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_reset(HAT *hat)¶

Parameter:	hat – Typ: HAT *
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_get_identity(HAT *hat, 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 – Typ: HAT *
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_register_callback(HAT *hat, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	hat – Typ: HAT * 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_set_voltages_callback_configuration(HAT *hat, uint32_t period, bool value_has_to_change)¶

Parameter:	hat – Typ: HAT * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

int hat_get_voltages_callback_configuration(HAT *hat, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	hat – Typ: HAT *
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
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels hat_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 hat_register_callback() Funktion durchgeführt werden:

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

hat_register_callback(&hat,
                      HAT_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_CALLBACK_VOLTAGES¶

void callback(uint16_t voltage_usb, uint16_t voltage_dc, void *user_data)

Callback-Parameter:	voltage_usb – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] voltage_dc – 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_set_voltages_callback_configuration() gesetzten Konfiguration

Die Parameter sind der gleiche wie hat_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.

int hat_get_api_version(HAT *hat, uint8_t ret_api_version[3])¶

Parameter:	hat – Typ: HAT *
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_get_response_expected(HAT *hat, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	hat – Typ: HAT * 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_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_FUNCTION_SET_SLEEP_MODE = 1
HAT_FUNCTION_SET_BRICKLET_POWER = 3
HAT_FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = 6
HAT_FUNCTION_SET_RTC_DRIVER = 9
HAT_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
HAT_FUNCTION_SET_STATUS_LED_CONFIG = 239
HAT_FUNCTION_RESET = 243
HAT_FUNCTION_WRITE_UID = 248

int hat_set_response_expected(HAT *hat, uint8_t function_id, bool response_expected)¶

Parameter:	hat – Typ: HAT * 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_FUNCTION_SET_SLEEP_MODE = 1
HAT_FUNCTION_SET_BRICKLET_POWER = 3
HAT_FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = 6
HAT_FUNCTION_SET_RTC_DRIVER = 9
HAT_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
HAT_FUNCTION_SET_STATUS_LED_CONFIG = 239
HAT_FUNCTION_RESET = 243
HAT_FUNCTION_WRITE_UID = 248

int hat_set_response_expected_all(HAT *hat, bool response_expected)¶

Parameter:	hat – Typ: HAT * 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_set_bootloader_mode(HAT *hat, uint8_t mode, uint8_t *ret_status)¶

Parameter:	hat – Typ: HAT * 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_BOOTLOADER_MODE_BOOTLOADER = 0
HAT_BOOTLOADER_MODE_FIRMWARE = 1
HAT_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
HAT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
HAT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

HAT_BOOTLOADER_STATUS_OK = 0
HAT_BOOTLOADER_STATUS_INVALID_MODE = 1
HAT_BOOTLOADER_STATUS_NO_CHANGE = 2
HAT_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
HAT_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
HAT_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int hat_get_bootloader_mode(HAT *hat, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

HAT_BOOTLOADER_MODE_BOOTLOADER = 0
HAT_BOOTLOADER_MODE_FIRMWARE = 1
HAT_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
HAT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
HAT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int hat_set_write_firmware_pointer(HAT *hat, uint32_t pointer)¶

Parameter:	hat – Typ: HAT * 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_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_write_firmware(HAT *hat, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	hat – Typ: HAT * 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_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_write_uid(HAT *hat, uint32_t uid)¶

Parameter:	hat – Typ: HAT * 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_read_uid(HAT *hat, uint32_t *ret_uid)¶

Parameter:	hat – Typ: HAT *
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_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen HAT Brick zu identifizieren.

Die hat_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_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines HAT Brick dar.