MATLAB/Octave - Multi Touch Bricklet

Dies ist die Beschreibung der MATLAB/Octave 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 MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

Download (matlab_example_simple.m)

 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
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletMultiTouch;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Multi Touch Bricklet

    ipcon = IPConnection(); % Create IP connection
    mt = handle(BrickletMultiTouch(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current touch state
    state = mt.getTouchState();
    s = '';

    if bitand(state, bitshift(1, 12))
        s = strcat(s, 'In proximity, ');
    end

    if (bitand(state, hex2dec('FFF'))) == 0
        s = strcat(s, 'No electrodes touched');
    else
        s = strcat(s, 'Electrodes ');
        for i = 0:11
            if bitand(state, bitshift(1, i))
                s = strcat(s, num2str(i));
                s = strcat(s, ' ');
            end
        end
        s = strcat(s, 'touched');
    end

    disp(s);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletMultiTouch;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Multi Touch Bricklet

    ipcon = IPConnection(); % Create IP connection
    mt = handle(BrickletMultiTouch(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register touch state callback to function cb_touch_state
    set(mt, 'TouchStateCallback', @(h, e) cb_touch_state(e));

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for touch state callback
function cb_touch_state(e)
    s = '';

    if bitand(e.state, bitshift(1, 12))
        s = strcat(s, 'In proximity, ');
    end

    if (bitand(e.state, hex2dec('FFF'))) == 0
        s = strcat(s, 'No electrodes touched');
    else
        s = strcat(s, 'Electrodes ');
        for i = 0:11
            if bitand(e.state, bitshift(1, i))
                s = strcat(s, num2str(i));
                s = strcat(s, ' ');
            end
        end
        s = strcat(s, 'touched');
    end

    disp(s);
end

Simple (Octave)

Download (octave_example_simple.m)

 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
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Multi Touch Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    mt = javaObject("com.tinkerforge.BrickletMultiTouch", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current touch state
    state = mt.getTouchState();
    s = "";

    if bitand(state, bitshift(1, 12))
        s = strcat(s, "In proximity, ");
    end

    if (bitand(state, hex2dec("FFF"))) == 0
        s = strcat(s, "No electrodes touched");
    else
        s = strcat(s, "Electrodes ");
        for i = 0:11
            if bitand(state, bitshift(1, i))
                s = strcat(s, num2str(i));
                s = strcat(s, " ");
            end
        end
        s = strcat(s, "touched");
    end

    disp(s);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)

Download (octave_example_callback.m)

 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
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Multi Touch Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    mt = javaObject("com.tinkerforge.BrickletMultiTouch", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register touch state callback to function cb_touch_state
    mt.addTouchStateCallback(@cb_touch_state);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for touch state callback
function cb_touch_state(e)
    s = "";

    if bitand(e.state, bitshift(1, 12))
        s = strcat(s, "In proximity, ");
    end

    if (bitand(e.state, hex2dec("FFF"))) == 0
        s = strcat(s, "No electrodes touched");
    else
        s = strcat(s, "Electrodes ");
        for i = 0:11
            if bitand(e.state, bitshift(1, i))
                s = strcat(s, num2str(i));
                s = strcat(s, " ");
            end
        end
        s = strcat(s, "touched");
    end

    disp(s);
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletMultiTouch(String uid, IPConnection ipcon)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.

In MATLAB:

import com.tinkerforge.BrickletMultiTouch;

multiTouch = BrickletMultiTouch("YOUR_DEVICE_UID", ipcon);

In Octave:

multiTouch = java_new("com.tinkerforge.BrickletMultiTouch", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

int BrickletMultiTouch.getTouchState()

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.

void BrickletMultiTouch.recalibrate()

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

void BrickletMultiTouch.setElectrodeConfig(int enabledElectrodes)

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

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 TouchStateCallback Callback ausgelöst wird.

Eine deaktivierte Elektrode verringert zusätzlich den Stromverbrauch.

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

int BrickletMultiTouch.getElectrodeConfig()

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

void BrickletMultiTouch.setElectrodeSensitivity(short sensitivity)

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

short BrickletMultiTouch.getElectrodeSensitivity()

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

Fortgeschrittene Funktionen

short[] BrickletMultiTouch.getAPIVersion()

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.

boolean BrickletMultiTouch.getResponseExpected(short functionId)

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 setResponseExpected(). 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:

  • BrickletMultiTouch.FUNCTION_RECALIBRATE = 2
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_CONFIG = 3
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_SENSITIVITY = 6
void BrickletMultiTouch.setResponseExpected(short functionId, boolean responseExpected)

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

  • BrickletMultiTouch.FUNCTION_RECALIBRATE = 2
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_CONFIG = 3
  • BrickletMultiTouch.FUNCTION_SET_ELECTRODE_SENSITIVITY = 6
void BrickletMultiTouch.setResponseExpectedAll(boolean responseExpected)

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

BrickletMultiTouch.Identity BrickletMultiTouch.getIdentity()

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletMultiTouch.TouchStateCallback
Parameter:state -- int

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

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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addTouchStateCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeTouchStateCallback() wieder entfernt werden.

Konstanten

static final int BrickletMultiTouch.DEVICE_IDENTIFIER

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

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

static final String BrickletMultiTouch.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Multi Touch Bricklet dar.