C/C++ - Stepper Brick

Dies ist die Beschreibung der C/C++ API Bindings für den Stepper Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des 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
#include <stdio.h>

#include "ip_connection.h"
#include "brick_stepper.h"

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

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

    // Create device object
    Stepper stepper;
    stepper_create(&stepper, 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

    stepper_set_motor_current(&stepper, 800); // 800mA
    stepper_set_step_mode(&stepper, 8); // 1/8 step mode
    stepper_set_max_velocity(&stepper, 2000); // Velocity 2000 steps/s

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

    stepper_enable(&stepper); // Enable motor power
    stepper_set_steps(&stepper, 60000); // Drive 60000 steps forward

    printf("Press key to exit\n");
    getchar();
    stepper_disable(&stepper);
    stepper_destroy(&stepper);
    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
#include <stdio.h>
#include <stdlib.h>

#include "ip_connection.h"
#include "brick_stepper.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XXYYZZ" // Change XXYYZZ to the UID of your 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

    Stepper *stepper = (Stepper *)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);

    stepper_set_speed_ramping(stepper, acc, dec);
    stepper_set_max_velocity(stepper, vel);
    stepper_set_steps(stepper, steps);
}

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

    // Create device object
    Stepper stepper;
    stepper_create(&stepper, 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
    stepper_register_callback(&stepper,
                              STEPPER_CALLBACK_POSITION_REACHED,
                              (void (*)(void))cb_position_reached,
                              &stepper);

    stepper_enable(&stepper); // Enable motor power
    stepper_set_steps(&stepper, 1); // Drive one step forward to get things going

    printf("Press key to exit\n");
    getchar();
    stepper_disable(&stepper);
    stepper_destroy(&stepper);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. 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 (wird 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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void stepper_create(Stepper *stepper, const char *uid, IPConnection *ipcon)
Parameter:
  • stepper – Typ: Stepper *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

Stepper stepper;
stepper_create(&stepper, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void stepper_destroy(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *

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

int stepper_set_max_velocity(Stepper *stepper, uint16_t velocity)
Parameter:
  • stepper – Typ: Stepper *
  • velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_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 stepper_set_target_position(), stepper_set_steps(), stepper_drive_forward() oder stepper_drive_backward() verwendet werden.

int stepper_get_max_velocity(Stepper *stepper, uint16_t *ret_velocity)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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

int stepper_get_current_velocity(Stepper *stepper, uint16_t *ret_velocity)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_velocity – Typ: uint16_t, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

int stepper_set_speed_ramping(Stepper *stepper, uint16_t acceleration, uint16_t deacceleration)
Parameter:
  • stepper – Typ: Stepper *
  • 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:
  • error_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 stepper_get_speed_ramping(Stepper *stepper, uint16_t *ret_acceleration, uint16_t *ret_deacceleration)
Parameter:
  • stepper – Typ: Stepper *
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:
  • error_code – Typ: int

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

int stepper_full_brake(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_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 stepper_stop() stoppt den Motor.

int stepper_set_steps(Stepper *stepper, int32_t steps)
Parameter:
  • stepper – Typ: Stepper *
  • steps – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_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 stepper_set_max_velocity() und stepper_set_speed_ramping() gesetzt, verwendet.

int stepper_get_steps(Stepper *stepper, int32_t *ret_steps)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_steps – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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

int stepper_get_remaining_steps(Stepper *stepper, int32_t *ret_steps)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_steps – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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

int stepper_drive_forward(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_code – Typ: int

Fährt den Schrittmotor vorwärts bis stepper_drive_backward() oder stepper_stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit stepper_set_max_velocity() und stepper_set_speed_ramping() gesetzt, verwendet.

int stepper_drive_backward(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_code – Typ: int

Fährt den Schrittmotor rückwärts bis stepper_drive_forward() oder stepper_stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit stepper_set_max_velocity() und stepper_set_speed_ramping() gesetzt, verwendet.

int stepper_stop(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_code – Typ: int

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

int stepper_set_motor_current(Stepper *stepper, uint16_t current)
Parameter:
  • stepper – Typ: Stepper *
  • current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800
Rückgabe:
  • error_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 stepper_get_motor_current(Stepper *stepper, uint16_t *ret_current)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800
Rückgabe:
  • error_code – Typ: int

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

int stepper_enable(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_code – Typ: int

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

int stepper_disable(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_code – Typ: int

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

int stepper_is_enabled(Stepper *stepper, bool *ret_enabled)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_enabled – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

Fortgeschrittene Funktionen

int stepper_set_current_position(Stepper *stepper, int32_t position)
Parameter:
  • stepper – Typ: Stepper *
  • position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_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 stepper_get_current_position(Stepper *stepper, int32_t *ret_position)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_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 (stepper_set_target_position(), stepper_set_steps(), stepper_drive_forward() der stepper_drive_backward()). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit stepper_set_current_position().

int stepper_set_target_position(Stepper *stepper, int32_t position)
Parameter:
  • stepper – Typ: Stepper *
  • position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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

Ein Aufruf von stepper_set_target_position() mit dem Parameter x ist äquivalent mit einem Aufruf von stepper_set_steps() mit dem Parameter (x - stepper_get_current_position()).

int stepper_get_target_position(Stepper *stepper, int32_t *ret_position)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_position – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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

int stepper_set_step_mode(Stepper *stepper, uint8_t mode)
Parameter:
  • stepper – Typ: Stepper *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 8
Rückgabe:
  • error_code – Typ: int

Setzt den Schrittmodus des Schrittmotors. Mögliche Werte sind:

  • Vollschritt = 1
  • Halbschritt = 2
  • Viertelschritt = 4
  • Achtelschritt = 8

Ein höherer Wert erhöht die Auflösung und verringert das Drehmoment des Schrittmotors.

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

Für mode:

  • STEPPER_STEP_MODE_FULL_STEP = 1
  • STEPPER_STEP_MODE_HALF_STEP = 2
  • STEPPER_STEP_MODE_QUARTER_STEP = 4
  • STEPPER_STEP_MODE_EIGHTH_STEP = 8
int stepper_get_step_mode(Stepper *stepper, uint8_t *ret_mode)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 8
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • STEPPER_STEP_MODE_FULL_STEP = 1
  • STEPPER_STEP_MODE_HALF_STEP = 2
  • STEPPER_STEP_MODE_QUARTER_STEP = 4
  • STEPPER_STEP_MODE_EIGHTH_STEP = 8
int stepper_get_stack_input_voltage(Stepper *stepper, uint16_t *ret_voltage)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_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 stepper_get_external_input_voltage(Stepper *stepper, uint16_t *ret_voltage)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den 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 stepper_get_current_consumption(Stepper *stepper, uint16_t *ret_current)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Stromaufnahme des Motors zurück.

int stepper_set_decay(Stepper *stepper, uint16_t decay)
Parameter:
  • stepper – Typ: Stepper *
  • decay – Typ: uint16_t, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Rückgabe:
  • error_code – Typ: int

Setzt den Decay Modus (Abklingmodus) des Schrittmotors. Ein Wert von 0 setzt den Fast Decay Modus (schneller Stromabbau), ein Wert von 65535 den Slow Decay Modus (langsamer Stromabbau) ein Wert dazwischen den Mixed Decay Modus (Nutzung beider Modi).

Eine Änderung des Decay Modus ist nur möglich wenn die Synchrongleichrichtung aktiviert ist (siehe stepper_set_sync_rect()).

Für eine gute Erläuterung der verschiedenen Decay Modi siehe diesen Blogeintrag (Englisch) von Avayan oder diesen Blogeintrag (Deutsch) von T. Ostermann.

Ein guter Decay Modus ist leider unterschiedlich für jeden Motor. Der beste Weg einen guten Decay Modus für den jeweiligen Schrittmotor zu finden, wenn der Strom nicht mit einem Oszilloskop gemessen werden kann, ist auf die Geräusche des Motors zu hören. Wenn der Wert zu gering ist, ist oftmals ein hoher Ton zu hören und wenn er zu hoch ist, oftmals ein brummendes Geräusch.

Im Allgemeinen ist der Fast Decay Modus (kleine Werte) geräuschvoller, erlaubt aber höhere Motorgeschwindigkeiten.

Bemerkung

Es existiert leider keine Formel zur Berechnung des optimalen Decay Modus eines Schrittmotors. Sollten Probleme mit lauten Geräuschen oder einer zu geringen maximalen Motorgeschwindigkeit bestehen, bleibt nur Ausprobieren um einen besseren Decay Modus zu finden.

int stepper_get_decay(Stepper *stepper, uint16_t *ret_decay)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_decay – Typ: uint16_t, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Rückgabe:
  • error_code – Typ: int

Gibt den Decay Modus zurück, wie von stepper_set_decay() gesetzt.

int stepper_set_sync_rect(Stepper *stepper, bool sync_rect)
Parameter:
  • stepper – Typ: Stepper *
  • sync_rect – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Aktiviert oder deaktiviert (true oder false) die Synchrongleichrichtung.

Bei aktiver Synchrongleichrichtung kann der Decay Modus geändert werden (Siehe stepper_set_decay()). Ohne Synchrongleichrichtung wird der Fast Decay Modus verwendet.

Für eine Erläuterung der Synchrongleichrichtung siehe hier.

Warnung

Wenn hohe Geschwindigkeiten (> 10000 Schritte/s) mit einem großen Schrittmotor mit einer hohen Induktivität genutzt werden sollen, wird dringend geraten die Synchrongleichrichtung zu deaktivieren. Sonst kann es vorkommen, dass der Brick die Last nicht bewältigen kann und überhitzt.

int stepper_is_sync_rect(Stepper *stepper, bool *ret_sync_rect)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_sync_rect – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt zurück ob die Synchrongleichrichtung aktiviert ist.

int stepper_set_time_base(Stepper *stepper, uint32_t time_base)
Parameter:
  • stepper – Typ: Stepper *
  • time_base – Typ: uint32_t, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Rückgabe:
  • error_code – Typ: int

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des 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 stepper_get_time_base(Stepper *stepper, uint32_t *ret_time_base)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_time_base – Typ: uint32_t, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Rückgabe:
  • error_code – Typ: int

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

int stepper_get_all_data(Stepper *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:
  • stepper – Typ: Stepper *
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:
  • error_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.

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

int stepper_set_spitfp_baudrate_config(Stepper *stepper, bool enable_dynamic_baudrate, uint32_t minimum_dynamic_baudrate)
Parameter:
  • stepper – Typ: Stepper *
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:
  • error_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 stepper_set_spitfp_baudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von stepper_set_spitfp_baudrate() gesetzt statisch verwendet.

Neu in Version 2.3.6 (Firmware).

int stepper_get_spitfp_baudrate_config(Stepper *stepper, bool *ret_enable_dynamic_baudrate, uint32_t *ret_minimum_dynamic_baudrate)
Parameter:
  • stepper – Typ: Stepper *
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:
  • error_code – Typ: int

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

Neu in Version 2.3.6 (Firmware).

int stepper_get_send_timeout_count(Stepper *stepper, uint8_t communication_method, uint32_t *ret_timeout_count)
Parameter:
  • stepper – Typ: Stepper *
  • communication_method – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_timeout_count – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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:

  • STEPPER_COMMUNICATION_METHOD_NONE = 0
  • STEPPER_COMMUNICATION_METHOD_USB = 1
  • STEPPER_COMMUNICATION_METHOD_SPI_STACK = 2
  • STEPPER_COMMUNICATION_METHOD_CHIBI = 3
  • STEPPER_COMMUNICATION_METHOD_RS485 = 4
  • STEPPER_COMMUNICATION_METHOD_WIFI = 5
  • STEPPER_COMMUNICATION_METHOD_ETHERNET = 6
  • STEPPER_COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.4 (Firmware).

int stepper_set_spitfp_baudrate(Stepper *stepper, char bricklet_port, uint32_t baudrate)
Parameter:
  • stepper – Typ: Stepper *
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:
  • error_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 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 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.

Neu in Version 2.3.3 (Firmware).

int stepper_get_spitfp_baudrate(Stepper *stepper, char bricklet_port, uint32_t *ret_baudrate)
Parameter:
  • stepper – Typ: Stepper *
  • 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:
  • error_code – Typ: int

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

Neu in Version 2.3.3 (Firmware).

int stepper_get_spitfp_error_count(Stepper *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:
  • stepper – Typ: Stepper *
  • 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:
  • error_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.

Neu in Version 2.3.3 (Firmware).

int stepper_enable_status_led(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_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.

Neu in Version 2.3.1 (Firmware).

int stepper_disable_status_led(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_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.

Neu in Version 2.3.1 (Firmware).

int stepper_is_status_led_enabled(Stepper *stepper, bool *ret_enabled)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_enabled – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

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

Neu in Version 2.3.1 (Firmware).

int stepper_get_protocol1_bricklet_name(Stepper *stepper, char port, uint8_t *ret_protocol_version, uint8_t ret_firmware_version[3], char ret_name[40])
Parameter:
  • stepper – Typ: Stepper *
  • 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:
  • error_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 stepper_get_chip_temperature(Stepper *stepper, int16_t *ret_temperature)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_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 stepper_reset(Stepper *stepper)
Parameter:
  • stepper – Typ: Stepper *
Rückgabe:
  • error_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 stepper_get_identity(Stepper *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:
  • stepper – Typ: Stepper *
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:
  • error_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 stepper_register_callback(Stepper *stepper, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • stepper – Typ: Stepper *
  • 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 stepper_set_minimum_voltage(Stepper *stepper, uint16_t voltage)
Parameter:
  • stepper – Typ: Stepper *
  • voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000
Rückgabe:
  • error_code – Typ: int

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

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

int stepper_set_all_data_period(Stepper *stepper, uint32_t period)
Parameter:
  • stepper – Typ: Stepper *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int stepper_get_all_data_period(Stepper *stepper, uint32_t *ret_period)
Parameter:
  • stepper – Typ: Stepper *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Periode zurück, wie von 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 stepper_register_callback() Funktion durchgeführt werden:

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

stepper_register_callback(&stepper,
                          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.

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 stepper_set_minimum_voltage() gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung.

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 stepper_set_steps() oder 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 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.

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 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.

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 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:

  • STEPPER_STATE_STOP = 1
  • STEPPER_STATE_ACCELERATION = 2
  • STEPPER_STATE_RUN = 3
  • STEPPER_STATE_DEACCELERATION = 4
  • STEPPER_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • STEPPER_STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Für state_previous:

  • STEPPER_STATE_STOP = 1
  • STEPPER_STATE_ACCELERATION = 2
  • STEPPER_STATE_RUN = 3
  • STEPPER_STATE_DEACCELERATION = 4
  • STEPPER_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
  • 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 stepper_get_api_version(Stepper *stepper, uint8_t ret_api_version[3])
Parameter:
  • stepper – Typ: Stepper *
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:
  • error_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 stepper_get_response_expected(Stepper *stepper, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • stepper – Typ: Stepper *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_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 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:

  • STEPPER_FUNCTION_SET_MAX_VELOCITY = 1
  • STEPPER_FUNCTION_SET_SPEED_RAMPING = 4
  • STEPPER_FUNCTION_FULL_BRAKE = 6
  • STEPPER_FUNCTION_SET_CURRENT_POSITION = 7
  • STEPPER_FUNCTION_SET_TARGET_POSITION = 9
  • STEPPER_FUNCTION_SET_STEPS = 11
  • STEPPER_FUNCTION_SET_STEP_MODE = 14
  • STEPPER_FUNCTION_DRIVE_FORWARD = 16
  • STEPPER_FUNCTION_DRIVE_BACKWARD = 17
  • STEPPER_FUNCTION_STOP = 18
  • STEPPER_FUNCTION_SET_MOTOR_CURRENT = 22
  • STEPPER_FUNCTION_ENABLE = 24
  • STEPPER_FUNCTION_DISABLE = 25
  • STEPPER_FUNCTION_SET_DECAY = 27
  • STEPPER_FUNCTION_SET_MINIMUM_VOLTAGE = 29
  • STEPPER_FUNCTION_SET_SYNC_RECT = 33
  • STEPPER_FUNCTION_SET_TIME_BASE = 35
  • STEPPER_FUNCTION_SET_ALL_DATA_PERIOD = 38
  • STEPPER_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • STEPPER_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • STEPPER_FUNCTION_ENABLE_STATUS_LED = 238
  • STEPPER_FUNCTION_DISABLE_STATUS_LED = 239
  • STEPPER_FUNCTION_RESET = 243
int stepper_set_response_expected(Stepper *stepper, uint8_t function_id, bool response_expected)
Parameter:
  • stepper – Typ: Stepper *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_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:

  • STEPPER_FUNCTION_SET_MAX_VELOCITY = 1
  • STEPPER_FUNCTION_SET_SPEED_RAMPING = 4
  • STEPPER_FUNCTION_FULL_BRAKE = 6
  • STEPPER_FUNCTION_SET_CURRENT_POSITION = 7
  • STEPPER_FUNCTION_SET_TARGET_POSITION = 9
  • STEPPER_FUNCTION_SET_STEPS = 11
  • STEPPER_FUNCTION_SET_STEP_MODE = 14
  • STEPPER_FUNCTION_DRIVE_FORWARD = 16
  • STEPPER_FUNCTION_DRIVE_BACKWARD = 17
  • STEPPER_FUNCTION_STOP = 18
  • STEPPER_FUNCTION_SET_MOTOR_CURRENT = 22
  • STEPPER_FUNCTION_ENABLE = 24
  • STEPPER_FUNCTION_DISABLE = 25
  • STEPPER_FUNCTION_SET_DECAY = 27
  • STEPPER_FUNCTION_SET_MINIMUM_VOLTAGE = 29
  • STEPPER_FUNCTION_SET_SYNC_RECT = 33
  • STEPPER_FUNCTION_SET_TIME_BASE = 35
  • STEPPER_FUNCTION_SET_ALL_DATA_PERIOD = 38
  • STEPPER_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • STEPPER_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • STEPPER_FUNCTION_ENABLE_STATUS_LED = 238
  • STEPPER_FUNCTION_DISABLE_STATUS_LED = 239
  • STEPPER_FUNCTION_RESET = 243
int stepper_set_response_expected_all(Stepper *stepper, bool response_expected)
Parameter:
  • stepper – Typ: Stepper *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

STEPPER_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Stepper Brick zu identifizieren.

Die 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.

STEPPER_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Stepper Brick dar.