C/C++ für Mikrocontroller - Silent Stepper Bricklet 2.0¶

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

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

static TF_SilentStepperV2 ss;

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

    check(tf_silent_stepper_v2_set_motor_current(&ss,
                                                 800), "call set_motor_current"); // 800 mA
    check(tf_silent_stepper_v2_set_step_configuration(&ss,
                                                      TF_SILENT_STEPPER_V2_STEP_RESOLUTION_8,
                                                      true), "call set_step_configuration"); // 1/8 steps (interpolated)
    check(tf_silent_stepper_v2_set_max_velocity(&ss,
                                                2000), "call set_max_velocity"); // Velocity 2000 steps/s

    // Slow acceleration (500 steps/s^2),
    // Fast deacceleration (5000 steps/s^2)
    check(tf_silent_stepper_v2_set_speed_ramping(&ss, 500,
                                                 5000), "call set_speed_ramping");

    check(tf_silent_stepper_v2_set_enabled(&ss,
                                           true), "call set_enabled"); // Enable motor power
    check(tf_silent_stepper_v2_set_steps(&ss,
                                         60000), "call set_steps"); // Drive 60000 steps forward
}

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_silent_stepper_v2.h"

// FIXME: This example is incomplete, missing tf_hal_random(min, max) function

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

// Use position reached callback to program random movement
static void position_reached_handler(TF_SilentStepperV2 *device, int32_t position,
                                     void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Position: %I32d\n", position);
}

static TF_SilentStepperV2 ss;

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

    // Register position reached callback to function position_reached_handler
    tf_silent_stepper_v2_register_position_reached_callback(&ss,
                                                            position_reached_handler,
                                                            NULL);

    check(tf_silent_stepper_v2_set_step_configuration(&ss,
                                                      TF_SILENT_STEPPER_V2_STEP_RESOLUTION_8,
                                                      true), "call set_step_configuration"); // 1/8 steps (interpolated)
    check(tf_silent_stepper_v2_set_enabled(&ss,
                                           true), "call set_enabled"); // Enable motor power
    check(tf_silent_stepper_v2_set_steps(&ss,
                                         1), "call set_steps"); // Drive one step forward to get things going
}

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_silent_stepper_v2_create(TF_SilentStepperV2 *silent_stepper_v2, const char *uid, TF_HAL *hal)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_SilentStepperV2 silent_stepper_v2;
tf_silent_stepper_v2_create(&silent_stepper_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_silent_stepper_v2_destroy(TF_SilentStepperV2 *silent_stepper_v2)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Rückgabe:	e_code – Typ: int

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

int tf_silent_stepper_v2_set_max_velocity(TF_SilentStepperV2 *silent_stepper_v2, uint16_t velocity)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Setzt die maximale Geschwindigkeit des Schrittmotors. Diese Funktion startet nicht den Motor, sondern setzt nur die maximale Geschwindigkeit auf welche der Schrittmotor beschleunigt wird. Um den Motor zu fahren können tf_silent_stepper_v2_set_target_position(), tf_silent_stepper_v2_set_steps(), tf_silent_stepper_v2_drive_forward() oder tf_silent_stepper_v2_drive_backward() verwendet werden.

int tf_silent_stepper_v2_get_max_velocity(TF_SilentStepperV2 *silent_stepper_v2, uint16_t *ret_velocity)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

int tf_silent_stepper_v2_get_current_velocity(TF_SilentStepperV2 *silent_stepper_v2, uint16_t *ret_velocity)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

int tf_silent_stepper_v2_set_speed_ramping(TF_SilentStepperV2 *silent_stepper_v2, uint16_t acceleration, uint16_t deacceleration)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * acceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 deacceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000
Rückgabe:	e_code – Typ: int

Setzt die Beschleunigung und die Verzögerung des Schrittmotors. Eine Beschleunigung von 1000 bedeutet, dass jede Sekunde die Geschwindigkeit um 1000 Schritte/s erhöht wird.

Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist und es soll auf eine Geschwindigkeit von 8000 Schritten/s in 10 Sekunden beschleunigt werden, muss die Beschleunigung auf 800 Schritte/s² gesetzt werden.

Eine Beschleunigung/Verzögerung von 0 bedeutet ein sprunghaftes Beschleunigen/Verzögern (nicht empfohlen).

int tf_silent_stepper_v2_get_speed_ramping(TF_SilentStepperV2 *silent_stepper_v2, uint16_t *ret_acceleration, uint16_t *ret_deacceleration)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_acceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 ret_deacceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000
Rückgabe:	e_code – Typ: int

Gibt die Beschleunigung und Verzögerung zurück, wie von tf_silent_stepper_v2_set_speed_ramping() gesetzt.

int tf_silent_stepper_v2_full_brake(TF_SilentStepperV2 *silent_stepper_v2)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
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_silent_stepper_v2_stop() stoppt den Motor.

int tf_silent_stepper_v2_set_steps(TF_SilentStepperV2 *silent_stepper_v2, int32_t steps)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * steps – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Setzt die Anzahl der Schritte die der Schrittmotor fahren soll. Positive Werte fahren den Motor vorwärts und negative rückwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit tf_silent_stepper_v2_set_max_velocity() und tf_silent_stepper_v2_set_speed_ramping() gesetzt, verwendet.

int tf_silent_stepper_v2_get_steps(TF_SilentStepperV2 *silent_stepper_v2, int32_t *ret_steps)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_steps – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt die letzten Schritte zurück, wie von tf_silent_stepper_v2_set_steps() gesetzt.

int tf_silent_stepper_v2_get_remaining_steps(TF_SilentStepperV2 *silent_stepper_v2, int32_t *ret_steps)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_steps – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt die verbleibenden Schritte des letzten Aufrufs von tf_silent_stepper_v2_set_steps() zurück. Beispiel: Wenn tf_silent_stepper_v2_set_steps() mit 2000 aufgerufen wird und tf_silent_stepper_v2_get_remaining_steps() aufgerufen wird wenn der Motor 500 Schritte fahren hat, wird 1500 zurückgegeben.

int tf_silent_stepper_v2_drive_forward(TF_SilentStepperV2 *silent_stepper_v2)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Rückgabe:	e_code – Typ: int

Fährt den Schrittmotor vorwärts bis tf_silent_stepper_v2_drive_backward() oder tf_silent_stepper_v2_stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit tf_silent_stepper_v2_set_max_velocity() und tf_silent_stepper_v2_set_speed_ramping() gesetzt, verwendet.

int tf_silent_stepper_v2_drive_backward(TF_SilentStepperV2 *silent_stepper_v2)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Rückgabe:	e_code – Typ: int

Fährt den Schrittmotor rückwärts bis tf_silent_stepper_v2_drive_forward() oder tf_silent_stepper_v2_stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit tf_silent_stepper_v2_set_max_velocity() und tf_silent_stepper_v2_set_speed_ramping() gesetzt, verwendet.

int tf_silent_stepper_v2_stop(TF_SilentStepperV2 *silent_stepper_v2)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Rückgabe:	e_code – Typ: int

Stoppt den Schrittmotor mit der Verzögerung, wie von tf_silent_stepper_v2_set_speed_ramping() gesetzt.

int tf_silent_stepper_v2_set_motor_current(TF_SilentStepperV2 *silent_stepper_v2, uint16_t current)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800
Rückgabe:	e_code – Typ: int

Setzt den Strom mit welchem der Motor angetrieben wird.

Warnung

Dieser Wert sollte nicht über die Spezifikation des Schrittmotors gesetzt werden. Sonst ist eine Beschädigung des Motors möglich.

int tf_silent_stepper_v2_get_motor_current(TF_SilentStepperV2 *silent_stepper_v2, uint16_t *ret_current)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800
Rückgabe:	e_code – Typ: int

Gibt den Strom zurück, wie von tf_silent_stepper_v2_set_motor_current() gesetzt.

int tf_silent_stepper_v2_set_enabled(TF_SilentStepperV2 *silent_stepper_v2, bool enabled)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

Warnung

Die Treiberstufe zu deaktivieren während der Motor sich noch dreht kann zur Beschädigung der Treiberstufe führen. Der Motor sollte durch Aufrufen der tf_silent_stepper_v2_stop() Funktion gestoppt werden, bevor die Treiberstufe deaktiviert wird. Die tf_silent_stepper_v2_stop() Funktion wartet nicht bis der Motor wirklich zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der tf_silent_stepper_v2_stop() Funktion eine angemessen Zeit gewartet werden bevor die Funktion tf_silent_stepper_v2_set_enabled() mit false aufgerufen wird.

int tf_silent_stepper_v2_get_enabled(TF_SilentStepperV2 *silent_stepper_v2, bool *ret_enabled)¶

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

Gibt zurück ob der Schrittmotortreiber aktiviert ist.

int tf_silent_stepper_v2_set_basic_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint16_t standstill_current, uint16_t motor_run_current, uint16_t standstill_delay_time, uint16_t power_down_time, uint16_t stealth_threshold, uint16_t coolstep_threshold, uint16_t classic_threshold, bool high_velocity_chopper_mode)¶

Parameter:

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * standstill_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 motor_run_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 800 standstill_delay_time – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0 power_down_time – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000 stealth_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500 coolstep_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500 classic_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 high_velocity_chopper_mode – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

silent_stepper_v2 – Typ: TF_SilentStepperV2 *
standstill_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200
motor_run_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 800
standstill_delay_time – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0
power_down_time – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000
stealth_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500
coolstep_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500
classic_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000
high_velocity_chopper_mode – Typ: bool, Standardwert: false

Rückgabe:

e_code – Typ: int

Setzt die Basiskonfiguration-Parameter für verschiedene Modi (Stealth, Coolstep, Classic).

Standstill Current: Mit diesem Wert kann der Phasenstrom im Stillstand reduziert werden. Dies ist zum Beispiel sinnvoll um das Aufheizen des Motors zu verringern. Wenn der Motor steht wird dieser mit dem eingestellte Phasenstrom betrieben bis die eingestellte Power Down Time um ist. Danach wird der Phasenstrom schrittweise bis zum Standstill Current reduziert. Die dafür benötigte Zeit wird mittels Power Down Time eingestellt. Der eingestellte Phasenstrom ist das Maximum für diesen Wert (see tf_silent_stepper_v2_set_motor_current()).
Motor Run Current: Dieser Wert setzt den Phasenstrom, wenn der Motor sich dreht. Ein Wert von mindestens der Hälfte des maximalen Phasenstrom sollte für gute Ergebnisse im Mikroschrittbetrieb gesetzt werden. Der maximal zulässige Wert ist der maximale Phasenstrom. Der eingegebene Wert wird von der API intern in einen Faktor im Bereich von 1/32 ... 32/32 umgerechnet, mit dem der Phasenstrom begrenzt wird. Der maximale Phasenstrom sollte im laufenden Betrieb nicht geändert werden. Für eine Änderung im laufenden Betrieb ist dieser Wert da (see tf_silent_stepper_v2_set_motor_current()).
Standstill Delay Time: Steuert die Zeit für das Verringern des Motorstroms bis zum Standstill Current. Eine hohe Standstill Delay Time führt zu einem ruhigen und ruckelfreien Übergang.
Power Down Time: Setzt die Wartezeit nach dem Stehenbleiben.
Stealth Threshold: Setzt den oberen Grenzwert für den Stealth Modus. Wenn die Geschwindigkeit des Motors über diesem Wert liegt wird der Stealth Modus abgeschaltet. Ansonsten angeschaltet. Im Stealth Modus nimmt das Drehmoment mit steigender Geschwindigkeit ab.
Coolstep Threshold: Setzt den unteren Grenzwert für den Coolstep Modus. Der Coolstep Grenzwert muss über dem Stealth Grenzwert liegen.
Classic Threshold: Sets den unteren Grenzwert für den Classic Modus. Im Classic Modus wird der Schrittmotor geräuschvoll aber das Drehmoment wird maximiert.
High Velocity Chopper Mode: Wenn der High Velocity Chopper Modus aktiviert wird, optimiert der Schrittmotortreiber die Ansteuerung des Motors für hohe Geschwindigkeiten.

Wenn alle drei Grenzwerte (Thresholds) genutzt werden sollen muss sichergestellt werden, dass Stealth Threshold < Coolstep Threshold < Classic Threshold.

int tf_silent_stepper_v2_get_basic_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint16_t *ret_standstill_current, uint16_t *ret_motor_run_current, uint16_t *ret_standstill_delay_time, uint16_t *ret_power_down_time, uint16_t *ret_stealth_threshold, uint16_t *ret_coolstep_threshold, uint16_t *ret_classic_threshold, bool *ret_high_velocity_chopper_mode)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_standstill_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 ret_motor_run_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 800 ret_standstill_delay_time – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0 ret_power_down_time – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000 ret_stealth_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500 ret_coolstep_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500 ret_classic_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 ret_high_velocity_chopper_mode – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

int tf_silent_stepper_v2_set_gpio_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint8_t channel, uint16_t debounce, uint16_t stop_deceleration)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] debounce – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 stop_deceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Rückgabe:	e_code – Typ: int

Setzt die GPIO-Konfiguration für einen Kanal. Es kann ein Debounce und eine Debeschleunigung gesetzt werden. Letzteres wird genutzt wenn die Action auf normal stop konfiguriert ist. Siehe tf_silent_stepper_v2_set_gpio_action().

int tf_silent_stepper_v2_get_gpio_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint8_t channel, uint16_t *ret_debounce, uint16_t *ret_stop_deceleration)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
Ausgabeparameter:	ret_debounce – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 ret_stop_deceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Rückgabe:	e_code – Typ: int

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von tf_silent_stepper_v2_set_gpio_configuration() gesetzt.

int tf_silent_stepper_v2_set_gpio_action(TF_SilentStepperV2 *silent_stepper_v2, uint8_t channel, uint32_t action)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1] action – Typ: uint32_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die GPIO-Action für einen Kanal.

Die Action kann ein normal stop, ein full brake oder ein callback sein. Jeweils für eine steigende oder fallende Flanke. Die Actions sind eine Bitmaske und sie können simultan verwendet werden. Es ist zum Beispiel möglich einen full brake und callback gleichzeitig zu triggern oder eine auf eine steigende und fallende Flanke gleichzeitig.

Die Debeschleunigung für den normal stop kann über tf_silent_stepper_v2_set_gpio_configuration() konfiguriert werden.

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

Für action:

TF_SILENT_STEPPER_V2_GPIO_ACTION_NONE = 0
TF_SILENT_STEPPER_V2_GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
TF_SILENT_STEPPER_V2_GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
TF_SILENT_STEPPER_V2_GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
TF_SILENT_STEPPER_V2_GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
TF_SILENT_STEPPER_V2_GPIO_ACTION_CALLBACK_RISING_EDGE = 16
TF_SILENT_STEPPER_V2_GPIO_ACTION_CALLBACK_FALLING_EDGE = 32

int tf_silent_stepper_v2_get_gpio_action(TF_SilentStepperV2 *silent_stepper_v2, uint8_t channel, uint32_t *ret_action)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * channel – Typ: uint8_t, Wertebereich: [0 bis 1]
Ausgabeparameter:	ret_action – Typ: uint32_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die GPIO-Action für einen Kanal zurück, wie von tf_silent_stepper_v2_set_gpio_action() gesetzt.

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

Für ret_action:

TF_SILENT_STEPPER_V2_GPIO_ACTION_NONE = 0
TF_SILENT_STEPPER_V2_GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
TF_SILENT_STEPPER_V2_GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
TF_SILENT_STEPPER_V2_GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
TF_SILENT_STEPPER_V2_GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
TF_SILENT_STEPPER_V2_GPIO_ACTION_CALLBACK_RISING_EDGE = 16
TF_SILENT_STEPPER_V2_GPIO_ACTION_CALLBACK_FALLING_EDGE = 32

int tf_silent_stepper_v2_get_gpio_state(TF_SilentStepperV2 *silent_stepper_v2, bool ret_gpio_state[2])¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_gpio_state – Typ: bool[2]
Rückgabe:	e_code – Typ: int

Gibt den GPIO-Zustand für beide Kanäle zurück. True wenn der der Zustand high ist und false wenn der Zustand low ist.

Fortgeschrittene Funktionen¶

int tf_silent_stepper_v2_set_current_position(TF_SilentStepperV2 *silent_stepper_v2, int32_t position)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * position – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Setzt den aktuellen Schrittwert des internen Schrittzählers. Dies kann benutzt werden um die aktuelle Position auf 0 zu setzen wenn ein definierter Startpunkt erreicht wurde (z.B. wenn eine CNC Maschine eine Ecke erreicht).

int tf_silent_stepper_v2_get_current_position(TF_SilentStepperV2 *silent_stepper_v2, int32_t *ret_position)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_position – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Position des Schrittmotors in Schritten zurück. Nach dem Hochfahren ist die Position 0. Die Schritte werden bei Verwendung aller möglichen Fahrfunktionen gezählt (tf_silent_stepper_v2_set_target_position(), tf_silent_stepper_v2_set_steps(), tf_silent_stepper_v2_drive_forward() der tf_silent_stepper_v2_drive_backward()). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit tf_silent_stepper_v2_set_current_position().

int tf_silent_stepper_v2_set_target_position(TF_SilentStepperV2 *silent_stepper_v2, int32_t position)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * position – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und tf_silent_stepper_v2_set_target_position() mit 1000 aufgerufen wird, dann verfährt der Schrittmotor 500 Schritte vorwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit tf_silent_stepper_v2_set_max_velocity() und tf_silent_stepper_v2_set_speed_ramping() gesetzt, verwendet.

Ein Aufruf von tf_silent_stepper_v2_set_target_position() mit dem Parameter x ist äquivalent mit einem Aufruf von tf_silent_stepper_v2_set_steps() mit dem Parameter (x - tf_silent_stepper_v2_get_current_position()).

int tf_silent_stepper_v2_get_target_position(TF_SilentStepperV2 *silent_stepper_v2, int32_t *ret_position)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_position – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt die letzte Zielposition zurück, wie von tf_silent_stepper_v2_set_target_position() gesetzt.

int tf_silent_stepper_v2_set_step_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint8_t step_resolution, bool interpolation)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * step_resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 interpolation – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Setzt die Schrittauflösung von Vollschritt bis zu 1/256 Schritt.

Wenn Interpolation aktiviert ist, führt der Silent Stepper Bricklet 2.0 immer 1/256 interpolierte Schritte aus. Wenn zum Beispiel Vollschritt mit Interpolation genutzt wird, führt jeder Schritt zu 256 1/256 Schritten beim Motor.

Für einen maximalen Drehmoment sollte Vollschritt mit Interpolation genutzt werden. Für maximale Auflösung sollte 1/256 Schritt genutzt werden. Interpolation führt auch dazu, dass der Motor weniger Geräusche erzeugt.

Für den Fall, dass oft die Geschwindigkeit mit sehr hohen Beschleunigungen geändert wird, sollte Interpolation ausgeschaltet werden.

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

Für step_resolution:

TF_SILENT_STEPPER_V2_STEP_RESOLUTION_1 = 8
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_2 = 7
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_4 = 6
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_8 = 5
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_16 = 4
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_32 = 3
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_64 = 2
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_128 = 1
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_256 = 0

int tf_silent_stepper_v2_get_step_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint8_t *ret_step_resolution, bool *ret_interpolation)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_step_resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_interpolation – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Gibt den Schrittmodus zurück, wie von tf_silent_stepper_v2_set_step_configuration() gesetzt.

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

Für ret_step_resolution:

TF_SILENT_STEPPER_V2_STEP_RESOLUTION_1 = 8
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_2 = 7
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_4 = 6
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_8 = 5
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_16 = 4
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_32 = 3
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_64 = 2
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_128 = 1
TF_SILENT_STEPPER_V2_STEP_RESOLUTION_256 = 0

int tf_silent_stepper_v2_get_input_voltage(TF_SilentStepperV2 *silent_stepper_v2, uint16_t *ret_voltage)¶

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

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Silent Stepper Bricklet 2.0, eingespeist.

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, wird der Motor über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung des Motors über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung des Motors über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung des Motors über die höhere Versorgungsspannung des Stapels.

int tf_silent_stepper_v2_set_spreadcycle_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint8_t slow_decay_duration, bool enable_random_slow_decay, uint8_t fast_decay_duration, uint8_t hysteresis_start_value, int8_t hysteresis_end_value, int8_t sine_wave_offset, uint8_t chopper_mode, uint8_t comparator_blank_time, bool fast_decay_without_comparator)¶

Parameter:

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * slow_decay_duration – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 4 enable_random_slow_decay – Typ: bool, Standardwert: false fast_decay_duration – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 0 hysteresis_start_value – Typ: uint8_t, Wertebereich: [0 bis 7], Standardwert: 0 hysteresis_end_value – Typ: int8_t, Wertebereich: [-3 bis 12], Standardwert: 0 sine_wave_offset – Typ: int8_t, Wertebereich: [-3 bis 12], Standardwert: 0 chopper_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 comparator_blank_time – Typ: uint8_t, Wertebereich: [0 bis 3], Standardwert: 1 fast_decay_without_comparator – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

silent_stepper_v2 – Typ: TF_SilentStepperV2 *
slow_decay_duration – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 4
enable_random_slow_decay – Typ: bool, Standardwert: false
fast_decay_duration – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 0
hysteresis_start_value – Typ: uint8_t, Wertebereich: [0 bis 7], Standardwert: 0
hysteresis_end_value – Typ: int8_t, Wertebereich: [-3 bis 12], Standardwert: 0
sine_wave_offset – Typ: int8_t, Wertebereich: [-3 bis 12], Standardwert: 0
chopper_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
comparator_blank_time – Typ: uint8_t, Wertebereich: [0 bis 3], Standardwert: 1
fast_decay_without_comparator – Typ: bool, Standardwert: false

Rückgabe:

e_code – Typ: int

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Spreadcycle Konfigurationsparameter. Spreadcycle ist ein Chopper-Algorithmus der aktiv den Motorstrom regelt. Weitere Informationen dazu können im TMC2130 Datenblatt auf Seite 47 (7 spreadCycle and Classic Chopper) gefunden werden.

Slow Decay Duration: Steuert die Aus-Zeit (off time) in der Slow Decay Phase. 0 = Treiber deaktiviert, alle Brücken aus. Nur wenn die Comparator Blank Time >=2 ist sollte ein Wert von 1 gesetzt werden.
Enable Random Slow Decay: Muss auf False gesetzt werden um die Aus-Zeit (off time) des Choppers auf die gesetzte Slow Decay Duration zu setzen. Wenn dieser Wert auf True gesetzt wird, wird die Decay Dauer zufällig variiert.
Fast Decay Duration: Setzt die Fast Decay Dauer. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Hysteresis Start Value: Setzt der Startwert der Hysterese. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Hysteresis End Value: Setzt den Endwert der Hysterese. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Sinewave Offset: Setzt den Sinuswellen Offset. Der Wert wird nur benutzt, wenn als Chopper Modus Fast Decay benutzt wird. 1/512 dieses Werts wird zum Absolutwert der Sinuswelle hinzuaddiert.
Chopper Mode: 0 = Spread Cycle, 1 = Fast Decay.
Comperator Blank Time: Setzt die Totzeit von Komparator. Mögliche Werte sind
- 0 = 16 Takte,
- 1 = 24 Takte,
- 2 = 36 Takte und
- 3 = 54 Takte.
Ein Wert von 1 oder 2 wird für die meisten Anwendungen empfohlen.
Fast Decay Without Comperator: Wenn dieser Wert auf True gesetzt wird, dann wird der Strom-Komparator nicht im Fast Decay Modus genutzt.

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

Für chopper_mode:

TF_SILENT_STEPPER_V2_CHOPPER_MODE_SPREAD_CYCLE = 0
TF_SILENT_STEPPER_V2_CHOPPER_MODE_FAST_DECAY = 1

int tf_silent_stepper_v2_get_spreadcycle_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint8_t *ret_slow_decay_duration, bool *ret_enable_random_slow_decay, uint8_t *ret_fast_decay_duration, uint8_t *ret_hysteresis_start_value, int8_t *ret_hysteresis_end_value, int8_t *ret_sine_wave_offset, uint8_t *ret_chopper_mode, uint8_t *ret_comparator_blank_time, bool *ret_fast_decay_without_comparator)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_slow_decay_duration – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 4 ret_enable_random_slow_decay – Typ: bool, Standardwert: false ret_fast_decay_duration – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 0 ret_hysteresis_start_value – Typ: uint8_t, Wertebereich: [0 bis 7], Standardwert: 0 ret_hysteresis_end_value – Typ: int8_t, Wertebereich: [-3 bis 12], Standardwert: 0 ret_sine_wave_offset – Typ: int8_t, Wertebereich: [-3 bis 12], Standardwert: 0 ret_chopper_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_comparator_blank_time – Typ: uint8_t, Wertebereich: [0 bis 3], Standardwert: 1 ret_fast_decay_without_comparator – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

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

Für ret_chopper_mode:

TF_SILENT_STEPPER_V2_CHOPPER_MODE_SPREAD_CYCLE = 0
TF_SILENT_STEPPER_V2_CHOPPER_MODE_FAST_DECAY = 1

int tf_silent_stepper_v2_set_stealth_configuration(TF_SilentStepperV2 *silent_stepper_v2, bool enable_stealth, uint8_t amplitude, uint8_t gradient, bool enable_autoscale, bool force_symmetric, uint8_t freewheel_mode)¶

Parameter:

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * enable_stealth – Typ: bool, Standardwert: true amplitude – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 128 gradient – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 4 enable_autoscale – Typ: bool, Standardwert: true force_symmetric – Typ: bool, Standardwert: false freewheel_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

silent_stepper_v2 – Typ: TF_SilentStepperV2 *
enable_stealth – Typ: bool, Standardwert: true
amplitude – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 128
gradient – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 4
enable_autoscale – Typ: bool, Standardwert: true
force_symmetric – Typ: bool, Standardwert: false
freewheel_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0

Rückgabe:

e_code – Typ: int

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Konfigurationsparameter für den Stealth Modus.

Enable Stealth: Stealth Modus wird aktiviert, wenn dieser Wert auf True gesetzt wird. Ansonsten ist der Modus deaktiviert auch wenn die Geschwindigkeit des Motors unter dem Grenzwert, der mittels tf_silent_stepper_v2_set_basic_configuration() gesetzt wurde, liegt.
Amplitude: Wenn Autoscale aktiviert wurde, wird die PWM Amplitude mit diesem Wert skaliert. Wenn autoscale deaktiviert ist, definiert dieser Wert die maximale PWM Amplitudenänderungen pro Halbwelle.
Gradient: Wenn Autoscale deaktiviert wurde, wird der PWM Steigung (Gradient) bei diesem Wert skaliert. Wird Autoscale aktiviert, definiert dieser Wert die maximale PWM Steigung. Mit Autoscale wird ein Wert über 64 empfohlen, ansonsten kann es sein, dass die Regelung den Strom nicht korrekt messen kann.
Enable Autoscale: Die automatische Stromregelung ist aktiviert, wenn dieser Wert auf True gesetzt wird. Ansonsten werden die vom Nutzer definierten Amplituden und Steigungen genutzt.
Force Symmetric: Wenn auf True gesetzt wird, dann wird ein symmetrisches PWM erzwungen. Ansonsten kann sich der PWM Wert innerhalb eines PWM Taktes ändern.
Freewheel Mode: Der Freewheel Modus definiert das Verhalten im Stillstand, wenn der Standstill Current (siehe tf_silent_stepper_v2_set_basic_configuration()) auf 0 gesetzt wurde.

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

Für freewheel_mode:

TF_SILENT_STEPPER_V2_FREEWHEEL_MODE_NORMAL = 0
TF_SILENT_STEPPER_V2_FREEWHEEL_MODE_FREEWHEELING = 1
TF_SILENT_STEPPER_V2_FREEWHEEL_MODE_COIL_SHORT_LS = 2
TF_SILENT_STEPPER_V2_FREEWHEEL_MODE_COIL_SHORT_HS = 3

int tf_silent_stepper_v2_get_stealth_configuration(TF_SilentStepperV2 *silent_stepper_v2, bool *ret_enable_stealth, uint8_t *ret_amplitude, uint8_t *ret_gradient, bool *ret_enable_autoscale, bool *ret_force_symmetric, uint8_t *ret_freewheel_mode)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_enable_stealth – Typ: bool, Standardwert: true ret_amplitude – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 128 ret_gradient – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 4 ret_enable_autoscale – Typ: bool, Standardwert: true ret_force_symmetric – Typ: bool, Standardwert: false ret_freewheel_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_freewheel_mode:

TF_SILENT_STEPPER_V2_FREEWHEEL_MODE_NORMAL = 0
TF_SILENT_STEPPER_V2_FREEWHEEL_MODE_FREEWHEELING = 1
TF_SILENT_STEPPER_V2_FREEWHEEL_MODE_COIL_SHORT_LS = 2
TF_SILENT_STEPPER_V2_FREEWHEEL_MODE_COIL_SHORT_HS = 3

int tf_silent_stepper_v2_set_coolstep_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint8_t minimum_stallguard_value, uint8_t maximum_stallguard_value, uint8_t current_up_step_width, uint8_t current_down_step_width, uint8_t minimum_current, int8_t stallguard_threshold_value, uint8_t stallguard_mode)¶

Parameter:

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * minimum_stallguard_value – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 2 maximum_stallguard_value – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 10 current_up_step_width – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 current_down_step_width – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 minimum_current – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 stallguard_threshold_value – Typ: int8_t, Wertebereich: [-64 bis 63], Standardwert: 0 stallguard_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

silent_stepper_v2 – Typ: TF_SilentStepperV2 *
minimum_stallguard_value – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 2
maximum_stallguard_value – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 10
current_up_step_width – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
current_down_step_width – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
minimum_current – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
stallguard_threshold_value – Typ: int8_t, Wertebereich: [-64 bis 63], Standardwert: 0
stallguard_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0

Rückgabe:

e_code – Typ: int

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Konfigurationsparameter für Coolstep.

Minimum Stallguard Value: Wenn der Stallguard-Wert unter diesem Wert*32 fällt wird der Motorstrom erhöht um den Motorbelastungswinkel (motor load angle) zu reduzieren. Ein Wert von 0 deaktiviert Coolstep.
Maximum Stallguard Value: Wenn der Stallguard-Wert über (Min Stallguard Value + Max Stallguard Value + 1)*32 geht wird der Motorstrom verringert um Energie zu sparen.
Current Up Step Width: Setzt das Inkrement pro Stallguard-Wert. Der Wertebereich ist 0-3, was mit den Inkrementen 1, 2, 4 und 8 korrespondiert.
Current Down Step Width: Setzt das Decrement pro Stallguard-Wert. Der Wertebereich ist 0-3, was mit den Dekrementen 1, 2, 8 und 16 korrespondiert.
Minimum Current: Setzt den minimalen Strom für die Coolstep Stromregelung. Es kann zwischen der Hälfte und einem Viertel des Motorstroms gewählt werden.
Stallguard Threshold Value: Setzt den Grenzwert für die Stall-Ausgabe (Motor blockiert) (siehe tf_silent_stepper_v2_get_driver_status()). Ein niedriger Wert führt zu einer höheren Empfindlichkeit. Der korrekte Wert muss typischerweise ausprobiert werden. 0 sollte für die meisten Motoren funktionieren.
Stallguard Mode: Setze 0 für eine Standardauflösung und 1 für Filtered Mode. Im Filtered Modus wird das Stallguard Signal nur alle vier Vollschritte aktualisiert.

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

Für current_up_step_width:

TF_SILENT_STEPPER_V2_CURRENT_UP_STEP_INCREMENT_1 = 0
TF_SILENT_STEPPER_V2_CURRENT_UP_STEP_INCREMENT_2 = 1
TF_SILENT_STEPPER_V2_CURRENT_UP_STEP_INCREMENT_4 = 2
TF_SILENT_STEPPER_V2_CURRENT_UP_STEP_INCREMENT_8 = 3

Für current_down_step_width:

TF_SILENT_STEPPER_V2_CURRENT_DOWN_STEP_DECREMENT_1 = 0
TF_SILENT_STEPPER_V2_CURRENT_DOWN_STEP_DECREMENT_2 = 1
TF_SILENT_STEPPER_V2_CURRENT_DOWN_STEP_DECREMENT_8 = 2
TF_SILENT_STEPPER_V2_CURRENT_DOWN_STEP_DECREMENT_32 = 3

Für minimum_current:

TF_SILENT_STEPPER_V2_MINIMUM_CURRENT_HALF = 0
TF_SILENT_STEPPER_V2_MINIMUM_CURRENT_QUARTER = 1

Für stallguard_mode:

TF_SILENT_STEPPER_V2_STALLGUARD_MODE_STANDARD = 0
TF_SILENT_STEPPER_V2_STALLGUARD_MODE_FILTERED = 1

int tf_silent_stepper_v2_get_coolstep_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint8_t *ret_minimum_stallguard_value, uint8_t *ret_maximum_stallguard_value, uint8_t *ret_current_up_step_width, uint8_t *ret_current_down_step_width, uint8_t *ret_minimum_current, int8_t *ret_stallguard_threshold_value, uint8_t *ret_stallguard_mode)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_minimum_stallguard_value – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 2 ret_maximum_stallguard_value – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 10 ret_current_up_step_width – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_current_down_step_width – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_minimum_current – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_stallguard_threshold_value – Typ: int8_t, Wertebereich: [-64 bis 63], Standardwert: 0 ret_stallguard_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_current_up_step_width:

TF_SILENT_STEPPER_V2_CURRENT_UP_STEP_INCREMENT_1 = 0
TF_SILENT_STEPPER_V2_CURRENT_UP_STEP_INCREMENT_2 = 1
TF_SILENT_STEPPER_V2_CURRENT_UP_STEP_INCREMENT_4 = 2
TF_SILENT_STEPPER_V2_CURRENT_UP_STEP_INCREMENT_8 = 3

Für ret_current_down_step_width:

TF_SILENT_STEPPER_V2_CURRENT_DOWN_STEP_DECREMENT_1 = 0
TF_SILENT_STEPPER_V2_CURRENT_DOWN_STEP_DECREMENT_2 = 1
TF_SILENT_STEPPER_V2_CURRENT_DOWN_STEP_DECREMENT_8 = 2
TF_SILENT_STEPPER_V2_CURRENT_DOWN_STEP_DECREMENT_32 = 3

Für ret_minimum_current:

TF_SILENT_STEPPER_V2_MINIMUM_CURRENT_HALF = 0
TF_SILENT_STEPPER_V2_MINIMUM_CURRENT_QUARTER = 1

Für ret_stallguard_mode:

TF_SILENT_STEPPER_V2_STALLGUARD_MODE_STANDARD = 0
TF_SILENT_STEPPER_V2_STALLGUARD_MODE_FILTERED = 1

int tf_silent_stepper_v2_set_misc_configuration(TF_SilentStepperV2 *silent_stepper_v2, bool disable_short_to_ground_protection, uint8_t synchronize_phase_frequency)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * disable_short_to_ground_protection – Typ: bool, Standardwert: false synchronize_phase_frequency – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 0
Rückgabe:	e_code – Typ: int

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt verschiedene Parametereinstellungen.

Disable Short To Ground Protection: Setze diesen Wert auf False um den Kurzschluss nach Masse Schutz zu aktivieren. Ansonsten ist dieser deaktiviert.
Synchronize Phase Frequency: Mit diesem Parameter kann der Chopper für beide Phasen eines zweiphasen Motors synchronisiert werden. Der Wertebereich ist 0-15. Wenn der Wert auf 0 gesetzt wird ist die Synchronisation abgeschaltet. Ansonsten wird die Synchronisation mit folgender Formel durchgeführt: f_sync = f_clk/(value*64). Im Classic Modus ist die Synchronisation automatisch abgeschaltet. f_clk ist 12.8MHz.

int tf_silent_stepper_v2_get_misc_configuration(TF_SilentStepperV2 *silent_stepper_v2, bool *ret_disable_short_to_ground_protection, uint8_t *ret_synchronize_phase_frequency)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_disable_short_to_ground_protection – Typ: bool, Standardwert: false ret_synchronize_phase_frequency – Typ: uint8_t, Wertebereich: [0 bis 15], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int tf_silent_stepper_v2_set_error_led_config(TF_SilentStepperV2 *silent_stepper_v2, uint8_t config)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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.
250ms Intervall-Blinken: Übertemperaturwarnung.
1s Intervall-Blinken: Eingangsspannung zu gering.
Durchgängig rot: Motor deaktiviert auf Grund von Kurzschluss mit Masse in Phase A oder B oder auf Grund von zu hoher Temperatur.

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

Für config:

TF_SILENT_STEPPER_V2_ERROR_LED_CONFIG_OFF = 0
TF_SILENT_STEPPER_V2_ERROR_LED_CONFIG_ON = 1
TF_SILENT_STEPPER_V2_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_SILENT_STEPPER_V2_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_silent_stepper_v2_get_error_led_config(TF_SilentStepperV2 *silent_stepper_v2, uint8_t *ret_config)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
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_silent_stepper_v2_set_error_led_config() gesetzt.

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

Für ret_config:

TF_SILENT_STEPPER_V2_ERROR_LED_CONFIG_OFF = 0
TF_SILENT_STEPPER_V2_ERROR_LED_CONFIG_ON = 1
TF_SILENT_STEPPER_V2_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_SILENT_STEPPER_V2_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_silent_stepper_v2_get_driver_status(TF_SilentStepperV2 *silent_stepper_v2, uint8_t *ret_open_load, uint8_t *ret_short_to_ground, uint8_t *ret_over_temperature, bool *ret_motor_stalled, uint8_t *ret_actual_motor_current, bool *ret_full_step_active, uint8_t *ret_stallguard_result, uint8_t *ret_stealth_voltage_amplitude)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_open_load – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_short_to_ground – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_over_temperature – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_motor_stalled – Typ: bool ret_actual_motor_current – Typ: uint8_t, Wertebereich: [0 bis 31] ret_full_step_active – Typ: bool ret_stallguard_result – Typ: uint8_t, Wertebereich: [0 bis 255] ret_stealth_voltage_amplitude – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Treiberstatus zurück.

Open Load: Gibt an, dass keine Last an den Phasen A oder B, oder bei beiden vorhanden ist (open load). In dem Fall kann es ein Problem mit der Verkabelung des Motors geben. Es kann aber auch Fehlmeldungen geben, wenn der Motor sich schnell bewegt oder sich im Stillstand befindet.
Short To Ground: Gibt an, dass es einen Kurzschluss zwischen einer Phase (A,B) oder beiden Phasen nach Masse gibt. Wenn dies erkannt wird, wird der Treiber automatisch deaktiviert und muss wieder manuell aktiviert werden.
Over Temperature: Wenn der Treiber sich aufwärmt gibt dieser Status "Warning" aus. Dies ist erwartet, wenn der Motor längere Zeit benutzt wird. Wenn das Temperaturlimit erreicht wird ändert sich der Status zu "Limit". In diesem Fall wird der Treiber automatisch deaktiviert bis er sich wieder abgekühlt hat.
Motor Stalled: Ist True, wenn erkannt wurde, dass der Motor blockiert.
Actual Motor Current: Gibt die aktuelle Motorstromskalierung im Coolstep Modus aus. Er repräsentiert einer Multiplikator von 1/32 bis zu 32/32 vom Motor Run Current, wie von tf_silent_stepper_v2_set_basic_configuration() gesetzt. Beispiel: Wenn ein Motor Run Current von 1000mA gesetzt wurde und ein Wert von 15 zurückgegeben wird, entspricht das einem Actual Motor Current von 16/32*1000mA = 500mA.
Stallguard Result: Der Stallguard Wert gibt einen Hinweis auf die Last des Motors. Ein niedriger Wert bedeutet eine höhere Last. Über Ausprobieren kann man mit diesem Wert herausfinden, welcher Wert zu einem geeigneten Drehmoment bei der aktuellen Geschwindigkeit führt. Danach kann über diesen Wert herausgefunden werden, wenn eine Blockierung des Motors wahrscheinlich wird und es kann dementsprechend darauf reagiert werden (z.B. indem die Geschwindigkeit reduziert wird). Im Stillstand kann dieser Wert nicht benutzt werden. Er zeigt dann die Chopper On-Time für Motorspule A.
Stealth Voltage Amplitude: Zeigt das aktuelle PWM Scaling. Im Stealth Modus kann dieser Wert benutzt werden um die Motorlast abzuschätzen und eine Blockierung erkannt werden, wenn autoscale aktiviert wurde (see tf_silent_stepper_v2_set_stealth_configuration()).

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

Für ret_open_load:

TF_SILENT_STEPPER_V2_OPEN_LOAD_NONE = 0
TF_SILENT_STEPPER_V2_OPEN_LOAD_PHASE_A = 1
TF_SILENT_STEPPER_V2_OPEN_LOAD_PHASE_B = 2
TF_SILENT_STEPPER_V2_OPEN_LOAD_PHASE_AB = 3

Für ret_short_to_ground:

TF_SILENT_STEPPER_V2_SHORT_TO_GROUND_NONE = 0
TF_SILENT_STEPPER_V2_SHORT_TO_GROUND_PHASE_A = 1
TF_SILENT_STEPPER_V2_SHORT_TO_GROUND_PHASE_B = 2
TF_SILENT_STEPPER_V2_SHORT_TO_GROUND_PHASE_AB = 3

Für ret_over_temperature:

TF_SILENT_STEPPER_V2_OVER_TEMPERATURE_NONE = 0
TF_SILENT_STEPPER_V2_OVER_TEMPERATURE_WARNING = 1
TF_SILENT_STEPPER_V2_OVER_TEMPERATURE_LIMIT = 2

int tf_silent_stepper_v2_set_time_base(TF_SilentStepperV2 *silent_stepper_v2, uint32_t time_base)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * time_base – Typ: uint32_t, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1], Standardwert: 1
Rückgabe:	e_code – Typ: int

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Silent Stepper Bricklet 2.0.

Beispiel: Wenn aller 1,5 Sekunden ein Schritt gefahren werden soll, kann die Zeitbasis auf 15 und die Geschwindigkeit auf 10 gesetzt werden. Damit ist die Geschwindigkeit 10Schritte/15s = 1Schritt/1,5s.

int tf_silent_stepper_v2_get_time_base(TF_SilentStepperV2 *silent_stepper_v2, uint32_t *ret_time_base)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_time_base – Typ: uint32_t, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1], Standardwert: 1
Rückgabe:	e_code – Typ: int

Gibt die Zeitbasis zurück, wie von tf_silent_stepper_v2_set_time_base() gesetzt.

int tf_silent_stepper_v2_get_all_data(TF_SilentStepperV2 *silent_stepper_v2, uint16_t *ret_current_velocity, int32_t *ret_current_position, int32_t *ret_remaining_steps, uint16_t *ret_input_voltage, uint16_t *ret_current_consumption)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_current_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1] ret_current_position – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_remaining_steps – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_input_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] ret_current_consumption – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Gibt die folgenden Parameter zurück: Die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

Der Stromverbrauch des Schrittmotors wird berechnet aus dem Actual Motor Current-Wert (siehe tf_silent_stepper_v2_set_basic_configuration()) multipliziert mit dem Motor Run Current (see tf_silent_stepper_v2_get_driver_status()). Es handelt sich dabei um eine interne Berechnung des Treibers, nicht um eine externe unabhängige Messung.

Die Stromverbrauchsberechnung war bis Firmware 2.0.1 fehlerhaft, sie funktioniert seit Version 2.0.2 wie beschrieben.

Es existiert auch ein Callback für diese Funktion, siehe All Data Callback.

int tf_silent_stepper_v2_get_spitfp_error_count(TF_SilentStepperV2 *silent_stepper_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:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
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_silent_stepper_v2_set_status_led_config(TF_SilentStepperV2 *silent_stepper_v2, uint8_t config)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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_SILENT_STEPPER_V2_STATUS_LED_CONFIG_OFF = 0
TF_SILENT_STEPPER_V2_STATUS_LED_CONFIG_ON = 1
TF_SILENT_STEPPER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_SILENT_STEPPER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_silent_stepper_v2_get_status_led_config(TF_SilentStepperV2 *silent_stepper_v2, uint8_t *ret_config)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
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_silent_stepper_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_SILENT_STEPPER_V2_STATUS_LED_CONFIG_OFF = 0
TF_SILENT_STEPPER_V2_STATUS_LED_CONFIG_ON = 1
TF_SILENT_STEPPER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_SILENT_STEPPER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_silent_stepper_v2_get_chip_temperature(TF_SilentStepperV2 *silent_stepper_v2, int16_t *ret_temperature)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
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_silent_stepper_v2_reset(TF_SilentStepperV2 *silent_stepper_v2)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
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_silent_stepper_v2_get_identity(TF_SilentStepperV2 *silent_stepper_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:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
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_silent_stepper_v2_set_minimum_voltage(TF_SilentStepperV2 *silent_stepper_v2, uint16_t voltage)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 8000
Rückgabe:	e_code – Typ: int

Setzt die minimale Spannung, bei welcher der Under Voltage Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der Silent Stepper Bricklet 2.0 noch funktioniert, ist 8V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

int tf_silent_stepper_v2_get_minimum_voltage(TF_SilentStepperV2 *silent_stepper_v2, uint16_t *ret_voltage)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 8000
Rückgabe:	e_code – Typ: int

Gibt die minimale Spannung zurück, wie von tf_silent_stepper_v2_set_minimum_voltage() gesetzt.

int tf_silent_stepper_v2_set_all_callback_configuration(TF_SilentStepperV2 *silent_stepper_v2, uint32_t period)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher der All Data Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int tf_silent_stepper_v2_get_all_data_callback_configuraton(TF_SilentStepperV2 *silent_stepper_v2, uint32_t *ret_period)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Periode zurück, wie von tf_silent_stepper_v2_set_all_callback_configuration() gesetzt.

int tf_silent_stepper_v2_set_motor_stalled_callback_configuration(TF_SilentStepperV2 *silent_stepper_v2, bool enabled)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher der All Data Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int tf_silent_stepper_v2_get_motor_stalled_callback_configuraton(TF_SilentStepperV2 *silent_stepper_v2, bool *ret_enabled)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
Ausgabeparameter:	ret_enabled – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt die Periode zurück, wie von tf_silent_stepper_v2_set_all_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_silent_stepper_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_silent_stepper_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_silent_stepper_v2_register_under_voltage_callback(TF_SilentStepperV2 *silent_stepper_v2, TF_SilentStepperV2_UnderVoltageHandler handler, void *user_data)¶

void handler(TF_SilentStepperV2 *silent_stepper_v2, uint16_t voltage, void *user_data)

Callback-Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels tf_silent_stepper_v2_set_minimum_voltage() gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung.

int tf_silent_stepper_v2_register_position_reached_callback(TF_SilentStepperV2 *silent_stepper_v2, TF_SilentStepperV2_PositionReachedHandler handler, void *user_data)¶

void handler(TF_SilentStepperV2 *silent_stepper_v2, int32_t position, void *user_data)

Callback-Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * position – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von tf_silent_stepper_v2_set_steps() oder tf_silent_stepper_v2_set_target_position() gesetzt, erreicht wird.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Schrittmotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe tf_silent_stepper_v2_set_speed_ramping()) 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_silent_stepper_v2_register_all_data_callback(TF_SilentStepperV2 *silent_stepper_v2, TF_SilentStepperV2_AllDataHandler handler, void *user_data)¶

void handler(TF_SilentStepperV2 *silent_stepper_v2, uint16_t current_velocity, int32_t current_position, int32_t remaining_steps, uint16_t input_voltage, uint16_t current_consumption, void *user_data)

Callback-Parameter:

silent_stepper_v2 – Typ: TF_SilentStepperV2 *
current_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1]
current_position – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
remaining_steps – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
input_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]
current_consumption – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]
user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit tf_silent_stepper_v2_set_all_callback_configuration(), ausgelöst. Die Parameter sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

int tf_silent_stepper_v2_register_new_state_callback(TF_SilentStepperV2 *silent_stepper_v2, TF_SilentStepperV2_NewStateHandler handler, void *user_data)¶

void handler(TF_SilentStepperV2 *silent_stepper_v2, uint8_t state_new, uint8_t state_previous, void *user_data)

Callback-Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * state_new – Typ: uint8_t, Wertebereich: Siehe Konstanten state_previous – Typ: uint8_t, Wertebereich: Siehe Konstanten user_data – Typ: void *

Dieser Callback wird immer dann ausgelöst, wenn der Silent Stepper Bricklet 2.0 einen neuen Zustand erreicht. Es wird sowohl der neue wie auch der alte Zustand zurückgegeben.

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

Für state_new:

TF_SILENT_STEPPER_V2_STATE_STOP = 1
TF_SILENT_STEPPER_V2_STATE_ACCELERATION = 2
TF_SILENT_STEPPER_V2_STATE_RUN = 3
TF_SILENT_STEPPER_V2_STATE_DEACCELERATION = 4
TF_SILENT_STEPPER_V2_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
TF_SILENT_STEPPER_V2_STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Für state_previous:

TF_SILENT_STEPPER_V2_STATE_STOP = 1
TF_SILENT_STEPPER_V2_STATE_ACCELERATION = 2
TF_SILENT_STEPPER_V2_STATE_RUN = 3
TF_SILENT_STEPPER_V2_STATE_DEACCELERATION = 4
TF_SILENT_STEPPER_V2_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
TF_SILENT_STEPPER_V2_STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

int tf_silent_stepper_v2_register_gpio_state_callback(TF_SilentStepperV2 *silent_stepper_v2, TF_SilentStepperV2_GPIOStateHandler handler, void *user_data)¶

void handler(TF_SilentStepperV2 *silent_stepper_v2, bool gpio_state[2], void *user_data)

Callback-Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * gpio_state – Typ: bool[2] user_data – Typ: void *

Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über tf_silent_stepper_v2_set_gpio_action() aktiviert wurde.

int tf_silent_stepper_v2_register_motor_stalled_callback(TF_SilentStepperV2 *silent_stepper_v2, TF_SilentStepperV2_MotorStalledHandler handler, void *user_data)¶

void handler(TF_SilentStepperV2 *silent_stepper_v2, int32_t position, void *user_data)

Callback-Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * position – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

Dieser Callback wird immer dann ausgelöst, wenn der Motor-Stalled-Parameter im Status gesetzt wird (Änderung von False auf True). Siehe tf_silent_stepper_v2_get_driver_status().

Virtuelle Funktionen¶

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

int tf_silent_stepper_v2_get_response_expected(TF_SilentStepperV2 *silent_stepper_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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_silent_stepper_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_SILENT_STEPPER_V2_FUNCTION_SET_MAX_VELOCITY = 1
TF_SILENT_STEPPER_V2_FUNCTION_SET_SPEED_RAMPING = 4
TF_SILENT_STEPPER_V2_FUNCTION_FULL_BRAKE = 6
TF_SILENT_STEPPER_V2_FUNCTION_SET_CURRENT_POSITION = 7
TF_SILENT_STEPPER_V2_FUNCTION_SET_TARGET_POSITION = 9
TF_SILENT_STEPPER_V2_FUNCTION_SET_STEPS = 11
TF_SILENT_STEPPER_V2_FUNCTION_SET_STEP_CONFIGURATION = 14
TF_SILENT_STEPPER_V2_FUNCTION_DRIVE_FORWARD = 16
TF_SILENT_STEPPER_V2_FUNCTION_DRIVE_BACKWARD = 17
TF_SILENT_STEPPER_V2_FUNCTION_STOP = 18
TF_SILENT_STEPPER_V2_FUNCTION_SET_MOTOR_CURRENT = 22
TF_SILENT_STEPPER_V2_FUNCTION_SET_ENABLED = 24
TF_SILENT_STEPPER_V2_FUNCTION_SET_BASIC_CONFIGURATION = 26
TF_SILENT_STEPPER_V2_FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 28
TF_SILENT_STEPPER_V2_FUNCTION_SET_STEALTH_CONFIGURATION = 30
TF_SILENT_STEPPER_V2_FUNCTION_SET_COOLSTEP_CONFIGURATION = 32
TF_SILENT_STEPPER_V2_FUNCTION_SET_MISC_CONFIGURATION = 34
TF_SILENT_STEPPER_V2_FUNCTION_SET_ERROR_LED_CONFIG = 36
TF_SILENT_STEPPER_V2_FUNCTION_SET_MINIMUM_VOLTAGE = 39
TF_SILENT_STEPPER_V2_FUNCTION_SET_TIME_BASE = 43
TF_SILENT_STEPPER_V2_FUNCTION_SET_ALL_CALLBACK_CONFIGURATION = 46
TF_SILENT_STEPPER_V2_FUNCTION_SET_GPIO_CONFIGURATION = 48
TF_SILENT_STEPPER_V2_FUNCTION_SET_GPIO_ACTION = 50
TF_SILENT_STEPPER_V2_FUNCTION_SET_MOTOR_STALLED_CALLBACK_CONFIGURATION = 56
TF_SILENT_STEPPER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_SILENT_STEPPER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_SILENT_STEPPER_V2_FUNCTION_RESET = 243
TF_SILENT_STEPPER_V2_FUNCTION_WRITE_UID = 248

int tf_silent_stepper_v2_set_response_expected(TF_SilentStepperV2 *silent_stepper_v2, uint8_t function_id, bool response_expected)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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_SILENT_STEPPER_V2_FUNCTION_SET_MAX_VELOCITY = 1
TF_SILENT_STEPPER_V2_FUNCTION_SET_SPEED_RAMPING = 4
TF_SILENT_STEPPER_V2_FUNCTION_FULL_BRAKE = 6
TF_SILENT_STEPPER_V2_FUNCTION_SET_CURRENT_POSITION = 7
TF_SILENT_STEPPER_V2_FUNCTION_SET_TARGET_POSITION = 9
TF_SILENT_STEPPER_V2_FUNCTION_SET_STEPS = 11
TF_SILENT_STEPPER_V2_FUNCTION_SET_STEP_CONFIGURATION = 14
TF_SILENT_STEPPER_V2_FUNCTION_DRIVE_FORWARD = 16
TF_SILENT_STEPPER_V2_FUNCTION_DRIVE_BACKWARD = 17
TF_SILENT_STEPPER_V2_FUNCTION_STOP = 18
TF_SILENT_STEPPER_V2_FUNCTION_SET_MOTOR_CURRENT = 22
TF_SILENT_STEPPER_V2_FUNCTION_SET_ENABLED = 24
TF_SILENT_STEPPER_V2_FUNCTION_SET_BASIC_CONFIGURATION = 26
TF_SILENT_STEPPER_V2_FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 28
TF_SILENT_STEPPER_V2_FUNCTION_SET_STEALTH_CONFIGURATION = 30
TF_SILENT_STEPPER_V2_FUNCTION_SET_COOLSTEP_CONFIGURATION = 32
TF_SILENT_STEPPER_V2_FUNCTION_SET_MISC_CONFIGURATION = 34
TF_SILENT_STEPPER_V2_FUNCTION_SET_ERROR_LED_CONFIG = 36
TF_SILENT_STEPPER_V2_FUNCTION_SET_MINIMUM_VOLTAGE = 39
TF_SILENT_STEPPER_V2_FUNCTION_SET_TIME_BASE = 43
TF_SILENT_STEPPER_V2_FUNCTION_SET_ALL_CALLBACK_CONFIGURATION = 46
TF_SILENT_STEPPER_V2_FUNCTION_SET_GPIO_CONFIGURATION = 48
TF_SILENT_STEPPER_V2_FUNCTION_SET_GPIO_ACTION = 50
TF_SILENT_STEPPER_V2_FUNCTION_SET_MOTOR_STALLED_CALLBACK_CONFIGURATION = 56
TF_SILENT_STEPPER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_SILENT_STEPPER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_SILENT_STEPPER_V2_FUNCTION_RESET = 243
TF_SILENT_STEPPER_V2_FUNCTION_WRITE_UID = 248

int tf_silent_stepper_v2_set_response_expected_all(TF_SilentStepperV2 *silent_stepper_v2, bool response_expected)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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_silent_stepper_v2_set_bootloader_mode(TF_SilentStepperV2 *silent_stepper_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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_SILENT_STEPPER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_SILENT_STEPPER_V2_BOOTLOADER_STATUS_OK = 0
TF_SILENT_STEPPER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_SILENT_STEPPER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_SILENT_STEPPER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_SILENT_STEPPER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_SILENT_STEPPER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_silent_stepper_v2_get_bootloader_mode(TF_SilentStepperV2 *silent_stepper_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_SILENT_STEPPER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_silent_stepper_v2_set_write_firmware_pointer(TF_SilentStepperV2 *silent_stepper_v2, uint32_t pointer)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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_silent_stepper_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_silent_stepper_v2_write_firmware(TF_SilentStepperV2 *silent_stepper_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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_silent_stepper_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_silent_stepper_v2_write_uid(TF_SilentStepperV2 *silent_stepper_v2, uint32_t uid)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 * 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_silent_stepper_v2_read_uid(TF_SilentStepperV2 *silent_stepper_v2, uint32_t *ret_uid)¶

Parameter:	silent_stepper_v2 – Typ: TF_SilentStepperV2 *
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_SILENT_STEPPER_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Silent Stepper Bricklet 2.0 zu identifizieren.

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

TF_SILENT_STEPPER_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Silent Stepper Bricklet 2.0 dar.