Deutsch
English
Menu
Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricks / Silent Stepper Brick

C/C++ - Silent Stepper Brick

Dies ist die Beschreibung der C/C++ API Bindings für den Silent Stepper Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Silent Stepper Brick sind in dessen Hardware Beschreibung zusammengefasst.

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration

Download (example_configuration.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "brick_silent_stepper.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XXYYZZ" // Change XXYYZZ to the UID of your Silent Stepper Brick

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

    // Create device object
    SilentStepper ss;
    silent_stepper_create(&ss, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    silent_stepper_set_motor_current(&ss, 800); // 800 mA
    silent_stepper_set_step_configuration(&ss, SILENT_STEPPER_STEP_RESOLUTION_8,
                                          true); // 1/8 steps (interpolated)
    silent_stepper_set_max_velocity(&ss, 2000); // Velocity 2000 steps/s

    // Slow acceleration (500 steps/s^2),
    // Fast deacceleration (5000 steps/s^2)
    silent_stepper_set_speed_ramping(&ss, 500, 5000);

    silent_stepper_enable(&ss); // Enable motor power
    silent_stepper_set_steps(&ss, 60000); // Drive 60000 steps forward

    printf("Press key to exit\n");
    getchar();

    // Stop motor before disabling motor power
    silent_stepper_stop(&ss); // Request motor stop
    silent_stepper_set_speed_ramping(&ss, 500,
                                     5000); // Fast deacceleration (5000 steps/s^2) for stopping
    millisleep(400); // Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
    silent_stepper_disable(&ss); // Disable motor power

    silent_stepper_destroy(&ss);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "brick_silent_stepper.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XXYYZZ" // Change XXYYZZ to the UID of your Silent Stepper Brick

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

    SilentStepper *ss = (SilentStepper *)user_data;
    int32_t steps;

    if(rand() % 2) {
        steps = (rand() % 4000) + 1000; // steps (forward)
        printf("Driving forward: %d steps\n", steps);
    } else {
        steps = -((rand() % 4000) + 1000); // steps (backward)
        printf("Driving backward: %d steps\n", steps);
    }

    int16_t vel = (rand() % 1800) + 200; // steps/s
    uint16_t acc = (rand() % 900) + 100; // steps/s^2
    uint16_t dec = (rand() % 900) + 100; // steps/s^2

    printf("Configuration (vel, acc, dec): %d, %d %d\n", vel, acc, dec);

    silent_stepper_set_speed_ramping(ss, acc, dec);
    silent_stepper_set_max_velocity(ss, vel);
    silent_stepper_set_steps(ss, steps);
}

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

    // Create device object
    SilentStepper ss;
    silent_stepper_create(&ss, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register position reached callback to function cb_position_reached
    silent_stepper_register_callback(&ss,
                                     SILENT_STEPPER_CALLBACK_POSITION_REACHED,
                                     (void (*)(void))cb_position_reached,
                                     &ss);

    silent_stepper_set_step_configuration(&ss, SILENT_STEPPER_STEP_RESOLUTION_8,
                                          true); // 1/8 steps (interpolated)
    silent_stepper_enable(&ss); // Enable motor power
    silent_stepper_set_steps(&ss, 1); // Drive one step forward to get things going

    printf("Press key to exit\n");
    getchar();

    // Stop motor before disabling motor power
    silent_stepper_stop(&ss); // Request motor stop
    silent_stepper_set_speed_ramping(&ss, 500,
                                     5000); // Fast deacceleration (5000 steps/s^2) for stopping
    millisleep(400); // Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
    silent_stepper_disable(&ss); // Disable motor power

    silent_stepper_destroy(&ss);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14
  • E_WRONG_DEVICE_TYPE = -15
  • E_DEVICE_REPLACED = -16
  • E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void silent_stepper_create(SilentStepper *silent_stepper, const char *uid, IPConnection *ipcon)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

SilentStepper silent_stepper;
silent_stepper_create(&silent_stepper, "YOUR_DEVICE_UID", &ipcon);

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

void silent_stepper_destroy(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *

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

int silent_stepper_set_max_velocity(SilentStepper *silent_stepper, uint16_t velocity)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 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 silent_stepper_set_target_position(), silent_stepper_set_steps(), silent_stepper_drive_forward() oder silent_stepper_drive_backward() verwendet werden.

int silent_stepper_get_max_velocity(SilentStepper *silent_stepper, uint16_t *ret_velocity)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_get_current_velocity(SilentStepper *silent_stepper, uint16_t *ret_velocity)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • e_code – Typ: int

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

int silent_stepper_set_speed_ramping(SilentStepper *silent_stepper, uint16_t acceleration, uint16_t deacceleration)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • acceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • deacceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 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 silent_stepper_get_speed_ramping(SilentStepper *silent_stepper, uint16_t *ret_acceleration, uint16_t *ret_deacceleration)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_acceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • ret_deacceleration – Typ: uint16_t, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_full_brake(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
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 silent_stepper_stop() stoppt den Motor.

int silent_stepper_set_steps(SilentStepper *silent_stepper, int32_t steps)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • steps – Typ: int32_t, Wertebereich: [-231 bis 231 - 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 silent_stepper_set_max_velocity() und silent_stepper_set_speed_ramping() gesetzt, verwendet.

int silent_stepper_get_steps(SilentStepper *silent_stepper, int32_t *ret_steps)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_steps – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_get_remaining_steps(SilentStepper *silent_stepper, int32_t *ret_steps)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_steps – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_drive_forward(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Rückgabe:
  • e_code – Typ: int

Fährt den Schrittmotor vorwärts bis silent_stepper_drive_backward() oder silent_stepper_stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit silent_stepper_set_max_velocity() und silent_stepper_set_speed_ramping() gesetzt, verwendet.

int silent_stepper_drive_backward(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Rückgabe:
  • e_code – Typ: int

Fährt den Schrittmotor rückwärts bis silent_stepper_drive_forward() oder silent_stepper_stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit silent_stepper_set_max_velocity() und silent_stepper_set_speed_ramping() gesetzt, verwendet.

int silent_stepper_stop(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_set_motor_current(SilentStepper *silent_stepper, uint16_t current)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • 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 silent_stepper_get_motor_current(SilentStepper *silent_stepper, uint16_t *ret_current)
Parameter:
  • silent_stepper – Typ: SilentStepper *
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 silent_stepper_set_motor_current() gesetzt.

int silent_stepper_enable(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_disable(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Rückgabe:
  • e_code – Typ: int

Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.

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 silent_stepper_stop() Funktion gestoppt werden, bevor die Treiberstufe deaktiviert wird. Die silent_stepper_stop() Funktion wartet nicht bis der Motor wirklich zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der silent_stepper_stop() Funktion eine angemessen Zeit gewartet werden bevor die silent_stepper_disable() Funktion aufgerufen wird.

int silent_stepper_is_enabled(SilentStepper *silent_stepper, bool *ret_enabled)
Parameter:
  • silent_stepper – Typ: SilentStepper *
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 silent_stepper_set_basic_configuration(SilentStepper *silent_stepper, 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:
  • silent_stepper – Typ: SilentStepper *
  • standstill_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 200
  • motor_run_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 216 - 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 216 - 1], Standardwert: 500
  • coolstep_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500
  • classic_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 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 silent_stepper_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 silent_stepper_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 silent_stepper_get_basic_configuration(SilentStepper *silent_stepper, 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 – Typ: SilentStepper *
Ausgabeparameter:
  • ret_standstill_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 200
  • ret_motor_run_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 216 - 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 216 - 1], Standardwert: 500
  • ret_coolstep_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500
  • ret_classic_threshold – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 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 silent_stepper_set_basic_configuration() gesetzt.

Fortgeschrittene Funktionen

int silent_stepper_set_current_position(SilentStepper *silent_stepper, int32_t position)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • position – Typ: int32_t, Wertebereich: [-231 bis 231 - 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 silent_stepper_get_current_position(SilentStepper *silent_stepper, int32_t *ret_position)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_position – Typ: int32_t, Wertebereich: [-231 bis 231 - 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 (silent_stepper_set_target_position(), silent_stepper_set_steps(), silent_stepper_drive_forward() der silent_stepper_drive_backward()). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit silent_stepper_set_current_position().

int silent_stepper_set_target_position(SilentStepper *silent_stepper, int32_t position)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • e_code – Typ: int

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und silent_stepper_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 silent_stepper_set_max_velocity() und silent_stepper_set_speed_ramping() gesetzt, verwendet.

Ein Aufruf von silent_stepper_set_target_position() mit dem Parameter x ist äquivalent mit einem Aufruf von silent_stepper_set_steps() mit dem Parameter (x - silent_stepper_get_current_position()).

int silent_stepper_get_target_position(SilentStepper *silent_stepper, int32_t *ret_position)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_set_step_configuration(SilentStepper *silent_stepper, uint8_t step_resolution, bool interpolation)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • 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 Brick 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:

  • SILENT_STEPPER_STEP_RESOLUTION_1 = 8
  • SILENT_STEPPER_STEP_RESOLUTION_2 = 7
  • SILENT_STEPPER_STEP_RESOLUTION_4 = 6
  • SILENT_STEPPER_STEP_RESOLUTION_8 = 5
  • SILENT_STEPPER_STEP_RESOLUTION_16 = 4
  • SILENT_STEPPER_STEP_RESOLUTION_32 = 3
  • SILENT_STEPPER_STEP_RESOLUTION_64 = 2
  • SILENT_STEPPER_STEP_RESOLUTION_128 = 1
  • SILENT_STEPPER_STEP_RESOLUTION_256 = 0
int silent_stepper_get_step_configuration(SilentStepper *silent_stepper, uint8_t *ret_step_resolution, bool *ret_interpolation)
Parameter:
  • silent_stepper – Typ: SilentStepper *
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 silent_stepper_set_step_configuration() gesetzt.

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

Für ret_step_resolution:

  • SILENT_STEPPER_STEP_RESOLUTION_1 = 8
  • SILENT_STEPPER_STEP_RESOLUTION_2 = 7
  • SILENT_STEPPER_STEP_RESOLUTION_4 = 6
  • SILENT_STEPPER_STEP_RESOLUTION_8 = 5
  • SILENT_STEPPER_STEP_RESOLUTION_16 = 4
  • SILENT_STEPPER_STEP_RESOLUTION_32 = 3
  • SILENT_STEPPER_STEP_RESOLUTION_64 = 2
  • SILENT_STEPPER_STEP_RESOLUTION_128 = 1
  • SILENT_STEPPER_STEP_RESOLUTION_256 = 0
int silent_stepper_get_stack_input_voltage(SilentStepper *silent_stepper, uint16_t *ret_voltage)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • e_code – Typ: int

Gibt die Eingangsspannung des Stapels zurück. Die Eingangsspannung des Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.

int silent_stepper_get_external_input_voltage(SilentStepper *silent_stepper, uint16_t *ret_voltage)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 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 Brick, 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 silent_stepper_set_spreadcycle_configuration(SilentStepper *silent_stepper, 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:
  • silent_stepper – Typ: SilentStepper *
  • 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:

  • SILENT_STEPPER_CHOPPER_MODE_SPREAD_CYCLE = 0
  • SILENT_STEPPER_CHOPPER_MODE_FAST_DECAY = 1
int silent_stepper_get_spreadcycle_configuration(SilentStepper *silent_stepper, 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 – Typ: SilentStepper *
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 silent_stepper_set_basic_configuration() gesetzt.

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

Für ret_chopper_mode:

  • SILENT_STEPPER_CHOPPER_MODE_SPREAD_CYCLE = 0
  • SILENT_STEPPER_CHOPPER_MODE_FAST_DECAY = 1
int silent_stepper_set_stealth_configuration(SilentStepper *silent_stepper, bool enable_stealth, uint8_t amplitude, uint8_t gradient, bool enable_autoscale, bool force_symmetric, uint8_t freewheel_mode)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • 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 silent_stepper_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 silent_stepper_set_basic_configuration()) auf 0 gesetzt wurde.

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

Für freewheel_mode:

  • SILENT_STEPPER_FREEWHEEL_MODE_NORMAL = 0
  • SILENT_STEPPER_FREEWHEEL_MODE_FREEWHEELING = 1
  • SILENT_STEPPER_FREEWHEEL_MODE_COIL_SHORT_LS = 2
  • SILENT_STEPPER_FREEWHEEL_MODE_COIL_SHORT_HS = 3
int silent_stepper_get_stealth_configuration(SilentStepper *silent_stepper, 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 – Typ: SilentStepper *
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 silent_stepper_set_stealth_configuration() gesetzt.

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

Für ret_freewheel_mode:

  • SILENT_STEPPER_FREEWHEEL_MODE_NORMAL = 0
  • SILENT_STEPPER_FREEWHEEL_MODE_FREEWHEELING = 1
  • SILENT_STEPPER_FREEWHEEL_MODE_COIL_SHORT_LS = 2
  • SILENT_STEPPER_FREEWHEEL_MODE_COIL_SHORT_HS = 3
int silent_stepper_set_coolstep_configuration(SilentStepper *silent_stepper, 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:
  • silent_stepper – Typ: SilentStepper *
  • 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 silent_stepper_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:

  • SILENT_STEPPER_CURRENT_UP_STEP_INCREMENT_1 = 0
  • SILENT_STEPPER_CURRENT_UP_STEP_INCREMENT_2 = 1
  • SILENT_STEPPER_CURRENT_UP_STEP_INCREMENT_4 = 2
  • SILENT_STEPPER_CURRENT_UP_STEP_INCREMENT_8 = 3

Für current_down_step_width:

  • SILENT_STEPPER_CURRENT_DOWN_STEP_DECREMENT_1 = 0
  • SILENT_STEPPER_CURRENT_DOWN_STEP_DECREMENT_2 = 1
  • SILENT_STEPPER_CURRENT_DOWN_STEP_DECREMENT_8 = 2
  • SILENT_STEPPER_CURRENT_DOWN_STEP_DECREMENT_32 = 3

Für minimum_current:

  • SILENT_STEPPER_MINIMUM_CURRENT_HALF = 0
  • SILENT_STEPPER_MINIMUM_CURRENT_QUARTER = 1

Für stallguard_mode:

  • SILENT_STEPPER_STALLGUARD_MODE_STANDARD = 0
  • SILENT_STEPPER_STALLGUARD_MODE_FILTERED = 1
int silent_stepper_get_coolstep_configuration(SilentStepper *silent_stepper, 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 – Typ: SilentStepper *
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 silent_stepper_set_coolstep_configuration() gesetzt.

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

Für ret_current_up_step_width:

  • SILENT_STEPPER_CURRENT_UP_STEP_INCREMENT_1 = 0
  • SILENT_STEPPER_CURRENT_UP_STEP_INCREMENT_2 = 1
  • SILENT_STEPPER_CURRENT_UP_STEP_INCREMENT_4 = 2
  • SILENT_STEPPER_CURRENT_UP_STEP_INCREMENT_8 = 3

Für ret_current_down_step_width:

  • SILENT_STEPPER_CURRENT_DOWN_STEP_DECREMENT_1 = 0
  • SILENT_STEPPER_CURRENT_DOWN_STEP_DECREMENT_2 = 1
  • SILENT_STEPPER_CURRENT_DOWN_STEP_DECREMENT_8 = 2
  • SILENT_STEPPER_CURRENT_DOWN_STEP_DECREMENT_32 = 3

Für ret_minimum_current:

  • SILENT_STEPPER_MINIMUM_CURRENT_HALF = 0
  • SILENT_STEPPER_MINIMUM_CURRENT_QUARTER = 1

Für ret_stallguard_mode:

  • SILENT_STEPPER_STALLGUARD_MODE_STANDARD = 0
  • SILENT_STEPPER_STALLGUARD_MODE_FILTERED = 1
int silent_stepper_set_misc_configuration(SilentStepper *silent_stepper, bool disable_short_to_ground_protection, uint8_t synchronize_phase_frequency)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • 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 silent_stepper_get_misc_configuration(SilentStepper *silent_stepper, bool *ret_disable_short_to_ground_protection, uint8_t *ret_synchronize_phase_frequency)
Parameter:
  • silent_stepper – Typ: SilentStepper *
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 silent_stepper_set_misc_configuration() gesetzt.

int silent_stepper_get_driver_status(SilentStepper *silent_stepper, 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 – Typ: SilentStepper *
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 silent_stepper_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 silent_stepper_set_stealth_configuration()).

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

Für ret_open_load:

  • SILENT_STEPPER_OPEN_LOAD_NONE = 0
  • SILENT_STEPPER_OPEN_LOAD_PHASE_A = 1
  • SILENT_STEPPER_OPEN_LOAD_PHASE_B = 2
  • SILENT_STEPPER_OPEN_LOAD_PHASE_AB = 3

Für ret_short_to_ground:

  • SILENT_STEPPER_SHORT_TO_GROUND_NONE = 0
  • SILENT_STEPPER_SHORT_TO_GROUND_PHASE_A = 1
  • SILENT_STEPPER_SHORT_TO_GROUND_PHASE_B = 2
  • SILENT_STEPPER_SHORT_TO_GROUND_PHASE_AB = 3

Für ret_over_temperature:

  • SILENT_STEPPER_OVER_TEMPERATURE_NONE = 0
  • SILENT_STEPPER_OVER_TEMPERATURE_WARNING = 1
  • SILENT_STEPPER_OVER_TEMPERATURE_LIMIT = 2
int silent_stepper_set_time_base(SilentStepper *silent_stepper, uint32_t time_base)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • time_base – Typ: uint32_t, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Rückgabe:
  • e_code – Typ: int

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Silent Stepper Brick.

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 silent_stepper_get_time_base(SilentStepper *silent_stepper, uint32_t *ret_time_base)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_time_base – Typ: uint32_t, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_get_all_data(SilentStepper *silent_stepper, uint16_t *ret_current_velocity, int32_t *ret_current_position, int32_t *ret_remaining_steps, uint16_t *ret_stack_voltage, uint16_t *ret_external_voltage, uint16_t *ret_current_consumption)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_current_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • ret_current_position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_remaining_steps – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_stack_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • ret_external_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • ret_current_consumption – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 216 - 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 silent_stepper_set_basic_configuration()) multipliziert mit dem Motor Run Current (see silent_stepper_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 SILENT_STEPPER_CALLBACK_ALL_DATA Callback.

int silent_stepper_set_spitfp_baudrate_config(SilentStepper *silent_stepper, bool enable_dynamic_baudrate, uint32_t minimum_dynamic_baudrate)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:
  • e_code – Typ: int

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

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

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

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

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

Neu in Version 2.0.4 (Firmware).

int silent_stepper_get_spitfp_baudrate_config(SilentStepper *silent_stepper, bool *ret_enable_dynamic_baudrate, uint32_t *ret_minimum_dynamic_baudrate)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • ret_minimum_dynamic_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:
  • e_code – Typ: int

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

Neu in Version 2.0.4 (Firmware).

int silent_stepper_get_send_timeout_count(SilentStepper *silent_stepper, uint8_t communication_method, uint32_t *ret_timeout_count)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • communication_method – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_timeout_count – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • e_code – Typ: int

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

Für communication_method:

  • SILENT_STEPPER_COMMUNICATION_METHOD_NONE = 0
  • SILENT_STEPPER_COMMUNICATION_METHOD_USB = 1
  • SILENT_STEPPER_COMMUNICATION_METHOD_SPI_STACK = 2
  • SILENT_STEPPER_COMMUNICATION_METHOD_CHIBI = 3
  • SILENT_STEPPER_COMMUNICATION_METHOD_RS485 = 4
  • SILENT_STEPPER_COMMUNICATION_METHOD_WIFI = 5
  • SILENT_STEPPER_COMMUNICATION_METHOD_ETHERNET = 6
  • SILENT_STEPPER_COMMUNICATION_METHOD_WIFI_V2 = 7
int silent_stepper_set_spitfp_baudrate(SilentStepper *silent_stepper, char bricklet_port, uint32_t baudrate)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:
  • e_code – Typ: int

Setzt die Baudrate eines spezifischen Bricklet Ports .

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

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

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

int silent_stepper_get_spitfp_baudrate(SilentStepper *silent_stepper, char bricklet_port, uint32_t *ret_baudrate)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:
  • ret_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:
  • e_code – Typ: int

Gibt die Baudrate für einen Bricklet Port zurück, siehe silent_stepper_set_spitfp_baudrate().

int silent_stepper_get_spitfp_error_count(SilentStepper *silent_stepper, char bricklet_port, 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 – Typ: SilentStepper *
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

int silent_stepper_enable_status_led(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Rückgabe:
  • e_code – Typ: int

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

int silent_stepper_disable_status_led(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Rückgabe:
  • e_code – Typ: int

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

int silent_stepper_is_status_led_enabled(SilentStepper *silent_stepper, bool *ret_enabled)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_enabled – Typ: bool, Standardwert: true
Rückgabe:
  • e_code – Typ: int

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

int silent_stepper_get_chip_temperature(SilentStepper *silent_stepper, int16_t *ret_temperature)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int silent_stepper_reset(SilentStepper *silent_stepper)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Rückgabe:
  • e_code – Typ: int

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

int silent_stepper_get_identity(SilentStepper *silent_stepper, 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 – Typ: SilentStepper *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['0' bis '8']
  • 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 216 - 1]
Rückgabe:
  • e_code – Typ: int

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

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

Konfigurationsfunktionen für Callbacks

void silent_stepper_register_callback(SilentStepper *silent_stepper, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int silent_stepper_set_minimum_voltage(SilentStepper *silent_stepper, uint16_t voltage)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000
Rückgabe:
  • e_code – Typ: int

Setzt die minimale Spannung, bei welcher der SILENT_STEPPER_CALLBACK_UNDER_VOLTAGE Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der Silent Stepper Brick 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 silent_stepper_get_minimum_voltage(SilentStepper *silent_stepper, uint16_t *ret_voltage)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_set_all_data_period(SilentStepper *silent_stepper, uint32_t period)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • e_code – Typ: int

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

int silent_stepper_get_all_data_period(SilentStepper *silent_stepper, uint32_t *ret_period)
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • e_code – Typ: int

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

Callbacks

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

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

silent_stepper_register_callback(&silent_stepper,
                                 SILENT_STEPPER_CALLBACK_EXAMPLE,
                                 (void (*)(void))my_callback,
                                 NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

SILENT_STEPPER_CALLBACK_UNDER_VOLTAGE
void callback(uint16_t voltage, void *user_data)
Callback-Parameter:
  • voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • user_data – Typ: void *

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

SILENT_STEPPER_CALLBACK_POSITION_REACHED
void callback(int32_t position, void *user_data)
Callback-Parameter:
  • position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von silent_stepper_set_steps() oder silent_stepper_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 silent_stepper_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.

SILENT_STEPPER_CALLBACK_ALL_DATA
void callback(uint16_t current_velocity, int32_t current_position, int32_t remaining_steps, uint16_t stack_voltage, uint16_t external_voltage, uint16_t current_consumption, void *user_data)
Callback-Parameter:
  • current_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • current_position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • remaining_steps – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • stack_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • external_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • current_consumption – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit silent_stepper_set_all_data_period(), 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.

SILENT_STEPPER_CALLBACK_NEW_STATE
void callback(uint8_t state_new, uint8_t state_previous, void *user_data)
Callback-Parameter:
  • 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 Brick 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:

  • SILENT_STEPPER_STATE_STOP = 1
  • SILENT_STEPPER_STATE_ACCELERATION = 2
  • SILENT_STEPPER_STATE_RUN = 3
  • SILENT_STEPPER_STATE_DEACCELERATION = 4
  • SILENT_STEPPER_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • SILENT_STEPPER_STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Für state_previous:

  • SILENT_STEPPER_STATE_STOP = 1
  • SILENT_STEPPER_STATE_ACCELERATION = 2
  • SILENT_STEPPER_STATE_RUN = 3
  • SILENT_STEPPER_STATE_DEACCELERATION = 4
  • SILENT_STEPPER_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • SILENT_STEPPER_STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int silent_stepper_get_api_version(SilentStepper *silent_stepper, uint8_t ret_api_version[3])
Parameter:
  • silent_stepper – Typ: SilentStepper *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • e_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int silent_stepper_get_response_expected(SilentStepper *silent_stepper, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • 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 silent_stepper_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:

  • SILENT_STEPPER_FUNCTION_SET_MAX_VELOCITY = 1
  • SILENT_STEPPER_FUNCTION_SET_SPEED_RAMPING = 4
  • SILENT_STEPPER_FUNCTION_FULL_BRAKE = 6
  • SILENT_STEPPER_FUNCTION_SET_CURRENT_POSITION = 7
  • SILENT_STEPPER_FUNCTION_SET_TARGET_POSITION = 9
  • SILENT_STEPPER_FUNCTION_SET_STEPS = 11
  • SILENT_STEPPER_FUNCTION_SET_STEP_CONFIGURATION = 14
  • SILENT_STEPPER_FUNCTION_DRIVE_FORWARD = 16
  • SILENT_STEPPER_FUNCTION_DRIVE_BACKWARD = 17
  • SILENT_STEPPER_FUNCTION_STOP = 18
  • SILENT_STEPPER_FUNCTION_SET_MOTOR_CURRENT = 22
  • SILENT_STEPPER_FUNCTION_ENABLE = 24
  • SILENT_STEPPER_FUNCTION_DISABLE = 25
  • SILENT_STEPPER_FUNCTION_SET_BASIC_CONFIGURATION = 27
  • SILENT_STEPPER_FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 29
  • SILENT_STEPPER_FUNCTION_SET_STEALTH_CONFIGURATION = 31
  • SILENT_STEPPER_FUNCTION_SET_COOLSTEP_CONFIGURATION = 33
  • SILENT_STEPPER_FUNCTION_SET_MISC_CONFIGURATION = 35
  • SILENT_STEPPER_FUNCTION_SET_MINIMUM_VOLTAGE = 38
  • SILENT_STEPPER_FUNCTION_SET_TIME_BASE = 42
  • SILENT_STEPPER_FUNCTION_SET_ALL_DATA_PERIOD = 45
  • SILENT_STEPPER_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • SILENT_STEPPER_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • SILENT_STEPPER_FUNCTION_ENABLE_STATUS_LED = 238
  • SILENT_STEPPER_FUNCTION_DISABLE_STATUS_LED = 239
  • SILENT_STEPPER_FUNCTION_RESET = 243
  • SILENT_STEPPER_FUNCTION_WRITE_BRICKLET_PLUGIN = 246
int silent_stepper_set_response_expected(SilentStepper *silent_stepper, uint8_t function_id, bool response_expected)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • 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.

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:

  • SILENT_STEPPER_FUNCTION_SET_MAX_VELOCITY = 1
  • SILENT_STEPPER_FUNCTION_SET_SPEED_RAMPING = 4
  • SILENT_STEPPER_FUNCTION_FULL_BRAKE = 6
  • SILENT_STEPPER_FUNCTION_SET_CURRENT_POSITION = 7
  • SILENT_STEPPER_FUNCTION_SET_TARGET_POSITION = 9
  • SILENT_STEPPER_FUNCTION_SET_STEPS = 11
  • SILENT_STEPPER_FUNCTION_SET_STEP_CONFIGURATION = 14
  • SILENT_STEPPER_FUNCTION_DRIVE_FORWARD = 16
  • SILENT_STEPPER_FUNCTION_DRIVE_BACKWARD = 17
  • SILENT_STEPPER_FUNCTION_STOP = 18
  • SILENT_STEPPER_FUNCTION_SET_MOTOR_CURRENT = 22
  • SILENT_STEPPER_FUNCTION_ENABLE = 24
  • SILENT_STEPPER_FUNCTION_DISABLE = 25
  • SILENT_STEPPER_FUNCTION_SET_BASIC_CONFIGURATION = 27
  • SILENT_STEPPER_FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 29
  • SILENT_STEPPER_FUNCTION_SET_STEALTH_CONFIGURATION = 31
  • SILENT_STEPPER_FUNCTION_SET_COOLSTEP_CONFIGURATION = 33
  • SILENT_STEPPER_FUNCTION_SET_MISC_CONFIGURATION = 35
  • SILENT_STEPPER_FUNCTION_SET_MINIMUM_VOLTAGE = 38
  • SILENT_STEPPER_FUNCTION_SET_TIME_BASE = 42
  • SILENT_STEPPER_FUNCTION_SET_ALL_DATA_PERIOD = 45
  • SILENT_STEPPER_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • SILENT_STEPPER_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • SILENT_STEPPER_FUNCTION_ENABLE_STATUS_LED = 238
  • SILENT_STEPPER_FUNCTION_DISABLE_STATUS_LED = 239
  • SILENT_STEPPER_FUNCTION_RESET = 243
  • SILENT_STEPPER_FUNCTION_WRITE_BRICKLET_PLUGIN = 246
int silent_stepper_set_response_expected_all(SilentStepper *silent_stepper, bool response_expected)
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • 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 silent_stepper_get_protocol1_bricklet_name(SilentStepper *silent_stepper, char port, uint8_t *ret_protocol_version, uint8_t ret_firmware_version[3], char ret_name[40])
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:
  • ret_protocol_version – 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_name – Typ: char[40]
Rückgabe:
  • e_code – Typ: int

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

int silent_stepper_write_bricklet_plugin(SilentStepper *silent_stepper, char port, uint8_t offset, uint8_t chunk[32])
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • port – Typ: char, Wertebereich: ['a' bis 'b']
  • offset – Typ: uint8_t, Wertebereich: [0 bis 255]
  • chunk – Typ: uint8_t[32], Wertebereich: [0 bis 255]
Rückgabe:
  • e_code – Typ: int

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int silent_stepper_read_bricklet_plugin(SilentStepper *silent_stepper, char port, uint8_t offset, uint8_t ret_chunk[32])
Parameter:
  • silent_stepper – Typ: SilentStepper *
  • port – Typ: char, Wertebereich: ['a' bis 'b']
  • offset – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_chunk – Typ: uint8_t[32], Wertebereich: [0 bis 255]
Rückgabe:
  • e_code – Typ: int

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Konstanten

SILENT_STEPPER_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Silent Stepper Brick zu identifizieren.

Die silent_stepper_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

SILENT_STEPPER_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Silent Stepper Brick dar.