C/C++ - Dual Button Bricklet

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

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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_dual_button.h"

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

// Callback function for state changed callback
void cb_state_changed(uint8_t button_l, uint8_t button_r, uint8_t led_l, uint8_t led_r,
                      void *user_data) {
    (void)led_l; (void)led_r; (void)user_data; // avoid unused parameter warning

    if(button_l == DUAL_BUTTON_BUTTON_STATE_PRESSED) {
        printf("Left Button: Pressed\n");
    } else if(button_l == DUAL_BUTTON_BUTTON_STATE_RELEASED) {
        printf("Left Button: Released\n");
    }

    if(button_r == DUAL_BUTTON_BUTTON_STATE_PRESSED) {
        printf("Right Button: Pressed\n");
    } else if(button_r == DUAL_BUTTON_BUTTON_STATE_RELEASED) {
        printf("Right Button: Released\n");
    }

    printf("\n");
}

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

    // Create device object
    DualButton db;
    dual_button_create(&db, 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 state changed callback to function cb_state_changed
    dual_button_register_callback(&db,
                                  DUAL_BUTTON_CALLBACK_STATE_CHANGED,
                                  (void (*)(void))cb_state_changed,
                                  NULL);

    printf("Press key to exit\n");
    getchar();
    dual_button_destroy(&db);
    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 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 dual_button_create(DualButton *dual_button, const char *uid, IPConnection *ipcon)

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

DualButton dual_button;
dual_button_create(&dual_button, "YOUR_DEVICE_UID", &ipcon);

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

void dual_button_destroy(DualButton *dual_button)

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

int dual_button_set_led_state(DualButton *dual_button, uint8_t led_l, uint8_t led_r)

Setzt den Zustand der LEDs. Möglich Zustände sind:

  • 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
  • 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
  • 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit dual_button_get_led_state() ausgelesen werden oder es kann dual_button_set_selected_led_state() genutzt werden.

Der Standardwert ist (1, 1).

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

  • DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
  • DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
  • DUAL_BUTTON_LED_STATE_ON = 2
  • DUAL_BUTTON_LED_STATE_OFF = 3
int dual_button_get_led_state(DualButton *dual_button, uint8_t *ret_led_l, uint8_t *ret_led_r)

Gibt den aktuellen Zustand der LEDs zurück, wie von dual_button_set_led_state() gesetzt.

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

  • DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
  • DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
  • DUAL_BUTTON_LED_STATE_ON = 2
  • DUAL_BUTTON_LED_STATE_OFF = 3
int dual_button_get_button_state(DualButton *dual_button, uint8_t *ret_button_l, uint8_t *ret_button_r)

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

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

  • DUAL_BUTTON_BUTTON_STATE_PRESSED = 0
  • DUAL_BUTTON_BUTTON_STATE_RELEASED = 1

Fortgeschrittene Funktionen

int dual_button_set_selected_led_state(DualButton *dual_button, uint8_t led, uint8_t state)

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

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

  • DUAL_BUTTON_LED_LEFT = 0
  • DUAL_BUTTON_LED_RIGHT = 1
  • DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
  • DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
  • DUAL_BUTTON_LED_STATE_ON = 2
  • DUAL_BUTTON_LED_STATE_OFF = 3
int dual_button_get_api_version(DualButton *dual_button, uint8_t ret_api_version[3])

Gibt die Version der API Definition (Major, Minor, Revision) 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 dual_button_get_response_expected(DualButton *dual_button, uint8_t function_id, bool *ret_response_expected)

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 dual_button_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:

  • DUAL_BUTTON_FUNCTION_SET_LED_STATE = 1
  • DUAL_BUTTON_FUNCTION_SET_SELECTED_LED_STATE = 5
int dual_button_set_response_expected(DualButton *dual_button, uint8_t function_id, bool response_expected)

Ä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:

  • DUAL_BUTTON_FUNCTION_SET_LED_STATE = 1
  • DUAL_BUTTON_FUNCTION_SET_SELECTED_LED_STATE = 5
int dual_button_set_response_expected_all(DualButton *dual_button, bool response_expected)

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

int dual_button_get_identity(DualButton *dual_button, 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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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 dual_button_register_callback(DualButton *dual_button, int16_t callback_id, void (*function)(void), void *user_data)

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.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion dual_button_register_callback() durchgeführt werden. Die Parameter bestehen aus dem Geräteobjekt, der Callback ID, der Callback Funktion und optionalen Benutzer Daten:

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

dual_button_register_callback(&dual_button, DUAL_BUTTON_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

Die verfügbaren IDs mit den zugehörigen Callback 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.

DUAL_BUTTON_CALLBACK_STATE_CHANGED
void callback(uint8_t button_l, uint8_t button_r, uint8_t led_l, uint8_t led_r, void *user_data)

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

  • 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
  • 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
  • 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

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

  • DUAL_BUTTON_BUTTON_STATE_PRESSED = 0
  • DUAL_BUTTON_BUTTON_STATE_RELEASED = 1
  • DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_ON = 0
  • DUAL_BUTTON_LED_STATE_AUTO_TOGGLE_OFF = 1
  • DUAL_BUTTON_LED_STATE_ON = 2
  • DUAL_BUTTON_LED_STATE_OFF = 3

Konstanten

DUAL_BUTTON_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Dual Button Bricklet zu identifizieren.

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

DUAL_BUTTON_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.