Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / One Wire Bricklet

C/C++ für Mikrocontroller - One Wire Bricklet¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das One Wire Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des One Wire Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Read Ds18b20 Temperature¶

Download (example_read_ds18b20_temperature.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_one_wire.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_OneWire ow;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_one_wire_create(&ow, NULL, hal), "create device object");

    uint8_t status;
    check(tf_one_wire_write_command(&ow, 0, 78, &status), "call write_command"); // WRITE SCRATCHPAD
    check(tf_one_wire_write(&ow, 0, &status), "call write"); // ALARM H (unused)
    check(tf_one_wire_write(&ow, 0, &status), "call write"); // ALARM L (unused)
    check(tf_one_wire_write(&ow, 127, &status), "call write"); // CONFIGURATION: 12-bit mode

    // Read temperature 10 times
    int i;
    for (i = 0; i < 10; ++i) {
        check(tf_one_wire_write_command(&ow, 0, 68, &status), "call write_command"); // CONVERT T (start temperature conversion)
        tf_hal_sleep_us(hal, 1000 * 1000); // Wait for conversion to finish
        check(tf_one_wire_write_command(&ow, 0, 190, &status), "call write_command"); // READ SCRATCHPAD

        uint8_t t_low;
        check(tf_one_wire_read(&ow, &t_low, &status), "read low byte");

        uint8_t t_high;
        check(tf_one_wire_read(&ow, &t_high, &status), "read high byte");

        uint16_t temperature = t_low | (uint16_t)(t_high << 8);

        // Negative 12-bit values are sign-extended to 16-bit two's complement
        if (temperature > 1 << 12) {
            temperature -= 1 << 16;
        }

        // 12-bit mode measures in units of 1/16°C
        // tf_hal_printf does not support %f or padding, so we
        // have to create the decimal number by hand.
        uint16_t temp_degrees = temperature >> 4;
        uint16_t temp_tenthousandth_degree = 625 * (temperature & 0x0F);

        char padding[5] = {0};

        if(temp_tenthousandth_degree < 1000)
            padding[0] = '0';
        if(temp_tenthousandth_degree < 100)
            padding[1] = '0';
        if(temp_tenthousandth_degree < 10)
            padding[2] = '0';
        if(temp_tenthousandth_degree < 1)
            padding[3] = '0';

        tf_hal_printf("Temperature: %I16d.%s%I16d °C\n", temp_degrees, padding, temp_tenthousandth_degree);
    }
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_one_wire_create(TF_OneWire *one_wire, const char *uid, TF_HAL *hal)¶

Parameter:	one_wire – Typ: TF_OneWire * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt one_wire mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_OneWire one_wire;
tf_one_wire_create(&one_wire, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_one_wire_destroy(TF_OneWire *one_wire)¶

Parameter:	one_wire – Typ: TF_OneWire *
Rückgabe:	e_code – Typ: int

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

int tf_one_wire_search_bus(TF_OneWire *one_wire, uint64_t *ret_identifier, uint16_t *ret_identifier_length, uint8_t *ret_status)¶

Parameter:	one_wire – Typ: TF_OneWire *
Ausgabeparameter:	ret_identifier – Typ: uint64_t , Wertebereich: [0 bis 2⁶⁴ - 1] ret_identifier_length* – Typ: uint16_t ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt eine Liste mit bis zu 64 Identifiern von angeschlossenen 1-Wire Geräten zurück. Jeder Identifier ist 64-Bit und besteht aus 8-Bit Familien-Code, 48-Bit ID und 8-Bit CRC.

Um diese Liste zu erhalten führt das Bricklet den SEARCH ROM Algorithmus von Maxim aus.

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

Für ret_status:

TF_ONE_WIRE_STATUS_OK = 0
TF_ONE_WIRE_STATUS_BUSY = 1
TF_ONE_WIRE_STATUS_NO_PRESENCE = 2
TF_ONE_WIRE_STATUS_TIMEOUT = 3
TF_ONE_WIRE_STATUS_ERROR = 4

int tf_one_wire_reset_bus(TF_OneWire *one_wire, uint8_t *ret_status)¶

Parameter:	one_wire – Typ: TF_OneWire *
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Setzt den Bus mit einer 1-Wire Reset Operation zurück.

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

Für ret_status:

TF_ONE_WIRE_STATUS_OK = 0
TF_ONE_WIRE_STATUS_BUSY = 1
TF_ONE_WIRE_STATUS_NO_PRESENCE = 2
TF_ONE_WIRE_STATUS_TIMEOUT = 3
TF_ONE_WIRE_STATUS_ERROR = 4

int tf_one_wire_write(TF_OneWire *one_wire, uint8_t data, uint8_t *ret_status)¶

Parameter:	one_wire – Typ: TF_OneWire * data – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Schreibt ein Byte an Daten auf den 1-Wire Bus.

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

Für ret_status:

TF_ONE_WIRE_STATUS_OK = 0
TF_ONE_WIRE_STATUS_BUSY = 1
TF_ONE_WIRE_STATUS_NO_PRESENCE = 2
TF_ONE_WIRE_STATUS_TIMEOUT = 3
TF_ONE_WIRE_STATUS_ERROR = 4

int tf_one_wire_read(TF_OneWire *one_wire, uint8_t *ret_data, uint8_t *ret_status)¶

Parameter:	one_wire – Typ: TF_OneWire *
Ausgabeparameter:	ret_data – Typ: uint8_t, Wertebereich: [0 bis 255] ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Liest ein Byte an Daten vom 1-Wire Bus.

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

Für ret_status:

TF_ONE_WIRE_STATUS_OK = 0
TF_ONE_WIRE_STATUS_BUSY = 1
TF_ONE_WIRE_STATUS_NO_PRESENCE = 2
TF_ONE_WIRE_STATUS_TIMEOUT = 3
TF_ONE_WIRE_STATUS_ERROR = 4

int tf_one_wire_write_command(TF_OneWire *one_wire, uint64_t identifier, uint8_t command, uint8_t *ret_status)¶

Parameter:	one_wire – Typ: TF_OneWire * identifier – Typ: uint64_t, Wertebereich: [0 bis 2⁶⁴ - 1] command – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Sendet einen Befehl an das 1-Wire Gerät mit der angegebenen Identifier. Die Liste der Identifier können mittels tf_one_wire_search_bus() ermittelt werden. Die MATCH ROM Operation wird verwendet, um den Befehl zu übertragen.

Wenn nur ein Gerät angeschlossen ist, oder der Befehl an alle Geräte gesendet werden soll kann als Identifier 0 verwendet werden. Dann wird die SKIP ROM Operation verwendet, um den Befehl zu übertragen.

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

Für ret_status:

TF_ONE_WIRE_STATUS_OK = 0
TF_ONE_WIRE_STATUS_BUSY = 1
TF_ONE_WIRE_STATUS_NO_PRESENCE = 2
TF_ONE_WIRE_STATUS_TIMEOUT = 3
TF_ONE_WIRE_STATUS_ERROR = 4

Fortgeschrittene Funktionen¶

int tf_one_wire_set_communication_led_config(TF_OneWire *one_wire, uint8_t config)¶

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

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die 1-Wire Kommunikation durch Aufblinken an.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

TF_ONE_WIRE_COMMUNICATION_LED_CONFIG_OFF = 0
TF_ONE_WIRE_COMMUNICATION_LED_CONFIG_ON = 1
TF_ONE_WIRE_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_ONE_WIRE_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_one_wire_get_communication_led_config(TF_OneWire *one_wire, uint8_t *ret_config)¶

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

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

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

Für ret_config:

TF_ONE_WIRE_COMMUNICATION_LED_CONFIG_OFF = 0
TF_ONE_WIRE_COMMUNICATION_LED_CONFIG_ON = 1
TF_ONE_WIRE_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_ONE_WIRE_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_one_wire_get_spitfp_error_count(TF_OneWire *one_wire, 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:	one_wire – Typ: TF_OneWire *
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 tf_one_wire_set_status_led_config(TF_OneWire *one_wire, uint8_t config)¶

Parameter:	one_wire – Typ: TF_OneWire * 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:

TF_ONE_WIRE_STATUS_LED_CONFIG_OFF = 0
TF_ONE_WIRE_STATUS_LED_CONFIG_ON = 1
TF_ONE_WIRE_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_ONE_WIRE_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_one_wire_get_status_led_config(TF_OneWire *one_wire, uint8_t *ret_config)¶

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

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

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

Für ret_config:

TF_ONE_WIRE_STATUS_LED_CONFIG_OFF = 0
TF_ONE_WIRE_STATUS_LED_CONFIG_ON = 1
TF_ONE_WIRE_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_ONE_WIRE_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_one_wire_get_chip_temperature(TF_OneWire *one_wire, int16_t *ret_temperature)¶

Parameter:	one_wire – Typ: TF_OneWire *
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 tf_one_wire_reset(TF_OneWire *one_wire)¶

Parameter:	one_wire – Typ: TF_OneWire *
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 tf_one_wire_get_identity(TF_OneWire *one_wire, 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:	one_wire – Typ: TF_OneWire *
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.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_one_wire_get_response_expected(TF_OneWire *one_wire, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	one_wire – Typ: TF_OneWire * 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 tf_one_wire_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:

TF_ONE_WIRE_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 6
TF_ONE_WIRE_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_ONE_WIRE_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_ONE_WIRE_FUNCTION_RESET = 243
TF_ONE_WIRE_FUNCTION_WRITE_UID = 248

int tf_one_wire_set_response_expected(TF_OneWire *one_wire, uint8_t function_id, bool response_expected)¶

Parameter:	one_wire – Typ: TF_OneWire * 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:

TF_ONE_WIRE_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 6
TF_ONE_WIRE_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_ONE_WIRE_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_ONE_WIRE_FUNCTION_RESET = 243
TF_ONE_WIRE_FUNCTION_WRITE_UID = 248

int tf_one_wire_set_response_expected_all(TF_OneWire *one_wire, bool response_expected)¶

Parameter:	one_wire – Typ: TF_OneWire * 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 tf_one_wire_set_bootloader_mode(TF_OneWire *one_wire, uint8_t mode, uint8_t *ret_status)¶

Parameter:	one_wire – Typ: TF_OneWire * 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:

TF_ONE_WIRE_BOOTLOADER_MODE_BOOTLOADER = 0
TF_ONE_WIRE_BOOTLOADER_MODE_FIRMWARE = 1
TF_ONE_WIRE_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_ONE_WIRE_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_ONE_WIRE_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_ONE_WIRE_BOOTLOADER_STATUS_OK = 0
TF_ONE_WIRE_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_ONE_WIRE_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_ONE_WIRE_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_ONE_WIRE_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_ONE_WIRE_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_one_wire_get_bootloader_mode(TF_OneWire *one_wire, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_ONE_WIRE_BOOTLOADER_MODE_BOOTLOADER = 0
TF_ONE_WIRE_BOOTLOADER_MODE_FIRMWARE = 1
TF_ONE_WIRE_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_ONE_WIRE_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_ONE_WIRE_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_one_wire_set_write_firmware_pointer(TF_OneWire *one_wire, uint32_t pointer)¶

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

Setzt den Firmware-Pointer für tf_one_wire_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 tf_one_wire_write_firmware(TF_OneWire *one_wire, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	one_wire – Typ: TF_OneWire * data – Typ: const 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 tf_one_wire_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 tf_one_wire_write_uid(TF_OneWire *one_wire, uint32_t uid)¶

Parameter:	one_wire – Typ: TF_OneWire * 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 tf_one_wire_read_uid(TF_OneWire *one_wire, uint32_t *ret_uid)¶

Parameter:	one_wire – Typ: TF_OneWire *
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¶

TF_ONE_WIRE_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein One Wire Bricklet zu identifizieren.

Die Funktionen tf_one_wire_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_ONE_WIRE_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines One Wire Bricklet dar.