Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / Segment Display 4x7 Bricklet 2.0

C/C++ für Mikrocontroller - Segment Display 4x7 Bricklet 2.0¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das Segment Display 4x7 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Segment Display 4x7 Bricklet 2.0 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).

Numeric Value¶

Download (example_numeric_value.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_segment_display_4x7_v2.h"

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

static TF_SegmentDisplay4x7V2 sd;

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

    check(tf_segment_display_4x7_v2_set_brightness(&sd,
                                                   7), "call set_brightness"); // Set to full brightness

    // Show "- 42" on the Display
    int8_t value[4] = {-2, -1, 4, 2};
    check(tf_segment_display_4x7_v2_set_numeric_value(&sd,
                                                      value), "call set_numeric_value");
}

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

Set Segments¶

Download (example_set_segments.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_segment_display_4x7_v2.h"

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

static TF_SegmentDisplay4x7V2 sd;

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

    check(tf_segment_display_4x7_v2_set_brightness(&sd,
                                                   7), "call set_brightness"); // Set to full brightness

    // Activate all segments
    bool digit0[8] = {true, true, true, true, true, true, true, true};
    bool digit1[8] = {true, true, true, true, true, true, true, true};
    bool digit2[8] = {true, true, true, true, true, true, true, true};
    bool digit3[8] = {true, true, true, true, true, true, true, true};
    bool colon[2] = {true, true};
    check(tf_segment_display_4x7_v2_set_segments(&sd, digit0, digit1, digit2, digit3,
                                                 colon, true), "call set_segments");
}

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

Blink Colon¶

Download (example_blink_colon.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_segment_display_4x7_v2.h"

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

static TF_SegmentDisplay4x7V2 sd;

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

    check(tf_segment_display_4x7_v2_set_brightness(&sd,
                                                   7), "call set_brightness"); // Set to full brightness

    // Blink colon 10 times
    int i;
    for (i = 0; i < 10; ++i) {

        // Activate segments of colon
        check(tf_segment_display_4x7_v2_set_selected_segment(&sd, 32,
                                                             true), "call set_selected_segment");
        check(tf_segment_display_4x7_v2_set_selected_segment(&sd, 33,
                                                             true), "call set_selected_segment");

        tf_hal_sleep_us(hal, 250 * 1000);

        // Deactivate segments of colon
        check(tf_segment_display_4x7_v2_set_selected_segment(&sd, 32,
                                                             false), "call set_selected_segment");
        check(tf_segment_display_4x7_v2_set_selected_segment(&sd, 33,
                                                             false), "call set_selected_segment");
    }
}

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_segment_display_4x7_v2_create(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, const char *uid, TF_HAL *hal)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_SegmentDisplay4x7V2 segment_display_4x7_v2;
tf_segment_display_4x7_v2_create(&segment_display_4x7_v2, 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_segment_display_4x7_v2_destroy(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
Rückgabe:	e_code – Typ: int

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

int tf_segment_display_4x7_v2_set_segments(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, const bool digit0[8], const bool digit1[8], const bool digit2[8], const bool digit3[8], const bool colon[2], bool tick)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * digit0 – Typ: const bool[8] digit1 – Typ: const bool[8] digit2 – Typ: const bool[8] digit3 – Typ: const bool[8] colon – Typ: const bool[2] tick – Typ: bool
Rückgabe:	e_code – Typ: int

Setzt die einzelnen Segmente des Segment Display 4x7 Bricklet 2.0 Segment für Segment.

Die Daten sind aufgeteilt in die vier Ziffern (digit0-3), dem Doppelpunkt (colon) und dem Hochkomma (tick).

Die Indizes der Segmente in den Ziffern und dem Doppelpunkt sind wie folgt aufgeteilt:

int tf_segment_display_4x7_v2_get_segments(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, bool ret_digit0[8], bool ret_digit1[8], bool ret_digit2[8], bool ret_digit3[8], bool ret_colon[2], bool *ret_tick)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
Ausgabeparameter:	ret_digit0 – Typ: bool[8] ret_digit1 – Typ: bool[8] ret_digit2 – Typ: bool[8] ret_digit3 – Typ: bool[8] ret_colon – Typ: bool[2] ret_tick – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt die Segmentdaten zurück, wie von tf_segment_display_4x7_v2_set_segments() gesetzt.

int tf_segment_display_4x7_v2_set_brightness(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t brightness)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * brightness – Typ: uint8_t, Wertebereich: [0 bis 7], Standardwert: 7
Rückgabe:	e_code – Typ: int

Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden.

int tf_segment_display_4x7_v2_get_brightness(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t *ret_brightness)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
Ausgabeparameter:	ret_brightness – Typ: uint8_t, Wertebereich: [0 bis 7], Standardwert: 7
Rückgabe:	e_code – Typ: int

Gibt die Helligkeit zurück, wie von tf_segment_display_4x7_v2_set_brightness() gesetzt.

int tf_segment_display_4x7_v2_set_numeric_value(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, const int8_t value[4])¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * value – Typ: const int8_t[4], Wertebereich: [-2 bis 15]
Rückgabe:	e_code – Typ: int

Setzt einen numerischen Wert für jede Ziffer. Die Werte repräsentieren:

-2: Minuszeichen
-1: Leerstelle
0-9: 0-9
10: A
11: b
12: C
13: d
14: E
15: F

Beispiel: Ein Aufruf mit [-2, -1, 4, 2] erzeugt eine Anzeige auf dem Display von "- 42".

int tf_segment_display_4x7_v2_set_selected_segment(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t segment, bool value)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * segment – Typ: uint8_t, Wertebereich: [0 bis 34] value – Typ: bool
Rückgabe:	e_code – Typ: int

Aktiviert/deaktiviert ein selektiertes Segment.

Die Indizes sind wie folgt aufgeteilt:

Indizes für einzeln selektierte Segmente

int tf_segment_display_4x7_v2_get_selected_segment(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t segment, bool *ret_value)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * segment – Typ: uint8_t, Wertebereich: [0 bis 34]
Ausgabeparameter:	ret_value – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt den Wert eines einzelnen Segments zurück.

Fortgeschrittene Funktionen¶

int tf_segment_display_4x7_v2_start_counter(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, int16_t value_from, int16_t value_to, int16_t increment, uint32_t length)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * value_from – Typ: int16_t, Wertebereich: [-999 bis 9999] value_to – Typ: int16_t, Wertebereich: [-999 bis 9999] increment – Typ: int16_t, Wertebereich: [-999 bis 9999] length – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Starter einen Zähler mit dem from Wert der bis zum to Wert zählt mit einer Schrittweite von increment. Das Argument length ist die Länge der Pause zwischen zwei Inkrements.

Beispiel: Wenn from auf 0, to auf 100, increment auf 1 und length auf 1000 gesetzt wird, wird ein Zähler gestartet der von 0 bis 100 zählt mit Rate von einer Sekunde zwischen jeder Erhöhung.

Wenn increment negativ ist läuft der Zähler rückwärts.

Der Zähler kann jederzeit durch einen Aufruf von tf_segment_display_4x7_v2_set_segments() oder tf_segment_display_4x7_v2_set_numeric_value() gestoppt werden.

int tf_segment_display_4x7_v2_get_counter_value(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint16_t *ret_value)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
Ausgabeparameter:	ret_value – Typ: uint16_t, Wertebereich: [-999 bis 9999]
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Zählerstand zurück der auf der Anzeige angezeigt wird.

Wenn kein Zähler läuft wird eine 0 zurückgegeben.

int tf_segment_display_4x7_v2_get_spitfp_error_count(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, 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:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
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_segment_display_4x7_v2_set_status_led_config(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t config)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * 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_SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_OFF = 0
TF_SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_ON = 1
TF_SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_segment_display_4x7_v2_get_status_led_config(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t *ret_config)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
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_segment_display_4x7_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_OFF = 0
TF_SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_ON = 1
TF_SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_segment_display_4x7_v2_get_chip_temperature(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, int16_t *ret_temperature)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
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_segment_display_4x7_v2_reset(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
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_segment_display_4x7_v2_get_identity(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, 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:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
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¶

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_segment_display_4x7_v2_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_segment_display_4x7_v2_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_segment_display_4x7_v2_register_counter_finished_callback(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, TF_SegmentDisplay4x7V2_CounterFinishedHandler handler, void *user_data)¶

void handler(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, void *user_data)

Callback-Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * user_data – Typ: void *

Diese Callback wird ausgelöst, wenn der Zähler (siehe tf_segment_display_4x7_v2_start_counter()) fertig ist.

Virtuelle Funktionen¶

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

int tf_segment_display_4x7_v2_get_response_expected(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * 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_segment_display_4x7_v2_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_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_SEGMENTS = 1
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_BRIGHTNESS = 3
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_NUMERIC_VALUE = 5
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_SELECTED_SEGMENT = 6
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_START_COUNTER = 8
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_RESET = 243
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_WRITE_UID = 248

int tf_segment_display_4x7_v2_set_response_expected(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t function_id, bool response_expected)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * 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_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_SEGMENTS = 1
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_BRIGHTNESS = 3
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_NUMERIC_VALUE = 5
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_SELECTED_SEGMENT = 6
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_START_COUNTER = 8
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_RESET = 243
TF_SEGMENT_DISPLAY_4X7_V2_FUNCTION_WRITE_UID = 248

int tf_segment_display_4x7_v2_set_response_expected_all(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, bool response_expected)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * 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_segment_display_4x7_v2_set_bootloader_mode(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * 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_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_OK = 0
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_segment_display_4x7_v2_get_bootloader_mode(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_segment_display_4x7_v2_set_write_firmware_pointer(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint32_t pointer)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * 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_segment_display_4x7_v2_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_segment_display_4x7_v2_write_firmware(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * 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_segment_display_4x7_v2_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_segment_display_4x7_v2_write_uid(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint32_t uid)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 * 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_segment_display_4x7_v2_read_uid(TF_SegmentDisplay4x7V2 *segment_display_4x7_v2, uint32_t *ret_uid)¶

Parameter:	segment_display_4x7_v2 – Typ: TF_SegmentDisplay4x7V2 *
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_SEGMENT_DISPLAY_4X7_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Segment Display 4x7 Bricklet 2.0 zu identifizieren.

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

TF_SEGMENT_DISPLAY_4X7_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Segment Display 4x7 Bricklet 2.0 dar.