C/C++ - DC Brick

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

#include "ip_connection.h"
#include "brick_dc.h"

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

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

    // Create device object
    DC dc;
    dc_create(&dc, 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

    dc_set_drive_mode(&dc, DC_DRIVE_MODE_DRIVE_COAST);
    dc_set_pwm_frequency(&dc, 10000); // Use PWM frequency of 10kHz
    dc_set_acceleration(&dc, 5000); // Slow acceleration
    dc_set_velocity(&dc, 32767); // Full speed forward
    dc_enable(&dc); // Enable motor power

    printf("Press key to exit\n");
    getchar();
    dc_disable(&dc); // Disable motor power
    dc_destroy(&dc);
    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
#include <stdio.h>

#include "ip_connection.h"
#include "brick_dc.h"

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

// Use velocity reached callback to swing back and forth
// between full speed forward and full speed backward
void cb_velocity_reached(int16_t velocity, void *user_data) {
    DC *dc = (DC *)user_data;

    if(velocity == 32767) {
        printf("Velocity: Full speed forward, now turning backward\n");
        dc_set_velocity(dc, -32767);
    } else if(velocity == -32767) {
        printf("Velocity: Full speed backward, now turning forward\n");
        dc_set_velocity(dc, 32767);
    } else {
        printf("Error\n"); // Can only happen if another program sets velocity
    }
}

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

    // Create device object
    DC dc;
    dc_create(&dc, 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

    // The acceleration has to be smaller or equal to the maximum
    // acceleration of the DC motor, otherwise the velocity reached
    // callback will be called too early
    dc_set_acceleration(&dc, 5000); // Slow acceleration
    dc_set_velocity(&dc, 32767); // Full speed forward

    // Register velocity reached callback to function cb_velocity_reached
    dc_register_callback(&dc,
                         DC_CALLBACK_VELOCITY_REACHED,
                         (void (*)(void))cb_velocity_reached,
                         &dc);

    // Enable motor power
    dc_enable(&dc);

    printf("Press key to exit\n");
    getchar();
    dc_disable(&dc); // Disable motor power
    dc_destroy(&dc);
    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 dc_create(DC *dc, const char *uid, IPConnection *ipcon)
Parameter:
  • dc – Typ: DC *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

DC dc;
dc_create(&dc, "YOUR_DEVICE_UID", &ipcon);

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

void dc_destroy(DC *dc)
Parameter:
  • dc – Typ: DC *

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

int dc_set_velocity(DC *dc, int16_t velocity)
Parameter:
  • dc – Typ: DC *
  • velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe dc_set_acceleration()) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe dc_set_pwm_frequency().

int dc_get_velocity(DC *dc, int16_t *ret_velocity)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int dc_get_current_velocity(DC *dc, int16_t *ret_velocity)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von dc_get_velocity(), sobald der Motor auf einen neuen Zielwert, wie von dc_set_velocity() vorgegeben, beschleunigt.

int dc_set_acceleration(DC *dc, uint16_t acceleration)
Parameter:
  • dc – Typ: DC *
  • acceleration – Typ: uint16_t, Einheit: 100/32767 %, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Rückgabe:
  • error_code – Typ: int

Setzt die Beschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Beschleunigungsrampe gefahren.

int dc_get_acceleration(DC *dc, uint16_t *ret_acceleration)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_acceleration – Typ: uint16_t, Einheit: 100/32767 %, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Rückgabe:
  • error_code – Typ: int

Gibt die Beschleunigung zurück, wie gesetzt von dc_set_acceleration().

int dc_full_brake(DC *dc)
Parameter:
  • dc – Typ: DC *
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 dc_set_velocity() mit 0 erlaubt einen normalen Stopp des Motors.

int dc_enable(DC *dc)
Parameter:
  • dc – Typ: DC *
Rückgabe:
  • error_code – Typ: int

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

int dc_disable(DC *dc)
Parameter:
  • dc – Typ: DC *
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 dc_is_enabled(DC *dc, bool *ret_enabled)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_enabled – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

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

Fortgeschrittene Funktionen

int dc_set_pwm_frequency(DC *dc, uint16_t frequency)
Parameter:
  • dc – Typ: DC *
  • frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Rückgabe:
  • error_code – Typ: int

Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

int dc_get_pwm_frequency(DC *dc, uint16_t *ret_frequency)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Rückgabe:
  • error_code – Typ: int

Gibt die PWM Frequenz zurück, wie gesetzt von dc_set_pwm_frequency().

int dc_get_stack_input_voltage(DC *dc, uint16_t *ret_voltage)
Parameter:
  • dc – Typ: DC *
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 dc_get_external_input_voltage(DC *dc, uint16_t *ret_voltage)
Parameter:
  • dc – Typ: DC *
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 DC 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 dc_get_current_consumption(DC *dc, uint16_t *ret_voltage)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_voltage – 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 dc_set_drive_mode(DC *dc, uint8_t mode)
Parameter:
  • dc – Typ: DC *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt den Fahrmodus. Verfügbare Modi sind:

  • 0 = Fahren/Bremsen
  • 1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

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

Für mode:

  • DC_DRIVE_MODE_DRIVE_BRAKE = 0
  • DC_DRIVE_MODE_DRIVE_COAST = 1
int dc_get_drive_mode(DC *dc, uint8_t *ret_mode)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt den Fahrmodus zurück, wie von dc_set_drive_mode() gesetzt.

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

Für ret_mode:

  • DC_DRIVE_MODE_DRIVE_BRAKE = 0
  • DC_DRIVE_MODE_DRIVE_COAST = 1
int dc_set_spitfp_baudrate_config(DC *dc, bool enable_dynamic_baudrate, uint32_t minimum_dynamic_baudrate)
Parameter:
  • dc – Typ: DC *
  • 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 dc_set_spitfp_baudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von dc_set_spitfp_baudrate() gesetzt statisch verwendet.

Neu in Version 2.3.5 (Firmware).

int dc_get_spitfp_baudrate_config(DC *dc, bool *ret_enable_dynamic_baudrate, uint32_t *ret_minimum_dynamic_baudrate)
Parameter:
  • dc – Typ: DC *
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 dc_set_spitfp_baudrate_config().

Neu in Version 2.3.5 (Firmware).

int dc_get_send_timeout_count(DC *dc, uint8_t communication_method, uint32_t *ret_timeout_count)
Parameter:
  • dc – Typ: DC *
  • 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:

  • DC_COMMUNICATION_METHOD_NONE = 0
  • DC_COMMUNICATION_METHOD_USB = 1
  • DC_COMMUNICATION_METHOD_SPI_STACK = 2
  • DC_COMMUNICATION_METHOD_CHIBI = 3
  • DC_COMMUNICATION_METHOD_RS485 = 4
  • DC_COMMUNICATION_METHOD_WIFI = 5
  • DC_COMMUNICATION_METHOD_ETHERNET = 6
  • DC_COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.3 (Firmware).

int dc_set_spitfp_baudrate(DC *dc, char bricklet_port, uint32_t baudrate)
Parameter:
  • dc – Typ: DC *
  • 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 dc_get_spitfp_error_count()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe dc_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 dc_get_spitfp_baudrate(DC *dc, char bricklet_port, uint32_t *ret_baudrate)
Parameter:
  • dc – Typ: DC *
  • 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 dc_set_spitfp_baudrate().

Neu in Version 2.3.3 (Firmware).

int dc_get_spitfp_error_count(DC *dc, 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:
  • dc – Typ: DC *
  • 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 dc_enable_status_led(DC *dc)
Parameter:
  • dc – Typ: DC *
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 dc_disable_status_led(DC *dc)
Parameter:
  • dc – Typ: DC *
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 dc_is_status_led_enabled(DC *dc, bool *ret_enabled)
Parameter:
  • dc – Typ: DC *
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 dc_get_protocol1_bricklet_name(DC *dc, char port, uint8_t *ret_protocol_version, uint8_t ret_firmware_version[3], char ret_name[40])
Parameter:
  • dc – Typ: DC *
  • 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 dc_get_chip_temperature(DC *dc, int16_t *ret_temperature)
Parameter:
  • dc – Typ: DC *
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 dc_reset(DC *dc)
Parameter:
  • dc – Typ: DC *
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 dc_get_identity(DC *dc, 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:
  • dc – Typ: DC *
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 dc_register_callback(DC *dc, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • dc – Typ: DC *
  • 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 dc_set_minimum_voltage(DC *dc, uint16_t voltage)
Parameter:
  • dc – Typ: DC *
  • voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000
Rückgabe:
  • error_code – Typ: int

Setzt die minimale Spannung, bei welcher der DC_CALLBACK_UNDER_VOLTAGE Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der DC Brick noch funktioniert, ist 6V. 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 dc_get_minimum_voltage(DC *dc, uint16_t *ret_voltage)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000
Rückgabe:
  • error_code – Typ: int

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

int dc_set_current_velocity_period(DC *dc, uint16_t period)
Parameter:
  • dc – Typ: DC *
  • period – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int dc_get_current_velocity_period(DC *dc, uint16_t *ret_period)
Parameter:
  • dc – Typ: DC *
Ausgabeparameter:
  • ret_period – Typ: uint16_t, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Callbacks

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

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

dc_register_callback(&dc,
                     DC_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.

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

DC_CALLBACK_EMERGENCY_SHUTDOWN
void callback(void *user_data)
Callback-Parameter:
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet dc_enable() muss aufgerufen werden, um den Motor erneut zu fahren.

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe dc_set_drive_mode()). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

DC_CALLBACK_VELOCITY_REACHED
void callback(int16_t velocity, void *user_data)
Callback-Parameter:
  • velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der DC_CALLBACK_VELOCITY_REACHED Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe dc_set_acceleration()) 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.

DC_CALLBACK_CURRENT_VELOCITY
void callback(int16_t velocity, void *user_data)
Callback-Parameter:
  • velocity – Typ: int16_t, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit dc_set_current_velocity_period(), ausgelöst. Der Parameter ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der DC_CALLBACK_CURRENT_VELOCITY Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

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 dc_get_api_version(DC *dc, uint8_t ret_api_version[3])
Parameter:
  • dc – Typ: DC *
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 dc_get_response_expected(DC *dc, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • dc – Typ: DC *
  • 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 dc_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:

  • DC_FUNCTION_SET_VELOCITY = 1
  • DC_FUNCTION_SET_ACCELERATION = 4
  • DC_FUNCTION_SET_PWM_FREQUENCY = 6
  • DC_FUNCTION_FULL_BRAKE = 8
  • DC_FUNCTION_ENABLE = 12
  • DC_FUNCTION_DISABLE = 13
  • DC_FUNCTION_SET_MINIMUM_VOLTAGE = 15
  • DC_FUNCTION_SET_DRIVE_MODE = 17
  • DC_FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
  • DC_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • DC_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • DC_FUNCTION_ENABLE_STATUS_LED = 238
  • DC_FUNCTION_DISABLE_STATUS_LED = 239
  • DC_FUNCTION_RESET = 243
int dc_set_response_expected(DC *dc, uint8_t function_id, bool response_expected)
Parameter:
  • dc – Typ: DC *
  • 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:

  • DC_FUNCTION_SET_VELOCITY = 1
  • DC_FUNCTION_SET_ACCELERATION = 4
  • DC_FUNCTION_SET_PWM_FREQUENCY = 6
  • DC_FUNCTION_FULL_BRAKE = 8
  • DC_FUNCTION_ENABLE = 12
  • DC_FUNCTION_DISABLE = 13
  • DC_FUNCTION_SET_MINIMUM_VOLTAGE = 15
  • DC_FUNCTION_SET_DRIVE_MODE = 17
  • DC_FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
  • DC_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • DC_FUNCTION_SET_SPITFP_BAUDRATE = 234
  • DC_FUNCTION_ENABLE_STATUS_LED = 238
  • DC_FUNCTION_DISABLE_STATUS_LED = 239
  • DC_FUNCTION_RESET = 243
int dc_set_response_expected_all(DC *dc, bool response_expected)
Parameter:
  • dc – Typ: DC *
  • 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

DC_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen DC Brick zu identifizieren.

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

DC_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines DC Brick dar.