C/C++ - Servo Brick¶

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

#include <stdio.h>

#include "ip_connection.h"
#include "brick_servo.h"

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

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

    // Create device object
    Servo servo;
    servo_create(&servo, 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

    // Configure two servos with voltage 5.5V
    // Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
    //          and operating angle -100 to 100°
    //
    // Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95
    //          to 1.95ms and operating angle -90 to 90°
    servo_set_output_voltage(&servo, 5500);

    servo_set_degree(&servo, 0, -10000, 10000);
    servo_set_pulse_width(&servo, 0, 1000, 2000);
    servo_set_period(&servo, 0, 19500);
    servo_set_acceleration(&servo, 0, 1000); // Slow acceleration
    servo_set_velocity(&servo, 0, 65535); // Full speed

    servo_set_degree(&servo, 5, -9000, 9000);
    servo_set_pulse_width(&servo, 5, 950, 1950);
    servo_set_period(&servo, 5, 20000);
    servo_set_acceleration(&servo, 5, 65535); // Full acceleration
    servo_set_velocity(&servo, 5, 65535); // Full speed

    servo_set_position(&servo, 0, 10000); // Set to most right position
    servo_enable(&servo, 0);

    servo_set_position(&servo, 5, -9000); // Set to most left position
    servo_enable(&servo, 5);

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

    servo_disable(&servo, 0);
    servo_disable(&servo, 5);

    servo_destroy(&servo);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "brick_servo.h"

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

// Use position reached callback to swing back and forth
void cb_position_reached(uint8_t servo_num, int16_t position, void *user_data) {
    Servo *servo = (Servo *)user_data;

    if(position == 9000) {
        printf("Position: 90°, going to -90°\n");
        servo_set_position(servo, servo_num, -9000);
    } else if(position == -9000) {
        printf("Position: -90°, going to 90°\n");
        servo_set_position(servo, servo_num, 9000);
    } else {
        printf("Error\n"); // Can only happen if another program sets position
    }
}

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

    // Create device object
    Servo servo;
    servo_create(&servo, 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
    servo_register_callback(&servo,
                            SERVO_CALLBACK_POSITION_REACHED,
                            (void (*)(void))cb_position_reached,
                            &servo);

    // Enable position reached callback
    servo_enable_position_reached_callback(&servo);

    // Set velocity to 100°/s. This has to be smaller or equal to the
    // maximum velocity of the servo you are using, otherwise the position
    // reached callback will be called too early
    servo_set_velocity(&servo, 0, 10000);
    servo_set_position(&servo, 0, 9000);
    servo_enable(&servo, 0);

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

    servo_disable(&servo, 0);

    servo_destroy(&servo);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

PWM Generator¶

Download (example_pwm_generator.c)

#include <stdio.h>

#include "ip_connection.h"
#include "brick_servo.h"

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

// Due to the internal clock dividing mechanism of the Servo Brick not all
// arbitrary PWM frequency values can be achieved. For example, the upper most
// three available PWM frequency values are 1MHz, 500kHz and 250kHz. The steps
// are coarser on the high frequency end and much finer on the low end. You can
// set any value here between 15Hz and 1MHz and the Servo Brick will try to
// match it as closely as possible.
#define PWM_FREQUENCY 175000 // in Hz [15Hz to 1MHz]
#define PWM_DUTY_CYCLE 20 // in % [0% to 100%]

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

    // Create device object
    Servo servo;
    servo_create(&servo, 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

    // Set degree range to 0-100, this will allow to
    // set the PWM duty cycle in 1% steps
    servo_set_degree(&servo, 0, 0, 100);

    // Set PWM frequency (1-65535µs == 1MHz-15Hz)
    int period = 1000000 / PWM_FREQUENCY;

    if (period < 1) {
        period = 1; // 1MHz
    } else if (period > 65535) {
        period = 65535; // ~15Hz
    }

    servo_set_pulse_width(&servo, 0, 0, period);
    servo_set_period(&servo, 0, period);

    // Fast acceleration and full speed
    servo_set_acceleration(&servo, 0, 65535);
    servo_set_velocity(&servo, 0, 65535);

    // Set PWM duty cycle (0-100 %)
    int position = PWM_DUTY_CYCLE;

    if (position < 0) {
        position = 0;
    } else if (position > 100) {
        position = 100;
    }

    servo_set_position(&servo, 0, position);

    // Enable PWM signal
    servo_enable(&servo, 0);

    printf("Press key to exit\n");
    getchar();
    servo_disable(&servo, 0);
    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.

Jede Funktion der Servo Brick API, welche den servo_num Parameter verwendet, kann einen Servo über die Servo Nummer (0 bis 6) adressieren. Falls es sich um eine Setter-Funktion handelt können mehrere Servos gleichzeitig mit einer Bitmaske adressiert werden. Um dies zu kennzeichnen muss das höchstwertigste Bit gesetzt werden. Beispiel: 1 adressiert den Servo 1, (1 << 1) | (1 << 5) | (1 << 7) adressiert die Servos 1 und 5, 0xFF adressiert alle 7 Servos, und so weiter. Das ermöglicht es Konfigurationen von verschiedenen Servos mit einem Funktionsaufruf durchzuführen. Es ist sichergestellt das die Änderungen in der selben PWM Periode vorgenommen werden, für alle Servos entsprechend der Bitmaske.

Grundfunktionen¶

void servo_create(Servo *servo, const char *uid, IPConnection *ipcon)¶

Parameter:	servo – Typ: Servo * uid – Typ: const char * ipcon – Typ: IPConnection *

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

Servo servo;
servo_create(&servo, "YOUR_DEVICE_UID", &ipcon);

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

void servo_destroy(Servo *servo)¶

Parameter:	servo – Typ: Servo *

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

int servo_enable(Servo *servo, uint8_t servo_num)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6, 128 bis 255]
Rückgabe:	e_code – Typ: int

Aktiviert einen Servo (0 bis 6). Wenn ein Servo aktiviert wird, wird die konfigurierte Position, Geschwindigkeit, Beschleunigung, etc. sofort übernommen.

int servo_disable(Servo *servo, uint8_t servo_num)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6, 128 bis 255]
Rückgabe:	e_code – Typ: int

Deaktiviert einen Servo (0 bis 6). Deaktivierte Servos werden nicht angesteuert, z.B. halten deaktivierte Servos nicht ihre Position wenn eine Last angebracht ist.

int servo_is_enabled(Servo *servo, uint8_t servo_num, bool *ret_enabled)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt zurück ob ein Servo aktiviert ist.

int servo_set_position(Servo *servo, uint8_t servo_num, int16_t position)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6, 128 bis 255] position – Typ: int16_t, Einheit: 1/100 °, Wertebereich: ?
Rückgabe:	e_code – Typ: int

Setzt die Position für den angegebenen Servo.

Der Standardbereich für die Position ist -9000 bis 9000, aber dies kann, entsprechend dem verwendetem Servo, mit servo_set_degree() definiert werden.

Wenn ein Linearservo oder RC Brushless Motor Controller oder ähnlich mit dem Servo Brick gesteuert werden soll, können Längen oder Geschwindigkeiten mit servo_set_degree() definiert werden.

int servo_get_position(Servo *servo, uint8_t servo_num, int16_t *ret_position)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_position – Typ: int16_t, Einheit: 1/100 °, Wertebereich: ?
Rückgabe:	e_code – Typ: int

Gibt die Position des angegebenen Servos zurück, wie von servo_set_position() gesetzt.

int servo_get_current_position(Servo *servo, uint8_t servo_num, int16_t *ret_position)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_position – Typ: int16_t, Einheit: 1/100 °, Wertebereich: ?
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Position des angegebenen Servos zurück. Dies kann vom Wert von servo_set_position() abweichen, wenn der Servo gerade sein Positionsziel anfährt.

int servo_set_velocity(Servo *servo, uint8_t servo_num, uint16_t velocity)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6, 128 bis 255] velocity – Typ: uint16_t, Einheit: 1/100 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Rückgabe:	e_code – Typ: int

Setzt die maximale Geschwindigkeit des angegebenen Servos. Die Geschwindigkeit wird entsprechend mit dem Wert, wie von servo_set_acceleration() gesetzt, beschleunigt.

Die minimale Geschwindigkeit ist 0 (keine Bewegung) und die maximale ist 65535. Mit einem Wert von 65535 wird die Position sofort gesetzt (keine Geschwindigkeit).

int servo_get_velocity(Servo *servo, uint8_t servo_num, uint16_t *ret_velocity)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_velocity – Typ: uint16_t, Einheit: 1/100 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Rückgabe:	e_code – Typ: int

Gibt die Geschwindigkeit des angegebenen Servos zurück, wie von servo_set_velocity() gesetzt.

int servo_get_current_velocity(Servo *servo, uint8_t servo_num, uint16_t *ret_velocity)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_velocity – Typ: uint16_t, Einheit: 1/100 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Geschwindigkeit des angegebenen Servos zurück. Dies kann vom Wert von servo_set_velocity() abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

int servo_set_acceleration(Servo *servo, uint8_t servo_num, uint16_t acceleration)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6, 128 bis 255] acceleration – Typ: uint16_t, Einheit: 1/100 °/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Rückgabe:	e_code – Typ: int

Setzt die Beschleunigung des angegebenen Servos.

Die minimale Beschleunigung ist 1 und die maximale 65535. Mit einem Wert von 65535 wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung).

int servo_get_acceleration(Servo *servo, uint8_t servo_num, uint16_t *ret_acceleration)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_acceleration – Typ: uint16_t, Einheit: 1/100 °/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Rückgabe:	e_code – Typ: int

Gibt die Beschleunigung des angegebenen Servos zurück, wie von servo_set_acceleration() gesetzt.

int servo_set_output_voltage(Servo *servo, uint16_t voltage)¶

Parameter:	servo – Typ: Servo * voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000
Rückgabe:	e_code – Typ: int

Setzt die Ausgangsspannung mit welchem der Servo angetrieben wird.

Bemerkung

Es wird empfohlen diesen Wert auf die maximale Spannung laut Spezifikation des Servos zu setzten. Die meisten Servos erreichen ihre maximale Kraft nur mit hohen Spannungen

int servo_get_output_voltage(Servo *servo, uint16_t *ret_voltage)¶

Parameter:	servo – Typ: Servo *
Ausgabeparameter:	ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000
Rückgabe:	e_code – Typ: int

Gibt die Ausgangsspannung zurück, wie von servo_set_output_voltage() gesetzt.

int servo_set_pulse_width(Servo *servo, uint8_t servo_num, uint16_t min, uint16_t max)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6, 128 bis 255] min – Typ: uint16_t, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 max – Typ: uint16_t, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2000
Rückgabe:	e_code – Typ: int

Setzt die minimale und maximale Pulsweite des angegebenen Servos.

Normalerweise werden Servos mit einer PWM angesteuert, wobei die Länge des Pulses die Position des Servos steuert. Jeder Servo hat unterschiedliche minimale und maximale Pulsweiten, diese können mit dieser Funktion spezifiziert werden.

Wenn im Datenblatt des Servos die minimale und maximale Pulsweite spezifiziert ist, sollten diese Werte entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen, müssen die Werte durch Ausprobieren gefunden werden.

Der minimale Wert muss kleiner als der maximale sein.

int servo_get_pulse_width(Servo *servo, uint8_t servo_num, uint16_t *ret_min, uint16_t *ret_max)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_min – Typ: uint16_t, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 ret_max – Typ: uint16_t, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2000
Rückgabe:	e_code – Typ: int

Gibt die minimale und maximale Pulsweite des angegebenen Servos zurück, wie von servo_set_pulse_width() gesetzt.

int servo_set_degree(Servo *servo, uint8_t servo_num, int16_t min, int16_t max)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6, 128 bis 255] min – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: -9000 max – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 9000
Rückgabe:	e_code – Typ: int

Setzt den minimalen und maximalen Winkel des angegebenen Servos (standardmäßig in °/100).

Dies definiert die abstrakten Werte zwischen welchen die minimale und maximale Pulsweite skaliert wird. Beispiel: Wenn eine Pulsweite von 1000µs bis 2000µs und ein Winkelbereich von -90° bis 90° spezifiziert ist, wird ein Aufruf von servo_set_position() mit 0 in einer Pulsweite von 1500µs resultieren (-90° = 1000µs, 90° = 2000µs, etc.).

Anwendungsfälle:

Das Datenblatt des Servos spezifiziert einen Bereich von 200° mit einer Mittelposition bei 110°. In diesem Fall kann das Minimum auf -9000 und das Maximum auf 11000 gesetzt werden.
Es wird ein Bereich von 220° am Servo gemessen und eine Mittelposition ist nicht bekannt bzw. wird nicht benötigt. In diesem Fall kann das Minimum auf 0 und das Maximum auf 22000 gesetzt werden.
Ein Linearservo mit einer Antriebslänge von 20cm. In diesem Fall kann das Minimum auf 0 und das Maximum auf 20000 gesetzt werden. Jetzt kann die Position mittels servo_set_position() mit einer Auflösung von cm/100 gesetzt werden. Auch die Geschwindigkeit hat eine Auflösung von cm/100s und die Beschleunigung von cm/100s².
Die Einheit ist irrelevant und eine möglichst hohe Auflösung ist gewünscht. In diesem Fall kann das Minimum auf -32767 und das Maximum auf 32767 gesetzt werden.
Ein Brushless Motor, mit einer maximalen Drehzahl von 1000 U/min, soll mit einem RC Brushless Motor Controller gesteuert werden. In diesem Fall kann das Minimum auf 0 und das Maximum auf 10000 gesetzt werden. servo_set_position() steuert jetzt die Drehzahl in U/min.

Der minimale Wert muss kleiner als der maximale sein.

int servo_get_degree(Servo *servo, uint8_t servo_num, int16_t *ret_min, int16_t *ret_max)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_min – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: -9000 ret_max – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 9000
Rückgabe:	e_code – Typ: int

Gibt den minimalen und maximalen Winkel für den angegebenen Servo zurück, wie von servo_set_degree() gesetzt.

int servo_set_period(Servo *servo, uint8_t servo_num, uint16_t period)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6, 128 bis 255] period – Typ: uint16_t, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 19500
Rückgabe:	e_code – Typ: int

Setzt die Periode des angegebenen Servos.

Normalerweise werden Servos mit einer PWM angesteuert. Unterschiedliche Servos erwarten PWMs mit unterschiedlichen Perioden. Die meisten Servos werden mit einer Periode von 20ms betrieben.

Wenn im Datenblatt des Servos die Periode spezifiziert ist, sollte dieser Wert entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen und die korrekte Periode unbekannt sein, wird der Standardwert meist funktionieren.

int servo_get_period(Servo *servo, uint8_t servo_num, uint16_t *ret_period)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_period – Typ: uint16_t, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 19500
Rückgabe:	e_code – Typ: int

Gibt die Periode für den angegebenen Servo zurück, wie von servo_set_period() gesetzt.

int servo_get_servo_current(Servo *servo, uint8_t servo_num, uint16_t *ret_current)¶

Parameter:	servo – Typ: Servo * servo_num – Typ: uint8_t, Wertebereich: [0 bis 6]
Ausgabeparameter:	ret_current – Typ: uint16_t, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Gibt den Stromverbrauch des angegebenen Servos zurück.

int servo_get_overall_current(Servo *servo, uint16_t *ret_current)¶

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

Gibt den Stromverbrauch aller Servos zusammen zurück.

int servo_get_stack_input_voltage(Servo *servo, uint16_t *ret_voltage)¶

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

Gibt die Eingangsspannung des Stapels zurück. Die Eingangsspannung des Stapels wird über diesen verteilt, z.B. mittels einer Step-Down oder Step-Up Power Supply.

int servo_get_external_input_voltage(Servo *servo, uint16_t *ret_voltage)¶

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

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Servo Brick, eingespeist.

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

Warnung

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

Fortgeschrittene Funktionen¶

int servo_set_spitfp_baudrate_config(Servo *servo, bool enable_dynamic_baudrate, uint32_t minimum_dynamic_baudrate)¶

Parameter:	servo – Typ: Servo * 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 servo_set_spitfp_baudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von servo_set_spitfp_baudrate() gesetzt statisch verwendet.

Added in version 2.3.4$nbsp;(Firmware).

int servo_get_spitfp_baudrate_config(Servo *servo, bool *ret_enable_dynamic_baudrate, uint32_t *ret_minimum_dynamic_baudrate)¶

Parameter:	servo – Typ: Servo *
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 servo_set_spitfp_baudrate_config().

Added in version 2.3.4$nbsp;(Firmware).

int servo_get_send_timeout_count(Servo *servo, uint8_t communication_method, uint32_t *ret_timeout_count)¶

Parameter:	servo – Typ: Servo * communication_method – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_timeout_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 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:

SERVO_COMMUNICATION_METHOD_NONE = 0
SERVO_COMMUNICATION_METHOD_USB = 1
SERVO_COMMUNICATION_METHOD_SPI_STACK = 2
SERVO_COMMUNICATION_METHOD_CHIBI = 3
SERVO_COMMUNICATION_METHOD_RS485 = 4
SERVO_COMMUNICATION_METHOD_WIFI = 5
SERVO_COMMUNICATION_METHOD_ETHERNET = 6
SERVO_COMMUNICATION_METHOD_WIFI_V2 = 7

Added in version 2.3.2$nbsp;(Firmware).

int servo_set_spitfp_baudrate(Servo *servo, char bricklet_port, uint32_t baudrate)¶

Parameter:	servo – Typ: Servo * 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 servo_get_spitfp_error_count()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe servo_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.

Added in version 2.3.2$nbsp;(Firmware).

int servo_get_spitfp_baudrate(Servo *servo, char bricklet_port, uint32_t *ret_baudrate)¶

Parameter:	servo – Typ: Servo * 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 servo_set_spitfp_baudrate().

Added in version 2.3.2$nbsp;(Firmware).

int servo_get_spitfp_error_count(Servo *servo, 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:	servo – Typ: Servo * bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Added in version 2.3.2$nbsp;(Firmware).

int servo_enable_status_led(Servo *servo)¶

Parameter:	servo – Typ: Servo *
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.

Added in version 2.3.1$nbsp;(Firmware).

int servo_disable_status_led(Servo *servo)¶

Parameter:	servo – Typ: Servo *
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.

Added in version 2.3.1$nbsp;(Firmware).

int servo_is_status_led_enabled(Servo *servo, bool *ret_enabled)¶

Parameter:	servo – Typ: Servo *
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.

Added in version 2.3.1$nbsp;(Firmware).

int servo_get_chip_temperature(Servo *servo, int16_t *ret_temperature)¶

Parameter:	servo – Typ: Servo *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int servo_reset(Servo *servo)¶

Parameter:	servo – Typ: Servo *
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 servo_get_identity(Servo *servo, 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:	servo – Typ: Servo *
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 2¹⁶ - 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 servo_register_callback(Servo *servo, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	servo – Typ: Servo * 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 servo_set_minimum_voltage(Servo *servo, uint16_t voltage)¶

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

Setzt die minimale Spannung, bei welcher der SERVO_CALLBACK_UNDER_VOLTAGE Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der Servo Brick noch funktioniert, ist 5V. 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 servo_get_minimum_voltage(Servo *servo, uint16_t *ret_voltage)¶

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

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

int servo_enable_position_reached_callback(Servo *servo)¶

Parameter:	servo – Typ: Servo *
Rückgabe:	e_code – Typ: int

Aktiviert den SERVO_CALLBACK_POSITION_REACHED Callback.

Voreinstellung ist deaktiviert.