Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / DC Bricklet 2.0

C/C++ für Mikrocontroller - DC Bricklet 2.0¶

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

Configuration¶

Download (example_configuration.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_dc_v2.h"

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

static TF_DCV2 dc;

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

    check(tf_dc_v2_set_drive_mode(&dc,
                                  TF_DC_V2_DRIVE_MODE_DRIVE_COAST), "call set_drive_mode");
    check(tf_dc_v2_set_pwm_frequency(&dc,
                                     10000), "call set_pwm_frequency"); // Use PWM frequency of 10 kHz
    check(tf_dc_v2_set_motion(&dc, 4096,
                              16384), "call set_motion"); // Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
    check(tf_dc_v2_set_velocity(&dc,
                                32767), "call set_velocity"); // Full speed forward (100 %)
    check(tf_dc_v2_set_enabled(&dc, true), "call set_enabled"); // Enable motor power
}

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

Callback¶

Download (example_callback.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_dc_v2.h"

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

// Use velocity reached callback to swing back and forth
// between full speed forward and full speed backward
static void velocity_reached_handler(TF_DCV2 *device, int16_t velocity, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    if(velocity == 32767) {
        tf_hal_printf("Velocity: Full speed forward, now turning backward\n");
        tf_dc_v2_set_velocity(device, -32767);
    } else if(velocity == -32767) {
        tf_hal_printf("Velocity: Full speed backward, now turning forward\n");
        tf_dc_v2_set_velocity(device, 32767);
    } else {
        tf_hal_printf("Error\n"); // Can only happen if another program sets velocity
    }
}

static TF_DCV2 dc;

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

    // The acceleration has to be smaller or equal to the maximum
    // acceleration of the DC motor, otherwise the velocity reached
    // callback will be called too early
    check(tf_dc_v2_set_motion(&dc, 4096,
                              16384), "call set_motion"); // Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
    check(tf_dc_v2_set_velocity(&dc,
                                32767), "call set_velocity"); // Full speed forward (100 %)

    // Register velocity reached callback to function velocity_reached_handler
    tf_dc_v2_register_velocity_reached_callback(&dc,
                                                velocity_reached_handler,
                                                NULL);

    // Enable motor power
    check(tf_dc_v2_set_enabled(&dc, true), "call set_enabled");
}

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_dc_v2_create(TF_DCV2 *dc_v2, const char *uid, TF_HAL *hal)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_DCV2 dc_v2;
tf_dc_v2_create(&dc_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_dc_v2_destroy(TF_DCV2 *dc_v2)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Rückgabe:	e_code – Typ: int

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

int tf_dc_v2_set_enabled(TF_DCV2 *dc_v2, bool enabled)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * enabled – Typ: bool
Rückgabe:	e_code – Typ: int

Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).

int tf_dc_v2_get_enabled(TF_DCV2 *dc_v2, bool *ret_enabled)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.

int tf_dc_v2_set_velocity(TF_DCV2 *dc_v2, int16_t velocity)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe tf_dc_v2_set_motion()) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe tf_dc_v2_set_pwm_frequency().

int tf_dc_v2_get_velocity(TF_DCV2 *dc_v2, int16_t *ret_velocity)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Ausgabeparameter:	ret_velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Geschwindigkeit zurück, wie gesetzt von tf_dc_v2_set_velocity().

int tf_dc_v2_get_current_velocity(TF_DCV2 *dc_v2, int16_t *ret_velocity)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Ausgabeparameter:	ret_velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von tf_dc_v2_get_velocity(), sobald der Motor auf einen neuen Zielwert, wie von tf_dc_v2_set_velocity() vorgegeben, beschleunigt.

int tf_dc_v2_set_motion(TF_DCV2 *dc_v2, uint16_t acceleration, uint16_t deceleration)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * acceleration – Typ: uint16_t, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000 deceleration – Typ: uint16_t, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000
Rückgabe:	e_code – Typ: int

Setzt die Beschleunigung/Debeschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung/Debeschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Rampe gefahren.

int tf_dc_v2_get_motion(TF_DCV2 *dc_v2, uint16_t *ret_acceleration, uint16_t *ret_deceleration)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Ausgabeparameter:	ret_acceleration – Typ: uint16_t, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000 ret_deceleration – Typ: uint16_t, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000
Rückgabe:	e_code – Typ: int

Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von tf_dc_v2_set_motion().

int tf_dc_v2_full_brake(TF_DCV2 *dc_v2)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Rückgabe:	e_code – Typ: int

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von tf_dc_v2_set_velocity() mit 0 erlaubt einen normalen Stopp des Motors.

int tf_dc_v2_get_pwm_frequency(TF_DCV2 *dc_v2, uint16_t *ret_frequency)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Ausgabeparameter:	ret_frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Rückgabe:	e_code – Typ: int

Gibt die PWM Frequenz zurück, wie gesetzt von tf_dc_v2_set_pwm_frequency().

int tf_dc_v2_get_power_statistics(TF_DCV2 *dc_v2, uint16_t *ret_voltage, uint16_t *ret_current)¶

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

Gibt die Eingangsspannung und den Stromverbrauch des Treibers zurück.

Fortgeschrittene Funktionen¶

int tf_dc_v2_set_drive_mode(TF_DCV2 *dc_v2, uint8_t mode)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den Fahrmodus. Verfügbare Modi sind:

0 = Fahren/Bremsen
1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

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

Für mode:

TF_DC_V2_DRIVE_MODE_DRIVE_BRAKE = 0
TF_DC_V2_DRIVE_MODE_DRIVE_COAST = 1

int tf_dc_v2_get_drive_mode(TF_DCV2 *dc_v2, uint8_t *ret_mode)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt den Fahrmodus zurück, wie von tf_dc_v2_set_drive_mode() gesetzt.

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

Für ret_mode:

TF_DC_V2_DRIVE_MODE_DRIVE_BRAKE = 0
TF_DC_V2_DRIVE_MODE_DRIVE_COAST = 1

int tf_dc_v2_set_pwm_frequency(TF_DCV2 *dc_v2, uint16_t frequency)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Rückgabe:	e_code – Typ: int

Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

int tf_dc_v2_set_error_led_config(TF_DCV2 *dc_v2, uint8_t config)¶

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

Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.

Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:

Aus: Es liegt kein Fehler vor.
1s Intervall-Blinken: Eingangsspannung zu klein (unter 6V).
250ms Intervall-Blinken: Übertemperatur oder Überstrom.

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

Für config:

TF_DC_V2_ERROR_LED_CONFIG_OFF = 0
TF_DC_V2_ERROR_LED_CONFIG_ON = 1
TF_DC_V2_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DC_V2_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_dc_v2_get_error_led_config(TF_DCV2 *dc_v2, uint8_t *ret_config)¶

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

Gibt die LED-Konfiguration zurück, wie von tf_dc_v2_set_error_led_config() gesetzt.

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

Für ret_config:

TF_DC_V2_ERROR_LED_CONFIG_OFF = 0
TF_DC_V2_ERROR_LED_CONFIG_ON = 1
TF_DC_V2_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DC_V2_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_dc_v2_get_spitfp_error_count(TF_DCV2 *dc_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:	dc_v2 – Typ: TF_DCV2 *
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_dc_v2_set_status_led_config(TF_DCV2 *dc_v2, uint8_t config)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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_DC_V2_STATUS_LED_CONFIG_OFF = 0
TF_DC_V2_STATUS_LED_CONFIG_ON = 1
TF_DC_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DC_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_dc_v2_get_status_led_config(TF_DCV2 *dc_v2, uint8_t *ret_config)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
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_dc_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_DC_V2_STATUS_LED_CONFIG_OFF = 0
TF_DC_V2_STATUS_LED_CONFIG_ON = 1
TF_DC_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DC_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_dc_v2_get_chip_temperature(TF_DCV2 *dc_v2, int16_t *ret_temperature)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
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_dc_v2_reset(TF_DCV2 *dc_v2)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
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_dc_v2_get_identity(TF_DCV2 *dc_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:	dc_v2 – Typ: TF_DCV2 *
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¶

int tf_dc_v2_set_emergency_shutdown_callback_configuration(TF_DCV2 *dc_v2, bool enabled)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert/Deaktiviert Emergency Shutdown Callback.

int tf_dc_v2_get_emergency_shutdown_callback_configuration(TF_DCV2 *dc_v2, bool *ret_enabled)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

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

int tf_dc_v2_set_velocity_reached_callback_configuration(TF_DCV2 *dc_v2, bool enabled)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert/Deaktiviert Velocity Reached Callback.

int tf_dc_v2_get_velocity_reached_callback_configuration(TF_DCV2 *dc_v2, bool *ret_enabled)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

int tf_dc_v2_set_current_velocity_callback_configuration(TF_DCV2 *dc_v2, uint32_t period, bool value_has_to_change)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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 Current Velocity 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.

int tf_dc_v2_get_current_velocity_callback_configuration(TF_DCV2 *dc_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
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 tf_dc_v2_set_current_velocity_callback_configuration() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_dc_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_dc_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_dc_v2_register_emergency_shutdown_callback(TF_DCV2 *dc_v2, TF_DCV2_EmergencyShutdownHandler handler, void *user_data)¶

void handler(TF_DCV2 *dc_v2, void *user_data)

Callback-Parameter:	dc_v2 – Typ: TF_DCV2 * user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet tf_dc_v2_set_enabled() muss aufgerufen werden, um den Motor erneut zu fahren.

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe tf_dc_v2_set_drive_mode()). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

int tf_dc_v2_register_velocity_reached_callback(TF_DCV2 *dc_v2, TF_DCV2_VelocityReachedHandler handler, void *user_data)¶

void handler(TF_DCV2 *dc_v2, int16_t velocity, void *user_data)

Callback-Parameter:	dc_v2 – Typ: TF_DCV2 * velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der Velocity Reached Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe tf_dc_v2_set_motion()) kleiner oder gleich der maximalen Beschleunigung des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

int tf_dc_v2_register_current_velocity_callback(TF_DCV2 *dc_v2, TF_DCV2_CurrentVelocityHandler handler, void *user_data)¶

void handler(TF_DCV2 *dc_v2, int16_t velocity, void *user_data)

Callback-Parameter:	dc_v2 – Typ: TF_DCV2 * velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit tf_dc_v2_set_current_velocity_callback_configuration(), ausgelöst. Der Parameter ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der Current Velocity Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

Virtuelle Funktionen¶

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

int tf_dc_v2_get_response_expected(TF_DCV2 *dc_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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_dc_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_DC_V2_FUNCTION_SET_ENABLED = 1
TF_DC_V2_FUNCTION_SET_VELOCITY = 3
TF_DC_V2_FUNCTION_SET_MOTION = 6
TF_DC_V2_FUNCTION_FULL_BRAKE = 8
TF_DC_V2_FUNCTION_SET_DRIVE_MODE = 9
TF_DC_V2_FUNCTION_SET_PWM_FREQUENCY = 11
TF_DC_V2_FUNCTION_SET_ERROR_LED_CONFIG = 14
TF_DC_V2_FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 16
TF_DC_V2_FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 18
TF_DC_V2_FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 20
TF_DC_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_DC_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_DC_V2_FUNCTION_RESET = 243
TF_DC_V2_FUNCTION_WRITE_UID = 248

int tf_dc_v2_set_response_expected(TF_DCV2 *dc_v2, uint8_t function_id, bool response_expected)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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_DC_V2_FUNCTION_SET_ENABLED = 1
TF_DC_V2_FUNCTION_SET_VELOCITY = 3
TF_DC_V2_FUNCTION_SET_MOTION = 6
TF_DC_V2_FUNCTION_FULL_BRAKE = 8
TF_DC_V2_FUNCTION_SET_DRIVE_MODE = 9
TF_DC_V2_FUNCTION_SET_PWM_FREQUENCY = 11
TF_DC_V2_FUNCTION_SET_ERROR_LED_CONFIG = 14
TF_DC_V2_FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 16
TF_DC_V2_FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 18
TF_DC_V2_FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 20
TF_DC_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_DC_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_DC_V2_FUNCTION_RESET = 243
TF_DC_V2_FUNCTION_WRITE_UID = 248

int tf_dc_v2_set_response_expected_all(TF_DCV2 *dc_v2, bool response_expected)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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_dc_v2_set_bootloader_mode(TF_DCV2 *dc_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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_DC_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_DC_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_DC_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_DC_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_DC_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_DC_V2_BOOTLOADER_STATUS_OK = 0
TF_DC_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_DC_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_DC_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_DC_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_DC_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_dc_v2_get_bootloader_mode(TF_DCV2 *dc_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_DC_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_DC_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_DC_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_DC_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_DC_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_dc_v2_set_write_firmware_pointer(TF_DCV2 *dc_v2, uint32_t pointer)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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_dc_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_dc_v2_write_firmware(TF_DCV2 *dc_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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_dc_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_dc_v2_write_uid(TF_DCV2 *dc_v2, uint32_t uid)¶

Parameter:	dc_v2 – Typ: TF_DCV2 * 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_dc_v2_read_uid(TF_DCV2 *dc_v2, uint32_t *ret_uid)¶

Parameter:	dc_v2 – Typ: TF_DCV2 *
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_DC_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein DC Bricklet 2.0 zu identifizieren.

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

TF_DC_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines DC Bricklet 2.0 dar.