Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / Isolator Bricklet

C/C++ - Isolator Bricklet¶

Dies ist die Beschreibung der C/C++ API Bindings für das Isolator Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Isolator Bricklet 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 "bricklet_isolator.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Isolator Bricklet

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

    // Create device object
    Isolator i;
    isolator_create(&i, 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 statistics
    uint32_t messages_from_brick, messages_from_bricklet;
    uint16_t connected_bricklet_device_identifier; char connected_bricklet_uid[8];
    if(isolator_get_statistics(&i, &messages_from_brick, &messages_from_bricklet,
                               &connected_bricklet_device_identifier,
                               connected_bricklet_uid) < 0) {
        fprintf(stderr, "Could not get statistics, probably timeout\n");
        return 1;
    }

    printf("Messages From Brick: %u\n", messages_from_brick);
    printf("Messages From Bricklet: %u\n", messages_from_bricklet);
    printf("Connected Bricklet Device Identifier: %u\n", connected_bricklet_device_identifier);
    printf("Connected Bricklet UID: %s\n", connected_bricklet_uid);

    printf("Press key to exit\n");
    getchar();
    isolator_destroy(&i);
    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 isolator_create(Isolator *isolator, const char *uid, IPConnection *ipcon)¶

Parameter:	isolator – Typ: Isolator * uid – Typ: const char * ipcon – Typ: IPConnection *

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

Isolator isolator;
isolator_create(&isolator, "YOUR_DEVICE_UID", &ipcon);

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

void isolator_destroy(Isolator *isolator)¶

Parameter:	isolator – Typ: Isolator *

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

int isolator_get_statistics(Isolator *isolator, uint32_t *ret_messages_from_brick, uint32_t *ret_messages_from_bricklet, uint16_t *ret_connected_bricklet_device_identifier, char ret_connected_bricklet_uid[8])¶

Parameter:	isolator – Typ: Isolator *
Ausgabeparameter:	ret_messages_from_brick – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_messages_from_bricklet – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_connected_bricklet_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_connected_bricklet_uid – Typ: char[8]
Rückgabe:	e_code – Typ: int

Gibt Statistiken des Isolator Bricklets zurück.

Fortgeschrittene Funktionen¶

int isolator_set_spitfp_baudrate_config(Isolator *isolator, bool enable_dynamic_baudrate, uint32_t minimum_dynamic_baudrate)¶

Parameter:	isolator – Typ: Isolator * enable_dynamic_baudrate – Typ: bool, Standardwert: true minimum_dynamic_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:	e_code – Typ: int

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht das Isolator Bricklet die Baudrate anhand des Datenaufkommens zwischen Isolator Bricklet und Bricklet anzupassen.

Die Baudratenkonfiguration für die Kommunikation zwischen Brick und Isolator Bricklet kann in der API des Bricks eingestellt werden.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion isolator_set_spitfp_baudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von isolator_set_spitfp_baudrate() gesetzt statisch verwendet.

int isolator_get_spitfp_baudrate_config(Isolator *isolator, bool *ret_enable_dynamic_baudrate, uint32_t *ret_minimum_dynamic_baudrate)¶

Parameter:	isolator – Typ: Isolator *
Ausgabeparameter:	ret_enable_dynamic_baudrate – Typ: bool, Standardwert: true ret_minimum_dynamic_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:	e_code – Typ: int

Gibt die Baudratenkonfiguration zurück, siehe isolator_set_spitfp_baudrate_config().

int isolator_set_spitfp_baudrate(Isolator *isolator, uint32_t baudrate)¶

Parameter:	isolator – Typ: Isolator * baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:	e_code – Typ: int

Setzt die Baudrate für die Kommunikation zwischen Isolator Bricklet und angeschlossenem Bricklet. Die Baudrate für die Kommunikation zwischen Brick und Isolator Bricklet kann in der API des Bricks eingestellt werden.

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe isolator_get_spitfp_error_count()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe isolator_set_spitfp_baudrate_config()).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

int isolator_get_spitfp_baudrate(Isolator *isolator, uint32_t *ret_baudrate)¶

Parameter:	isolator – Typ: Isolator *
Ausgabeparameter:	ret_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:	e_code – Typ: int

Gibt die Baudrate zurück, siehe isolator_set_spitfp_baudrate().

int isolator_get_isolator_spitfp_error_count(Isolator *isolator, 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:	isolator – Typ: Isolator *
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 Isolator Bricklet und Bricklet aufgetreten sind zurück. Rufe isolator_get_spitfp_error_count() um die Anzahl der Fehler zwischen Isolator Bricklet und Brick zu bekommen.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

int isolator_get_spitfp_error_count(Isolator *isolator, 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:	isolator – Typ: Isolator *
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 isolator_set_status_led_config(Isolator *isolator, uint8_t config)¶

Parameter:	isolator – Typ: Isolator * 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:

ISOLATOR_STATUS_LED_CONFIG_OFF = 0
ISOLATOR_STATUS_LED_CONFIG_ON = 1
ISOLATOR_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
ISOLATOR_STATUS_LED_CONFIG_SHOW_STATUS = 3

int isolator_get_status_led_config(Isolator *isolator, uint8_t *ret_config)¶

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

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

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

Für ret_config:

ISOLATOR_STATUS_LED_CONFIG_OFF = 0
ISOLATOR_STATUS_LED_CONFIG_ON = 1
ISOLATOR_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
ISOLATOR_STATUS_LED_CONFIG_SHOW_STATUS = 3

int isolator_get_chip_temperature(Isolator *isolator, int16_t *ret_temperature)¶

Parameter:	isolator – Typ: Isolator *
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 isolator_reset(Isolator *isolator)¶

Parameter:	isolator – Typ: Isolator *
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 isolator_get_identity(Isolator *isolator, 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:	isolator – Typ: Isolator *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] 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 Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

void isolator_register_callback(Isolator *isolator, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	isolator – Typ: Isolator * 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 isolator_set_statistics_callback_configuration(Isolator *isolator, uint32_t period, bool value_has_to_change)¶

Parameter:	isolator – Typ: Isolator * 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 ISOLATOR_CALLBACK_STATISTICS 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.2 (Plugin).

int isolator_get_statistics_callback_configuration(Isolator *isolator, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	isolator – Typ: Isolator *
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 isolator_set_statistics_callback_configuration() gesetzt.

Neu in Version 2.0.2 (Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der isolator_register_callback() Funktion durchgeführt werden:

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

isolator_register_callback(&isolator,
                           ISOLATOR_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.

ISOLATOR_CALLBACK_STATISTICS¶

void callback(uint32_t messages_from_brick, uint32_t messages_from_bricklet, uint16_t connected_bricklet_device_identifier, char connected_bricklet_uid[8], void *user_data)

Callback-Parameter:	messages_from_brick – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] messages_from_bricklet – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] connected_bricklet_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] connected_bricklet_uid – Typ: char[8] user_data – Typ: void *

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

Die Parameter sind der gleiche wie isolator_get_statistics().

Neu in Version 2.0.2 (Plugin).

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 isolator_get_api_version(Isolator *isolator, uint8_t ret_api_version[3])¶

Parameter:	isolator – Typ: Isolator *
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 isolator_get_response_expected(Isolator *isolator, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	isolator – Typ: Isolator * 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 isolator_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:

ISOLATOR_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
ISOLATOR_FUNCTION_SET_SPITFP_BAUDRATE = 4
ISOLATOR_FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION = 7
ISOLATOR_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
ISOLATOR_FUNCTION_SET_STATUS_LED_CONFIG = 239
ISOLATOR_FUNCTION_RESET = 243
ISOLATOR_FUNCTION_WRITE_UID = 248

int isolator_set_response_expected(Isolator *isolator, uint8_t function_id, bool response_expected)¶

Parameter:	isolator – Typ: Isolator * 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:

ISOLATOR_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
ISOLATOR_FUNCTION_SET_SPITFP_BAUDRATE = 4
ISOLATOR_FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION = 7
ISOLATOR_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
ISOLATOR_FUNCTION_SET_STATUS_LED_CONFIG = 239
ISOLATOR_FUNCTION_RESET = 243
ISOLATOR_FUNCTION_WRITE_UID = 248

int isolator_set_response_expected_all(Isolator *isolator, bool response_expected)¶

Parameter:	isolator – Typ: Isolator * 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 isolator_set_bootloader_mode(Isolator *isolator, uint8_t mode, uint8_t *ret_status)¶

Parameter:	isolator – Typ: Isolator * 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:

ISOLATOR_BOOTLOADER_MODE_BOOTLOADER = 0
ISOLATOR_BOOTLOADER_MODE_FIRMWARE = 1
ISOLATOR_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
ISOLATOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
ISOLATOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

ISOLATOR_BOOTLOADER_STATUS_OK = 0
ISOLATOR_BOOTLOADER_STATUS_INVALID_MODE = 1
ISOLATOR_BOOTLOADER_STATUS_NO_CHANGE = 2
ISOLATOR_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
ISOLATOR_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
ISOLATOR_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int isolator_get_bootloader_mode(Isolator *isolator, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

ISOLATOR_BOOTLOADER_MODE_BOOTLOADER = 0
ISOLATOR_BOOTLOADER_MODE_FIRMWARE = 1
ISOLATOR_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
ISOLATOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
ISOLATOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int isolator_set_write_firmware_pointer(Isolator *isolator, uint32_t pointer)¶

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

Setzt den Firmware-Pointer für isolator_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 isolator_write_firmware(Isolator *isolator, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	isolator – Typ: Isolator * 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 isolator_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 isolator_write_uid(Isolator *isolator, uint32_t uid)¶

Parameter:	isolator – Typ: Isolator * 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 isolator_read_uid(Isolator *isolator, uint32_t *ret_uid)¶

Parameter:	isolator – Typ: Isolator *
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¶

ISOLATOR_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Isolator Bricklet zu identifizieren.

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

ISOLATOR_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Isolator Bricklet dar.