Dies ist die Beschreibung der C/C++ API Bindings für das Servo Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Servo Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 54 55 56 57 58 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_servo_v2.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Servo Bricklet 2.0
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
ServoV2 s;
servo_v2_create(&s, 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
// Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
// and operating angle -100 to 100°
servo_v2_set_degree(&s, 0, -10000, 10000);
servo_v2_set_pulse_width(&s, 0, 1000, 2000);
servo_v2_set_period(&s, 0, 19500);
servo_v2_set_motion_configuration(&s, 0, 500000, 1000,
1000); // Full velocity with slow ac-/deceleration
// Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95 to 1.95ms
// and operating angle -90 to 90°
servo_v2_set_degree(&s, 5, -9000, 9000);
servo_v2_set_pulse_width(&s, 5, 950, 1950);
servo_v2_set_period(&s, 5, 20000);
servo_v2_set_motion_configuration(&s, 5, 500000, 500000,
500000); // Full velocity with full ac-/deceleration
servo_v2_set_position(&s, 0, 10000); // Set to most right position
servo_v2_set_enable(&s, 0, true);
servo_v2_set_position(&s, 5, -9000); // Set to most left position
servo_v2_set_enable(&s, 5, true);
printf("Press key to exit\n");
getchar();
servo_v2_set_enable(&s, 0, false);
servo_v2_set_enable(&s, 5, false);
servo_v2_destroy(&s);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_servo_v2.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Servo Bricklet 2.0
// Use position reached callback to swing back and forth
void cb_position_reached(uint16_t servo_channel, int16_t position, void *user_data) {
ServoV2 *s = (ServoV2 *)user_data;
if(position == 9000) {
printf("Position: 90°, going to -90°\n");
servo_v2_set_position(s, servo_channel, -9000);
} else if(position == -9000) {
printf("Position: -90°, going to 90°\n");
servo_v2_set_position(s, servo_channel, 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
ServoV2 s;
servo_v2_create(&s, 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_v2_register_callback(&s,
SERVO_V2_CALLBACK_POSITION_REACHED,
(void (*)(void))cb_position_reached,
&s);
// Enable position reached callback
servo_v2_set_position_reached_callback_configuration(&s, 0, true);
// 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_v2_set_motion_configuration(&s, 0, 10000, 500000, 500000);
servo_v2_set_position(&s, 0, 9000);
servo_v2_set_enable(&s, 0, true);
printf("Press key to exit\n");
getchar();
servo_v2_set_enable(&s, 0, false);
servo_v2_destroy(&s);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
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:
wie in ip_connection.h
definiert.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
Jede Funktion der Servo Brick API, welche den servo_channel Parameter verwendet,
kann einen Servo über die Servo-Kanal (0 bis 9) 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 << 15)
adressiert die Servos 1 und 5.
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.
servo_v2_create
(ServoV2 *servo_v2, const char *uid, IPConnection *ipcon)¶Parameter: |
|
---|
Erzeugt ein Geräteobjekt servo_v2
mit der eindeutigen Geräte ID uid
und
fügt es der IP Connection ipcon
hinzu:
ServoV2 servo_v2;
servo_v2_create(&servo_v2, "YOUR_DEVICE_UID", &ipcon);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.
servo_v2_destroy
(ServoV2 *servo_v2)¶Parameter: |
|
---|
Entfernt das Geräteobjekt servo_v2
von dessen IP Connection und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
servo_v2_get_status
(ServoV2 *servo_v2, bool ret_enabled[10], int16_t ret_current_position[10], int16_t ret_current_velocity[10], uint16_t ret_current[10], uint16_t *ret_input_voltage)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Status-Informationen des Servo Bricklet 2.0 zurück.
Der Status umfasst
Hinweis: Die Position und Geschwindigkeit ist eine Momentaufnahme der aktuellen Position und Geschwindigkeit eines sich in Bewegung befindlichen Servos.
servo_v2_set_enable
(ServoV2 *servo_v2, uint16_t servo_channel, bool enable)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert einen Servo-Kanal (0 bis 9). Wenn ein Servo aktiviert wird, wird die konfigurierte Position, Geschwindigkeit, Beschleunigung, etc. sofort übernommen.
servo_v2_get_enabled
(ServoV2 *servo_v2, uint16_t servo_channel, bool *ret_enable)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt zurück ob ein Servo-Kanal aktiviert ist.
servo_v2_set_position
(ServoV2 *servo_v2, uint16_t servo_channel, int16_t position)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Position in °/100 für den angegebenen Servo-Kanal.
Der Standardbereich für die Position ist -9000 bis 9000, aber dies kann,
entsprechend dem verwendetem Servo, mit servo_v2_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_v2_set_degree()
definiert werden.
servo_v2_get_position
(ServoV2 *servo_v2, uint16_t servo_channel, int16_t *ret_position)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Position des angegebenen Servo-Kanals zurück, wie von servo_v2_set_position()
gesetzt.
servo_v2_get_current_position
(ServoV2 *servo_v2, uint16_t servo_channel, int16_t *ret_position)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die aktuelle Position des angegebenen Servo-Kanals zurück. Dies kann vom Wert
von servo_v2_set_position()
abweichen, wenn der Servo gerade sein Positionsziel
anfährt.
servo_v2_get_current_velocity
(ServoV2 *servo_v2, uint16_t servo_channel, uint16_t *ret_velocity)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die aktuelle Geschwindigkeit des angegebenen Servo-Kanals zurück. Dies kann
von der Geschwindigkeit die per servo_v2_set_motion_configuration()
gesetzt wurde
abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.
servo_v2_set_motion_configuration
(ServoV2 *servo_v2, uint16_t servo_channel, uint32_t velocity, uint32_t acceleration, uint32_t deceleration)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die maximale Geschwindigkeit des angegebenen Servo-Kanals in °/100s sowie die Beschleunigung und Verzögerung in °/100s².
Mit einer Geschwindigkeit von 0 °/100s wird die Position sofort gesetzt (keine Geschwindigkeit).
Mit einer Beschleunigung/Verzögerung von 0 °/100s² wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung/Verzögerung).
servo_v2_get_motion_configuration
(ServoV2 *servo_v2, uint16_t servo_channel, uint32_t *ret_velocity, uint32_t *ret_acceleration, uint32_t *ret_deceleration)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die 'Motion Configuration' zurück, wie von servo_v2_set_motion_configuration()
gesetzt.
servo_v2_set_pulse_width
(ServoV2 *servo_v2, uint16_t servo_channel, uint32_t min, uint32_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die minimale und maximale Pulsweite des angegebenen Servo-Kanals in µs.
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.
Beide Werte haben einen Wertebereich von 1 bis 65535 (unsigned 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.
Die Standardwerte sind 1000µs (1ms) und 2000µs (2ms) für minimale und maximale Pulsweite.
servo_v2_get_pulse_width
(ServoV2 *servo_v2, uint16_t servo_channel, uint32_t *ret_min, uint32_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die minimale und maximale Pulsweite des angegebenen Servo-Kanals zurück, wie von
servo_v2_set_pulse_width()
gesetzt.
servo_v2_set_degree
(ServoV2 *servo_v2, uint16_t servo_channel, int16_t min, int16_t max)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den minimalen und maximalen Winkel des angegebenen Servo-Kanals (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_v2_set_position()
mit 0 in einer Pulsweite von 1500µs resultieren
(-90° = 1000µs, 90° = 2000µs, etc.).
Anwendungsfälle:
servo_v2_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².servo_v2_set_position()
steuert jetzt die Drehzahl in U/min.Beide Werte haben einen Wertebereich von -32767 bis 32767 (signed 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.
Die Standardwerte sind -9000 und 9000 für den minimalen und maximalen Winkel.
servo_v2_get_degree
(ServoV2 *servo_v2, uint16_t servo_channel, int16_t *ret_min, int16_t *ret_max)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den minimalen und maximalen Winkel für den angegebenen Servo-Kanals zurück,
wie von servo_v2_set_degree()
gesetzt.
servo_v2_set_period
(ServoV2 *servo_v2, uint16_t servo_channel, uint32_t period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode des angegebenen Servo-Kanals in µs.
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 (19,5ms) meinst funktionieren.
Die minimal mögliche Periode ist 1µs und die maximale 1000000µs.
Der Standardwert ist 19,5ms (19500µs).
servo_v2_get_period
(ServoV2 *servo_v2, uint16_t servo_channel, uint32_t *ret_period)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Periode für den angegebenen Servo-Kanal zurück, wie von servo_v2_set_period()
gesetzt.
servo_v2_get_servo_current
(ServoV2 *servo_v2, uint16_t servo_channel, uint16_t *ret_current)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Stromverbrauch des angegebenen Servo-Kanals in mA zurück.
servo_v2_set_servo_current_configuration
(ServoV2 *servo_v2, uint16_t servo_channel, uint8_t averaging_duration)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Durchschnittsberechnungsdauer der Strommessung des angegebenen Servo-Kanals in ms.
servo_v2_get_servo_current_configuration
(ServoV2 *servo_v2, uint16_t servo_channel, uint8_t *ret_averaging_duration)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Servo-Stromverbrauchskonfiguration für den angegebenen Servo-Kanal
zurück, wie von servo_v2_set_servo_current_configuration()
gesetzt.
servo_v2_set_input_voltage_configuration
(ServoV2 *servo_v2, uint8_t averaging_duration)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Durchschnittsberechnungsdauer der Eingangsspannungsmessung des angegebenen Servo-Kanals in ms.
servo_v2_get_input_voltage_configuration
(ServoV2 *servo_v2, uint8_t *ret_averaging_duration)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Servo-Eingangsspannungskonfiguration zurück, wie von servo_v2_set_input_voltage_configuration()
gesetzt.
servo_v2_get_overall_current
(ServoV2 *servo_v2, uint16_t *ret_current)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Stromverbrauch aller Servos zusammen in mA zurück.
servo_v2_get_input_voltage
(ServoV2 *servo_v2, uint16_t *ret_voltage)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die externe Eingangsspannung (in mV) zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Servo Brick, eingespeist.
servo_v2_set_current_calibration
(ServoV2 *servo_v2, int16_t offset[10])¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt einen Offset-Wert (in mA) für jeden Kanal.
Hinweis: Im Auslieferungszustand ist das Servo Bricklet 2.0 bereits kalibriert.
servo_v2_get_current_calibration
(ServoV2 *servo_v2, int16_t ret_offset[10])¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Stromkalibrierung zurück, wie von servo_v2_set_current_calibration()
.
servo_v2_get_spitfp_error_count
(ServoV2 *servo_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
servo_v2_set_status_led_config
(ServoV2 *servo_v2, uint8_t config)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
servo_v2_get_status_led_config
(ServoV2 *servo_v2, uint8_t *ret_config)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Konfiguration zurück, wie von servo_v2_set_status_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_config:
servo_v2_get_chip_temperature
(ServoV2 *servo_v2, int16_t *ret_temperature)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
servo_v2_reset
(ServoV2 *servo_v2)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
servo_v2_get_identity
(ServoV2 *servo_v2, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
servo_v2_register_callback
(ServoV2 *servo_v2, int16_t callback_id, void (*function)(void), void *user_data)¶Parameter: |
|
---|
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.
servo_v2_set_position_reached_callback_configuration
(ServoV2 *servo_v2, uint16_t servo_channel, bool enabled)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert/Deaktiviert SERVO_V2_CALLBACK_POSITION_REACHED
Callback.
servo_v2_get_position_reached_callback_configuration
(ServoV2 *servo_v2, uint16_t servo_channel, bool *ret_enabled)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels
servo_v2_set_position_reached_callback_configuration()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der servo_v2_register_callback()
Funktion durchgeführt werden:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } servo_v2_register_callback(&servo_v2, SERVO_V2_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.
SERVO_V2_CALLBACK_POSITION_REACHED
¶void callback(uint16_t servo_channel, int16_t position, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn eine konfigurierte Position, wie von
servo_v2_set_position()
gesetzt, erreicht wird. Falls die neue Position der
aktuellen Position entspricht, wird der Callback nicht ausgelöst, weil sich der
Servo nicht bewegt hat.
Die Parameter sind der Servo und die Position die erreicht wurde.
Dieser Callback kann mit servo_v2_set_position_reached_callback_configuration()
aktiviert werden.
Bemerkung
Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten,
funktioniert dies nur wenn die konfigurierte Geschwindigkeit (siehe servo_v2_set_motion_configuration()
)
kleiner oder gleich der maximalen Geschwindigkeit des Motors ist. Andernfalls
wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird
zu früh ausgelöst.
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.
servo_v2_get_api_version
(ServoV2 *servo_v2, uint8_t ret_api_version[3])¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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.
servo_v2_get_response_expected
(ServoV2 *servo_v2, uint8_t function_id, bool *ret_response_expected)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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 servo_v2_set_response_expected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
servo_v2_set_response_expected
(ServoV2 *servo_v2, uint8_t function_id, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
servo_v2_set_response_expected_all
(ServoV2 *servo_v2, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
servo_v2_set_bootloader_mode
(ServoV2 *servo_v2, uint8_t mode, uint8_t *ret_status)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für ret_status:
servo_v2_get_bootloader_mode
(ServoV2 *servo_v2, uint8_t *ret_mode)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe servo_v2_set_bootloader_mode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_mode:
servo_v2_set_write_firmware_pointer
(ServoV2 *servo_v2, uint32_t pointer)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Firmware-Pointer für servo_v2_write_firmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
servo_v2_write_firmware
(ServoV2 *servo_v2, uint8_t data[64], uint8_t *ret_status)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
servo_v2_set_write_firmware_pointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
servo_v2_write_uid
(ServoV2 *servo_v2, uint32_t uid)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
servo_v2_read_uid
(ServoV2 *servo_v2, uint32_t *ret_uid)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
SERVO_V2_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Servo Bricklet 2.0 zu identifizieren.
Die servo_v2_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.
SERVO_V2_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Servo Bricklet 2.0 dar.