Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / Multi Touch Bricklet 2.0

C/C++ - Multi Touch Bricklet 2.0¶

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

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

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

    // Create device object
    MultiTouchV2 mt;
    multi_touch_v2_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
    bool state[13];
    if(multi_touch_v2_get_touch_state(&mt, state) < 0) {
        fprintf(stderr, "Could not get touch state, probably timeout\n");
        return 1;
    }

    printf("Electrode 0: %s\n", state[0] ? "true" : "false");
    printf("Electrode 1: %s\n", state[1] ? "true" : "false");
    printf("Electrode 2: %s\n", state[2] ? "true" : "false");
    printf("Electrode 3: %s\n", state[3] ? "true" : "false");
    printf("Electrode 4: %s\n", state[4] ? "true" : "false");
    printf("Electrode 5: %s\n", state[5] ? "true" : "false");
    printf("Electrode 6: %s\n", state[6] ? "true" : "false");
    printf("Electrode 7: %s\n", state[7] ? "true" : "false");
    printf("Electrode 8: %s\n", state[8] ? "true" : "false");
    printf("Electrode 9: %s\n", state[9] ? "true" : "false");
    printf("Electrode 10: %s\n", state[10] ? "true" : "false");
    printf("Electrode 11: %s\n", state[11] ? "true" : "false");
    printf("Proximity: %s\n", state[12] ? "true" : "false");

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_multi_touch_v2.h"

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

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

    printf("Electrode 0: %s\n", state[0] ? "true" : "false");
    printf("Electrode 1: %s\n", state[1] ? "true" : "false");
    printf("Electrode 2: %s\n", state[2] ? "true" : "false");
    printf("Electrode 3: %s\n", state[3] ? "true" : "false");
    printf("Electrode 4: %s\n", state[4] ? "true" : "false");
    printf("Electrode 5: %s\n", state[5] ? "true" : "false");
    printf("Electrode 6: %s\n", state[6] ? "true" : "false");
    printf("Electrode 7: %s\n", state[7] ? "true" : "false");
    printf("Electrode 8: %s\n", state[8] ? "true" : "false");
    printf("Electrode 9: %s\n", state[9] ? "true" : "false");
    printf("Electrode 10: %s\n", state[10] ? "true" : "false");
    printf("Electrode 11: %s\n", state[11] ? "true" : "false");
    printf("Proximity: %s\n", state[12] ? "true" : "false");
    printf("\n");
}

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

    // Create device object
    MultiTouchV2 mt;
    multi_touch_v2_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_v2_register_callback(&mt,
                                     MULTI_TOUCH_V2_CALLBACK_TOUCH_STATE,
                                     (void (*)(void))cb_touch_state,
                                     NULL);

    // Set period for touch state callback to 0.01s (10ms)
    multi_touch_v2_set_touch_state_callback_configuration(&mt, 10, true);

    printf("Press key to exit\n");
    getchar();
    multi_touch_v2_destroy(&mt);
    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 multi_touch_v2_create(MultiTouchV2 *multi_touch_v2, const char *uid, IPConnection *ipcon)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

MultiTouchV2 multi_touch_v2;
multi_touch_v2_create(&multi_touch_v2, "YOUR_DEVICE_UID", &ipcon);

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

void multi_touch_v2_destroy(MultiTouchV2 *multi_touch_v2)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *

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

int multi_touch_v2_get_touch_state(MultiTouchV2 *multi_touch_v2, bool ret_state[13])¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_state – Typ: bool[13]
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Tastzustand zurück. Der Zustand wird als Bool-Array repräsentiert.

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

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

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.

Wenn der Wert periodisch benötigt wird, kann auch der MULTI_TOUCH_V2_CALLBACK_TOUCH_STATE Callback verwendet werden. Der Callback wird mit der Funktion multi_touch_v2_set_touch_state_callback_configuration() konfiguriert.

int multi_touch_v2_recalibrate(MultiTouchV2 *multi_touch_v2)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Rückgabe:	e_code – Typ: int

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

int multi_touch_v2_set_electrode_config(MultiTouchV2 *multi_touch_v2, bool enabled_electrodes[13])¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * enabled_electrodes – Typ: bool[13], Standardwert: {true, true, true, true, true, true, true, true, true, true, true, true, true}
Rückgabe:	e_code – Typ: int

Aktiviert/deaktiviert Elektroden mit einem Bool-Array (siehe multi_touch_v2_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 die Proximity-Elektrode (Element 12) zu deaktivieren wenn das Proximity-Feature nicht benötigt wird. Das verringert den Datenverkehr der durch den MULTI_TOUCH_V2_CALLBACK_TOUCH_STATE Callback ausgelöst wird.

Eine deaktivierte Elektrode verringert zusätzlich den Stromverbrauch.

int multi_touch_v2_get_electrode_config(MultiTouchV2 *multi_touch_v2, bool ret_enabled_electrodes[13])¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_enabled_electrodes – Typ: bool[13], Standardwert: {true, true, true, true, true, true, true, true, true, true, true, true, true}
Rückgabe:	e_code – Typ: int

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

int multi_touch_v2_set_electrode_sensitivity(MultiTouchV2 *multi_touch_v2, uint8_t sensitivity)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * sensitivity – Typ: uint8_t, Wertebereich: [5 bis 201], Standardwert: 181
Rückgabe:	e_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_v2_recalibrate() aufzurufen damit die Elektroden mit der neu definierten Empfindlichkeit kalibriert werden.

int multi_touch_v2_get_electrode_sensitivity(MultiTouchV2 *multi_touch_v2, uint8_t *ret_sensitivity)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_sensitivity – Typ: uint8_t, Wertebereich: [5 bis 201], Standardwert: 181
Rückgabe:	e_code – Typ: int

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

int multi_touch_v2_set_touch_led_config(MultiTouchV2 *multi_touch_v2, uint8_t config)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED den Touch-Zustand anzuzeigen (Elektrode berührt = LED an).

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

Für config:

MULTI_TOUCH_V2_TOUCH_LED_CONFIG_OFF = 0
MULTI_TOUCH_V2_TOUCH_LED_CONFIG_ON = 1
MULTI_TOUCH_V2_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
MULTI_TOUCH_V2_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

int multi_touch_v2_get_touch_led_config(MultiTouchV2 *multi_touch_v2, uint8_t *ret_config)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die LED-Konfiguration zurück, wie von multi_touch_v2_set_touch_led_config() gesetzt.

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

Für ret_config:

MULTI_TOUCH_V2_TOUCH_LED_CONFIG_OFF = 0
MULTI_TOUCH_V2_TOUCH_LED_CONFIG_ON = 1
MULTI_TOUCH_V2_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
MULTI_TOUCH_V2_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Fortgeschrittene Funktionen¶

int multi_touch_v2_get_spitfp_error_count(MultiTouchV2 *multi_touch_v2, 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:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int multi_touch_v2_set_status_led_config(MultiTouchV2 *multi_touch_v2, uint8_t config)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

MULTI_TOUCH_V2_STATUS_LED_CONFIG_OFF = 0
MULTI_TOUCH_V2_STATUS_LED_CONFIG_ON = 1
MULTI_TOUCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
MULTI_TOUCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int multi_touch_v2_get_status_led_config(MultiTouchV2 *multi_touch_v2, uint8_t *ret_config)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück, wie von multi_touch_v2_set_status_led_config() gesetzt.

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

Für ret_config:

MULTI_TOUCH_V2_STATUS_LED_CONFIG_OFF = 0
MULTI_TOUCH_V2_STATUS_LED_CONFIG_ON = 1
MULTI_TOUCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
MULTI_TOUCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int multi_touch_v2_get_chip_temperature(MultiTouchV2 *multi_touch_v2, int16_t *ret_temperature)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_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 hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int multi_touch_v2_reset(MultiTouchV2 *multi_touch_v2)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Rückgabe:	e_code – Typ: int

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

int multi_touch_v2_get_identity(MultiTouchV2 *multi_touch_v2, 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_v2 – Typ: MultiTouchV2 *
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 multi_touch_v2_register_callback(MultiTouchV2 *multi_touch_v2, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * 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 multi_touch_v2_set_touch_state_callback_configuration(MultiTouchV2 *multi_touch_v2, uint32_t period, bool value_has_to_change)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der MULTI_TOUCH_V2_CALLBACK_TOUCH_STATE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

int multi_touch_v2_get_touch_state_callback_configuration(MultiTouchV2 *multi_touch_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels multi_touch_v2_set_touch_state_callback_configuration() gesetzt.

Callbacks¶

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

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

multi_touch_v2_register_callback(&multi_touch_v2,
                                 MULTI_TOUCH_V2_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_V2_CALLBACK_TOUCH_STATE¶

void callback(bool state[13], void *user_data)

Callback-Parameter:	state – Typ: bool[13] user_data – Typ: void *

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

Dieser Callback wird ausgelöst, wenn sich ein Tastzustand ändert mit der eingestellten Periode (siehe multi_touch_v2_set_touch_state_callback_configuration())

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 multi_touch_v2_get_api_version(MultiTouchV2 *multi_touch_v2, uint8_t ret_api_version[3])¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
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 multi_touch_v2_get_response_expected(MultiTouchV2 *multi_touch_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * 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 multi_touch_v2_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_V2_FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION = 2
MULTI_TOUCH_V2_FUNCTION_RECALIBRATE = 5
MULTI_TOUCH_V2_FUNCTION_SET_ELECTRODE_CONFIG = 6
MULTI_TOUCH_V2_FUNCTION_SET_ELECTRODE_SENSITIVITY = 8
MULTI_TOUCH_V2_FUNCTION_SET_TOUCH_LED_CONFIG = 10
MULTI_TOUCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
MULTI_TOUCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
MULTI_TOUCH_V2_FUNCTION_RESET = 243
MULTI_TOUCH_V2_FUNCTION_WRITE_UID = 248

int multi_touch_v2_set_response_expected(MultiTouchV2 *multi_touch_v2, uint8_t function_id, bool response_expected)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * 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:

MULTI_TOUCH_V2_FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION = 2
MULTI_TOUCH_V2_FUNCTION_RECALIBRATE = 5
MULTI_TOUCH_V2_FUNCTION_SET_ELECTRODE_CONFIG = 6
MULTI_TOUCH_V2_FUNCTION_SET_ELECTRODE_SENSITIVITY = 8
MULTI_TOUCH_V2_FUNCTION_SET_TOUCH_LED_CONFIG = 10
MULTI_TOUCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
MULTI_TOUCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
MULTI_TOUCH_V2_FUNCTION_RESET = 243
MULTI_TOUCH_V2_FUNCTION_WRITE_UID = 248

int multi_touch_v2_set_response_expected_all(MultiTouchV2 *multi_touch_v2, bool response_expected)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * 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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int multi_touch_v2_set_bootloader_mode(MultiTouchV2 *multi_touch_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

MULTI_TOUCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
MULTI_TOUCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

MULTI_TOUCH_V2_BOOTLOADER_STATUS_OK = 0
MULTI_TOUCH_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
MULTI_TOUCH_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
MULTI_TOUCH_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
MULTI_TOUCH_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
MULTI_TOUCH_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int multi_touch_v2_get_bootloader_mode(MultiTouchV2 *multi_touch_v2, uint8_t *ret_mode)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe multi_touch_v2_set_bootloader_mode().

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

Für ret_mode:

MULTI_TOUCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
MULTI_TOUCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int multi_touch_v2_set_write_firmware_pointer(MultiTouchV2 *multi_touch_v2, uint32_t pointer)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für multi_touch_v2_write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int multi_touch_v2_write_firmware(MultiTouchV2 *multi_touch_v2, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von multi_touch_v2_set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int multi_touch_v2_write_uid(MultiTouchV2 *multi_touch_v2, uint32_t uid)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int multi_touch_v2_read_uid(MultiTouchV2 *multi_touch_v2, uint32_t *ret_uid)¶

Parameter:	multi_touch_v2 – Typ: MultiTouchV2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

MULTI_TOUCH_V2_DEVICE_IDENTIFIER¶

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

Die multi_touch_v2_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_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Multi Touch Bricklet 2.0 dar.