Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets (Abgekündigt) / Rotary Encoder Bricklet

C/C++ - Rotary Encoder Bricklet¶

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

Simple¶

Download (example_simple.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_rotary_encoder.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Rotary Encoder Bricklet

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

    // Create device object
    RotaryEncoder re;
    rotary_encoder_create(&re, 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

    // Get current count without reset
    int32_t count;
    if(rotary_encoder_get_count(&re, false, &count) < 0) {
        fprintf(stderr, "Could not get count without reset, probably timeout\n");
        return 1;
    }

    printf("Count: %d\n", count);

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_rotary_encoder.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Rotary Encoder Bricklet

// Callback function for count callback
void cb_count(int32_t count, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Count: %d\n", count);
}

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

    // Create device object
    RotaryEncoder re;
    rotary_encoder_create(&re, 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 count callback to function cb_count
    rotary_encoder_register_callback(&re,
                                     ROTARY_ENCODER_CALLBACK_COUNT,
                                     (void (*)(void))cb_count,
                                     NULL);

    // Set period for count callback to 0.05s (50ms)
    // Note: The count callback is only called every 0.05 seconds
    //       if the count has changed since the last call!
    rotary_encoder_set_count_callback_period(&re, 50);

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

API¶

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

Mögliche Fehlercodes sind:

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void rotary_encoder_create(RotaryEncoder *rotary_encoder, const char *uid, IPConnection *ipcon)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * uid – Typ: const char * ipcon – Typ: IPConnection *

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

RotaryEncoder rotary_encoder;
rotary_encoder_create(&rotary_encoder, "YOUR_DEVICE_UID", &ipcon);

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

void rotary_encoder_destroy(RotaryEncoder *rotary_encoder)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder *

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

int rotary_encoder_get_count(RotaryEncoder *rotary_encoder, bool reset, int32_t *ret_count)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * reset – Typ: bool
Ausgabeparameter:	ret_count – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.

Der Encoder hat 24 Schritte pro Umdrehung.

Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.

int rotary_encoder_is_pressed(RotaryEncoder *rotary_encoder, bool *ret_pressed)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder *
Ausgabeparameter:	ret_pressed – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt true zurück wenn der Taster gedrückt ist und sonst false.

Es wird empfohlen die ROTARY_ENCODER_CALLBACK_PRESSED und ROTARY_ENCODER_CALLBACK_RELEASED Callbacks zu nutzen, um den Taster programmatisch zu behandeln.

Fortgeschrittene Funktionen¶

int rotary_encoder_get_identity(RotaryEncoder *rotary_encoder, 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:	rotary_encoder – Typ: RotaryEncoder *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] 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 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.

Konfigurationsfunktionen für Callbacks¶

void rotary_encoder_register_callback(RotaryEncoder *rotary_encoder, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * 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 rotary_encoder_set_count_callback_period(RotaryEncoder *rotary_encoder, uint32_t period)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

Der ROTARY_ENCODER_CALLBACK_COUNT Callback wird nur ausgelöst, wenn sich der Zählerwert seit der letzten Auslösung geändert hat.

int rotary_encoder_get_count_callback_period(RotaryEncoder *rotary_encoder, uint32_t *ret_period)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int rotary_encoder_set_count_callback_threshold(RotaryEncoder *rotary_encoder, char option, int32_t min, int32_t max)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den Schwellwert für den ROTARY_ENCODER_CALLBACK_COUNT_REACHED Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn der Zählerwert außerhalb der min und max Werte ist
'i'	Callback wird ausgelöst, wenn die Zählerwert innerhalb der min und max Werte ist
'<'	Callback wird ausgelöst, wenn die Zählerwert kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Zählerwert größer als der min Wert ist (max wird ignoriert)

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

Für option:

ROTARY_ENCODER_THRESHOLD_OPTION_OFF = 'x'
ROTARY_ENCODER_THRESHOLD_OPTION_OUTSIDE = 'o'
ROTARY_ENCODER_THRESHOLD_OPTION_INSIDE = 'i'
ROTARY_ENCODER_THRESHOLD_OPTION_SMALLER = '<'
ROTARY_ENCODER_THRESHOLD_OPTION_GREATER = '>'

int rotary_encoder_get_count_callback_threshold(RotaryEncoder *rotary_encoder, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder *
Ausgabeparameter:	ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 ret_max – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt den Schwellwert zurück, wie von rotary_encoder_set_count_callback_threshold() gesetzt.

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

Für ret_option:

ROTARY_ENCODER_THRESHOLD_OPTION_OFF = 'x'
ROTARY_ENCODER_THRESHOLD_OPTION_OUTSIDE = 'o'
ROTARY_ENCODER_THRESHOLD_OPTION_INSIDE = 'i'
ROTARY_ENCODER_THRESHOLD_OPTION_SMALLER = '<'
ROTARY_ENCODER_THRESHOLD_OPTION_GREATER = '>'

int rotary_encoder_set_debounce_period(RotaryEncoder *rotary_encoder, uint32_t debounce)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

Setzt die Periode mit welcher der Schwellwert-Callback

ROTARY_ENCODER_CALLBACK_COUNT_REACHED

ausgelöst wird, wenn der Schwellwert

rotary_encoder_set_count_callback_threshold()

weiterhin erreicht bleibt.

int rotary_encoder_get_debounce_period(RotaryEncoder *rotary_encoder, uint32_t *ret_debounce)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder *
Ausgabeparameter:	ret_debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	e_code – Typ: int

Gibt die Entprellperiode zurück, wie von rotary_encoder_set_debounce_period() gesetzt.

Callbacks¶

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

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

rotary_encoder_register_callback(&rotary_encoder,
                                 ROTARY_ENCODER_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.

ROTARY_ENCODER_CALLBACK_COUNT¶

void callback(int32_t count, void *user_data)

Callback-Parameter:	count – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit rotary_encoder_set_count_callback_period(), ausgelöst. Der Parameter ist der Zählerwert des Encoders.

Der ROTARY_ENCODER_CALLBACK_COUNT Callback wird nur ausgelöst, wenn sich der Zähler seit der letzten Auslösung geändert hat.

ROTARY_ENCODER_CALLBACK_COUNT_REACHED¶

void callback(int32_t count, void *user_data)

Callback-Parameter:	count – Typ: int32_t, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von rotary_encoder_set_count_callback_threshold() gesetzt, erreicht wird. Der Parameter ist der Zählerwert des Encoders.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit rotary_encoder_set_debounce_period() gesetzt, ausgelöst.

ROTARY_ENCODER_CALLBACK_PRESSED¶

void callback(void *user_data)

Callback-Parameter:	user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.

ROTARY_ENCODER_CALLBACK_RELEASED¶

void callback(void *user_data)

Callback-Parameter:	user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.

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 rotary_encoder_get_api_version(RotaryEncoder *rotary_encoder, uint8_t ret_api_version[3])¶

Parameter:	rotary_encoder – Typ: RotaryEncoder *
Ausgabeparameter:	ret_api_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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

int rotary_encoder_get_response_expected(RotaryEncoder *rotary_encoder, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels rotary_encoder_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:

ROTARY_ENCODER_FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
ROTARY_ENCODER_FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
ROTARY_ENCODER_FUNCTION_SET_DEBOUNCE_PERIOD = 6

int rotary_encoder_set_response_expected(RotaryEncoder *rotary_encoder, uint8_t function_id, bool response_expected)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

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

Für function_id:

ROTARY_ENCODER_FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
ROTARY_ENCODER_FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
ROTARY_ENCODER_FUNCTION_SET_DEBOUNCE_PERIOD = 6

int rotary_encoder_set_response_expected_all(RotaryEncoder *rotary_encoder, bool response_expected)¶

Parameter:	rotary_encoder – Typ: RotaryEncoder * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Konstanten¶

ROTARY_ENCODER_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Rotary Encoder Bricklet zu identifizieren.

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

ROTARY_ENCODER_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Rotary Encoder Bricklet dar.