C/C++ - Joystick Bricklet¶

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

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

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

    // Create device object
    Joystick j;
    joystick_create(&j, 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 position
    int16_t x, y;
    if(joystick_get_position(&j, &x, &y) < 0) {
        fprintf(stderr, "Could not get position, probably timeout\n");
        return 1;
    }

    printf("Position [X]: %d\n", x);
    printf("Position [Y]: %d\n", y);

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_joystick.h"

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

// Callback function for pressed callback
void cb_pressed(void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Pressed\n");
}

// Callback function for released callback
void cb_released(void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Released\n");
}

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

    // Create device object
    Joystick j;
    joystick_create(&j, 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 pressed callback to function cb_pressed
    joystick_register_callback(&j,
                               JOYSTICK_CALLBACK_PRESSED,
                               (void (*)(void))cb_pressed,
                               NULL);

    // Register released callback to function cb_released
    joystick_register_callback(&j,
                               JOYSTICK_CALLBACK_RELEASED,
                               (void (*)(void))cb_released,
                               NULL);

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

Find Borders¶

Download (example_find_borders.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_joystick.h"

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

// Callback function for position reached callback
void cb_position_reached(int16_t x, int16_t y, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    if(y == 100) {
        printf("Top\n");
    } else if(y == -100) {
        printf("Bottom\n");
    }

    if(x == 100) {
        printf("Right\n");
    } else if(x == -100) {
        printf("Left\n");
    }

    printf("\n");
}

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

    // Create device object
    Joystick j;
    joystick_create(&j, 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 threshold callbacks with a debounce time of 0.2 seconds (200ms)
    joystick_set_debounce_period(&j, 200);

    // Register position reached callback to function cb_position_reached
    joystick_register_callback(&j,
                               JOYSTICK_CALLBACK_POSITION_REACHED,
                               (void (*)(void))cb_position_reached,
                               NULL);

    // Configure threshold for position "outside of -99, -99 to 99, 99"
    joystick_set_position_callback_threshold(&j, 'o', -99, 99, -99, 99);

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

Windows Mouse¶

Download (example_windows_mouse.c)

// This example is Windows only. Link to user32.lib in addition to ws2_32.lib

#include <stdio.h>

#ifdef _WIN32

#include <windows.h>

#include "ip_connection.h"
#include "bricklet_joystick.h"

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

// Fake a mouse button event
void send_mouse_button(uint32_t event) {
    INPUT input;

    memset(&input, 0, sizeof(INPUT));

    input.type = INPUT_MOUSE;
    input.mi.dwFlags = event;

    SendInput(1, &input, sizeof(INPUT));
}

// Fake a mouse move event
void send_mouse_move(int16_t x, int16_t y) {
    INPUT input;
    memset(&input, 0, sizeof(INPUT));

    input.type = INPUT_MOUSE;
    input.mi.dx = x;
    input.mi.dy = y;
    input.mi.dwFlags = MOUSEEVENTF_MOVE;

    SendInput(1, &input, sizeof(INPUT));
}

// Callback function for pressed and released events
void cb_pressed(void *user_data) {
    (void)user_data; // avoid unused parameter warning

    send_mouse_button(MOUSEEVENTF_LEFTDOWN);
}

void cb_released(void *user_data) {
    (void)user_data; // avoid unused parameter warning

    send_mouse_button(MOUSEEVENTF_LEFTUP);
}

// Joystick moves mouse and the button is mapped to left mouse button
int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    Joystick j;
    joystick_create(&j, 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 pressed callback to function cb_pressed
    joystick_register_callback(&j,
                               JOYSTICK_CALLBACK_PRESSED,
                               (void (*)(void))cb_pressed,
                               NULL);

    // Register released callback to function cb_released
    joystick_register_callback(&j,
                               JOYSTICK_CALLBACK_RELEASED,
                               (void (*)(void))cb_released,
                               NULL);

    printf("Press ctrl+c to exit\n");

    while(true) {
        // Get current position
        int16_t x, y;
        if(joystick_get_position(&j, &x, &y) < 0) {
            fprintf(stderr, "Could not get position, probably timeout\n");
            return 1;
        }

        x = x / 4; // Slow down by factor of 4
        y = -y / 4; // Slow down by factor of 4 and invert axis

        send_mouse_move(x, y);

        Sleep(25); // Check Joystick position every 0.025s (25ms)
    }

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

#else

int main(void) {
    printf("This example is Windows only!\n");
    return 0;
}

#endif

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 joystick_create(Joystick *joystick, const char *uid, IPConnection *ipcon)¶

Parameter:	joystick – Typ: Joystick * uid – Typ: const char * ipcon – Typ: IPConnection *

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

Joystick joystick;
joystick_create(&joystick, "YOUR_DEVICE_UID", &ipcon);

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

void joystick_destroy(Joystick *joystick)¶

Parameter:	joystick – Typ: Joystick *

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

int joystick_get_position(Joystick *joystick, int16_t *ret_x, int16_t *ret_y)¶

Parameter:	joystick – Typ: Joystick *
Ausgabeparameter:	ret_x – Typ: int16_t, Wertebereich: [-100 bis 100] ret_y – Typ: int16_t, Wertebereich: [-100 bis 100]
Rückgabe:	e_code – Typ: int

Gibt die Position des Joystick zurück. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe joystick_calibrate()).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den JOYSTICK_CALLBACK_POSITION Callback zu nutzen und die Periode mit joystick_set_position_callback_period() vorzugeben.

int joystick_is_pressed(Joystick *joystick, bool *ret_pressed)¶

Parameter:	joystick – Typ: Joystick *
Ausgabeparameter:	ret_pressed – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Es wird empfohlen die JOYSTICK_CALLBACK_PRESSED und JOYSTICK_CALLBACK_RELEASED Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen¶

int joystick_get_analog_value(Joystick *joystick, uint16_t *ret_x, uint16_t *ret_y)¶

Parameter:	joystick – Typ: Joystick *
Ausgabeparameter:	ret_x – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1] ret_y – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1]
Rückgabe:	e_code – Typ: int

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von joystick_get_position() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während joystick_get_analog_value() unverarbeitete Analogwerte zurück gibt. Der einzige Grund joystick_get_analog_value() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den JOYSTICK_CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit joystick_set_analog_value_callback_period() vorzugeben.

int joystick_calibrate(Joystick *joystick)¶

Parameter:	joystick – Typ: Joystick *
Rückgabe:	e_code – Typ: int

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

int joystick_get_identity(Joystick *joystick, 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:	joystick – Typ: Joystick *
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 joystick_register_callback(Joystick *joystick, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	joystick – Typ: Joystick * 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 joystick_set_position_callback_period(Joystick *joystick, uint32_t period)¶

Parameter:	joystick – Typ: Joystick * 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 JOYSTICK_CALLBACK_POSITION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

The JOYSTICK_CALLBACK_POSITION Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

int joystick_get_position_callback_period(Joystick *joystick, uint32_t *ret_period)¶

Parameter:	joystick – Typ: Joystick *
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 joystick_set_position_callback_period() gesetzt.

int joystick_set_analog_value_callback_period(Joystick *joystick, uint32_t period)¶

Parameter:	joystick – Typ: Joystick * 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 JOYSTICK_CALLBACK_ANALOG_VALUE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der JOYSTICK_CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

int joystick_get_analog_value_callback_period(Joystick *joystick, uint32_t *ret_period)¶

Parameter:	joystick – Typ: Joystick *
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 joystick_set_analog_value_callback_period() gesetzt.

int joystick_set_position_callback_threshold(Joystick *joystick, char option, int16_t min_x, int16_t max_x, int16_t min_y, int16_t max_y)¶

Parameter:

Parameter:	joystick – Typ: Joystick * option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min_x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 min_y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

joystick – Typ: Joystick *
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min_x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
max_x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
min_y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
max_y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Setzt den Schwellwert für den JOYSTICK_CALLBACK_POSITION_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

JOYSTICK_THRESHOLD_OPTION_OFF = 'x'
JOYSTICK_THRESHOLD_OPTION_OUTSIDE = 'o'
JOYSTICK_THRESHOLD_OPTION_INSIDE = 'i'
JOYSTICK_THRESHOLD_OPTION_SMALLER = '<'
JOYSTICK_THRESHOLD_OPTION_GREATER = '>'

int joystick_get_position_callback_threshold(Joystick *joystick, char *ret_option, int16_t *ret_min_x, int16_t *ret_max_x, int16_t *ret_min_y, int16_t *ret_max_y)¶

Parameter:	joystick – Typ: Joystick *
Ausgabeparameter:	ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min_x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 ret_max_x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 ret_min_y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 ret_max_y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

JOYSTICK_THRESHOLD_OPTION_OFF = 'x'
JOYSTICK_THRESHOLD_OPTION_OUTSIDE = 'o'
JOYSTICK_THRESHOLD_OPTION_INSIDE = 'i'
JOYSTICK_THRESHOLD_OPTION_SMALLER = '<'
JOYSTICK_THRESHOLD_OPTION_GREATER = '>'

int joystick_set_analog_value_callback_threshold(Joystick *joystick, char option, uint16_t min_x, uint16_t max_x, uint16_t min_y, uint16_t max_y)¶

Parameter:

Parameter:	joystick – Typ: Joystick * option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min_x – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_x – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 min_y – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_y – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

joystick – Typ: Joystick *
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min_x – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
max_x – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
min_y – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
max_y – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

Setzt den Schwellwert für den JOYSTICK_CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

JOYSTICK_THRESHOLD_OPTION_OFF = 'x'
JOYSTICK_THRESHOLD_OPTION_OUTSIDE = 'o'
JOYSTICK_THRESHOLD_OPTION_INSIDE = 'i'
JOYSTICK_THRESHOLD_OPTION_SMALLER = '<'
JOYSTICK_THRESHOLD_OPTION_GREATER = '>'

int joystick_get_analog_value_callback_threshold(Joystick *joystick, char *ret_option, uint16_t *ret_min_x, uint16_t *ret_max_x, uint16_t *ret_min_y, uint16_t *ret_max_y)¶

Parameter:	joystick – Typ: Joystick *
Ausgabeparameter:	ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min_x – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_max_x – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_min_y – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 ret_max_y – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

JOYSTICK_THRESHOLD_OPTION_OFF = 'x'
JOYSTICK_THRESHOLD_OPTION_OUTSIDE = 'o'
JOYSTICK_THRESHOLD_OPTION_INSIDE = 'i'
JOYSTICK_THRESHOLD_OPTION_SMALLER = '<'
JOYSTICK_THRESHOLD_OPTION_GREATER = '>'

int joystick_set_debounce_period(Joystick *joystick, uint32_t debounce)¶

Parameter:	joystick – Typ: Joystick * 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 die Schwellwert Callbacks

JOYSTICK_CALLBACK_POSITION_REACHED,
JOYSTICK_CALLBACK_ANALOG_VALUE_REACHED

ausgelöst werden, wenn die Schwellwerte

joystick_set_position_callback_threshold(),
joystick_set_analog_value_callback_threshold()

weiterhin erreicht bleiben.

int joystick_get_debounce_period(Joystick *joystick, uint32_t *ret_debounce)¶

Parameter:	joystick – Typ: Joystick *
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 joystick_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 joystick_register_callback() Funktion durchgeführt werden:

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

joystick_register_callback(&joystick,
                           JOYSTICK_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.

JOYSTICK_CALLBACK_POSITION¶

void callback(int16_t x, int16_t y, void *user_data)

Callback-Parameter:	x – Typ: int16_t, Wertebereich: [-100 bis 100] y – Typ: int16_t, Wertebereich: [-100 bis 100] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit joystick_set_position_callback_period(), ausgelöst. Der Parameter ist die Position des Joysticks.

Der JOYSTICK_CALLBACK_POSITION Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

JOYSTICK_CALLBACK_ANALOG_VALUE¶

void callback(uint16_t x, uint16_t y, void *user_data)

Callback-Parameter:	x – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1] y – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1] user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit joystick_set_analog_value_callback_period(), ausgelöst. Der Parameter sind die Analogwerte des Joysticks.

Der JOYSTICK_CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

JOYSTICK_CALLBACK_POSITION_REACHED¶

void callback(int16_t x, int16_t y, void *user_data)

Callback-Parameter:	x – Typ: int16_t, Wertebereich: [-100 bis 100] y – Typ: int16_t, Wertebereich: [-100 bis 100] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von joystick_set_position_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Position des Joysticks.

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

JOYSTICK_CALLBACK_ANALOG_VALUE_REACHED¶

void callback(uint16_t x, uint16_t y, void *user_data)

Callback-Parameter:	x – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1] y – Typ: uint16_t, Wertebereich: [0 bis 2¹² - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von joystick_set_analog_value_callback_threshold() gesetzt, erreicht wird. Der Parameter sind die Analogwerte des Joystick.

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

JOYSTICK_CALLBACK_PRESSED¶

void callback(void *user_data)

Callback-Parameter:	user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

JOYSTICK_CALLBACK_RELEASED¶

void callback(void *user_data)

Callback-Parameter:	user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn die Taste 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 joystick_get_api_version(Joystick *joystick, uint8_t ret_api_version[3])¶

Parameter:	joystick – Typ: Joystick *
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 joystick_get_response_expected(Joystick *joystick, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	joystick – Typ: Joystick * 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 joystick_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:

JOYSTICK_FUNCTION_CALIBRATE = 4
JOYSTICK_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
JOYSTICK_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
JOYSTICK_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
JOYSTICK_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
JOYSTICK_FUNCTION_SET_DEBOUNCE_PERIOD = 13

int joystick_set_response_expected(Joystick *joystick, uint8_t function_id, bool response_expected)¶

Parameter:	joystick – Typ: Joystick * 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:

JOYSTICK_FUNCTION_CALIBRATE = 4
JOYSTICK_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
JOYSTICK_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
JOYSTICK_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
JOYSTICK_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
JOYSTICK_FUNCTION_SET_DEBOUNCE_PERIOD = 13

int joystick_set_response_expected_all(Joystick *joystick, bool response_expected)¶

Parameter:	joystick – Typ: Joystick * 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¶

JOYSTICK_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Joystick Bricklet zu identifizieren.

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

JOYSTICK_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.