C/C++ - Multi Touch Bricklet

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

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

#include "ip_connection.h"
#include "bricklet_multi_touch.h"

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

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

    // Create device object
    MultiTouch mt;
    multi_touch_create(&mt, 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 touch state
    uint16_t state;
    if(multi_touch_get_touch_state(&mt, &state) < 0) {
        fprintf(stderr, "Could not get touch state, probably timeout\n");
        return 1;
    }

    if(state & (1 << 12)) {
        printf("In proximity, ");
    }

    if((state & 0xfff) == 0) {
        printf("No electrodes touched\n");
    } else {
        printf("Electrodes ");
        int i;
        for(i = 0; i < 12; i++) {
            if(state & (1 << i)) {
                printf("%d ", i);
            }
        }
        printf("touched\n");
    }

    printf("Press key to exit\n");
    getchar();
    multi_touch_destroy(&mt);
    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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_multi_touch.h"

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

// Callback function for touch state callback
void cb_touch_state(uint16_t state, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    if(state & (1 << 12)) {
        printf("In proximity, ");
    }

    if((state & 0xfff) == 0) {
        printf("No electrodes touched\n");
    } else {
        printf("Electrodes ");
        int i;
        for(i = 0; i < 12; i++) {
            if(state & (1 << i)) {
                printf("%d ", i);
            }
        }
        printf("touched\n");
    }
}

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

    // Create device object
    MultiTouch mt;
    multi_touch_create(&mt, 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 touch state callback to function cb_touch_state
    multi_touch_register_callback(&mt,
                                  MULTI_TOUCH_CALLBACK_TOUCH_STATE,
                                  (void (*)(void))cb_touch_state,
                                  NULL);

    printf("Press key to exit\n");
    getchar();
    multi_touch_destroy(&mt);
    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 multi_touch_create(MultiTouch *multi_touch, const char *uid, IPConnection *ipcon)
Parameter:
  • multi_touch – Typ: MultiTouch *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

MultiTouch multi_touch;
multi_touch_create(&multi_touch, "YOUR_DEVICE_UID", &ipcon);

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

void multi_touch_destroy(MultiTouch *multi_touch)
Parameter:
  • multi_touch – Typ: MultiTouch *

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

int multi_touch_get_touch_state(MultiTouch *multi_touch, uint16_t *ret_state)
Parameter:
  • multi_touch – Typ: MultiTouch *
Ausgabeparameter:
  • ret_state – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Tastzustand zurück. Der Zustand ist als ein Bitfeld repräsentiert.

Bits 0 bis 11 repräsentieren die 12 Elektroden und Bit 12 repräsentiert die Proximity (Nähe).

Wird eine Elektrode berührt, ist das korrespondierende Bit true. Wenn eine Hand oder vergleichbares in der Nähe der Elektroden ist wird Bit 12 auf true gesetzt.

Beispiel: Der Zustand 4103 = 0x1007 = 0b1000000000111 bedeutet dass die Elektroden 0, 1 und 2 berührt werden und das sich etwas in der nähe der Elektroden befindet.

Das Proximity Bit wird ab einer Distanz von ca. 1-2cm aktiviert. Eine Elektrode wird schon als berührt gezählt wenn ein Finger sie beinahe berührt. Dadurch ist es möglich ein Stück Papier oder Folie über die Elektrode zu kleben um damit ein Touchpanel mit einem professionellen Aussehen zu bauen.

int multi_touch_recalibrate(MultiTouch *multi_touch)
Parameter:
  • multi_touch – Typ: MultiTouch *
Rückgabe:
  • error_code – Typ: int

Rekalibriert die Elektroden. Rufe diese Funktion auf wenn die Elektroden verändert oder bewegt wurden.

int multi_touch_set_electrode_config(MultiTouch *multi_touch, uint16_t enabled_electrodes)
Parameter:
  • multi_touch – Typ: MultiTouch *
  • enabled_electrodes – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Aktiviert/deaktiviert Elektroden mit einem Bitfeld (siehe multi_touch_get_touch_state()).

True aktiviert eine Elektrode, false deaktiviert eine Elektrode. Eine deaktivierte Elektrode hat immer den Zustand false. Wenn nicht alle Elektroden gebraucht werden können die ungebrauchten deaktiviert werden.

Wir empfehlen das Proximity Bit (Bit 12) zu deaktivieren wenn das Proximity-Feature nicht benötigt wird. Das verringert den Datenverkehr der durch den MULTI_TOUCH_CALLBACK_TOUCH_STATE Callback ausgelöst wird.

Eine deaktivierte Elektrode verringert zusätzlich den Stromverbrauch.

Standardwert: 8191 = 0x1FFF = 0b1111111111111 (alle Elektroden aktiviert)

int multi_touch_get_electrode_config(MultiTouch *multi_touch, uint16_t *ret_enabled_electrodes)
Parameter:
  • multi_touch – Typ: MultiTouch *
Ausgabeparameter:
  • ret_enabled_electrodes – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Elektrodenkonfiguration zurück, wie von multi_touch_set_electrode_config() gesetzt.

int multi_touch_set_electrode_sensitivity(MultiTouch *multi_touch, uint8_t sensitivity)
Parameter:
  • multi_touch – Typ: MultiTouch *
  • sensitivity – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Setzt die Empfindlichkeit der Elektrode. Eine Elektrode mit einer hohen Empfindlichkeit registriert eine Berührung früher als eine Elektrode mit einer niedrigen Empfindlichkeit.

Wenn eine große Elektrode verwendet wird sollte die Empfindlichkeit verringert werden, da eine größere Fläche aufgeladen werden kann. Wenn eine Elektrode aus größerem Abstand aktivierbar seien soll, muss die Empfindlichkeit vergrößert werden.

Nachdem eine neue Empfindlichkeit gesetzt wurde, macht es Sinn multi_touch_recalibrate() aufzurufen damit die Elektroden mit der neu definierten Empfindlichkeit kalibriert werden.

Der zulässige Wertebereich für den Empfindlichkeitswert ist 5-201.

Der voreingestellte Empfindlichkeitswert ist 181.

int multi_touch_get_electrode_sensitivity(MultiTouch *multi_touch, uint8_t *ret_sensitivity)
Parameter:
  • multi_touch – Typ: MultiTouch *
Ausgabeparameter:
  • ret_sensitivity – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die aktuelle Empfindlichkeit zurück, wie von multi_touch_set_electrode_sensitivity() gesetzt.

Fortgeschrittene Funktionen

int multi_touch_get_api_version(MultiTouch *multi_touch, uint8_t ret_api_version[3])
Parameter:
  • multi_touch – Typ: MultiTouch *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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 multi_touch_get_response_expected(MultiTouch *multi_touch, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • multi_touch – Typ: MultiTouch *
  • 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 multi_touch_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:

  • MULTI_TOUCH_FUNCTION_RECALIBRATE = 2
  • MULTI_TOUCH_FUNCTION_SET_ELECTRODE_CONFIG = 3
  • MULTI_TOUCH_FUNCTION_SET_ELECTRODE_SENSITIVITY = 6
int multi_touch_set_response_expected(MultiTouch *multi_touch, uint8_t function_id, bool response_expected)
Parameter:
  • multi_touch – Typ: MultiTouch *
  • 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:

  • MULTI_TOUCH_FUNCTION_RECALIBRATE = 2
  • MULTI_TOUCH_FUNCTION_SET_ELECTRODE_CONFIG = 3
  • MULTI_TOUCH_FUNCTION_SET_ELECTRODE_SENSITIVITY = 6
int multi_touch_set_response_expected_all(MultiTouch *multi_touch, bool response_expected)
Parameter:
  • multi_touch – Typ: MultiTouch *
  • 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.

int multi_touch_get_identity(MultiTouch *multi_touch, 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:
  • multi_touch – Typ: MultiTouch *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char
  • ret_hardware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3], 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 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 multi_touch_register_callback(MultiTouch *multi_touch, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • multi_touch – Typ: MultiTouch *
  • 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.

Callbacks

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

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

multi_touch_register_callback(&multi_touch, MULTI_TOUCH_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.

MULTI_TOUCH_CALLBACK_TOUCH_STATE
void callback(uint16_t state, void *user_data)
Callback-Parameter:
  • state – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • user_data – Typ: void *

Gibt den aktuellen Tastzustand zurück, siehe multi_touch_get_touch_state() für mehr Informationen über den Zustand.

Dieser Callback wird ausgelöst, wenn sich ein Tastzustand ändert.

Konstanten

MULTI_TOUCH_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Multi Touch Bricklet zu identifizieren.

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

MULTI_TOUCH_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Multi Touch Bricklet dar.