MATLAB/Octave - Dual Button Bricklet¶

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

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletDualButton;

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

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

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

    % Register state changed callback to function cb_state_changed
    set(db, 'StateChangedCallback', @(h, e) cb_state_changed(e));

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

% Callback function for state changed callback
function cb_state_changed(e)
    if e.buttonL == com.tinkerforge.BrickletDualButton.BUTTON_STATE_PRESSED
        fprintf('Left Button: Pressed\n');
    elseif e.buttonL == com.tinkerforge.BrickletDualButton.BUTTON_STATE_RELEASED
        fprintf('Left Button: Released\n');
    end

    if e.buttonR == com.tinkerforge.BrickletDualButton.BUTTON_STATE_PRESSED
        fprintf('Right Button: Pressed\n');
    elseif e.buttonR == com.tinkerforge.BrickletDualButton.BUTTON_STATE_RELEASED
        fprintf('Right Button: Released\n');
    end

    fprintf('\n');
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
44

function octave_example_callback()
    more off;

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

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

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

    % Register state changed callback to function cb_state_changed
    db.addStateChangedCallback(@cb_state_changed);

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

% Callback function for state changed callback
function cb_state_changed(e)
    if java2int(e.buttonL) == 0
        fprintf("Left Button: Pressed\n");
    elseif java2int(e.buttonL) == 1
        fprintf("Left Button: Released\n");
    end

    if java2int(e.buttonR) == 0
        fprintf("Right Button: Pressed\n");
    elseif java2int(e.buttonR) == 1
        fprintf("Right Button: Released\n");
    end

    fprintf("\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Grundfunktionen¶

class BrickletDualButton(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	dualButton – Typ: BrickletDualButton

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

In MATLAB:

import com.tinkerforge.BrickletDualButton;

dualButton = BrickletDualButton("YOUR_DEVICE_UID", ipcon);

In Octave:

dualButton = java_new("com.tinkerforge.BrickletDualButton", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

void BrickletDualButton.setLEDState(short ledL, short ledR)¶

Parameter:	ledL – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1 ledR – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

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 getLEDState() ausgelesen werden oder es kann setSelectedLEDState() genutzt werden.

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

Für ledL:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.LEDState BrickletDualButton.getLEDState()¶

Rückgabeobjekt:	ledL – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1 ledR – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

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

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

Für ledL:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.ButtonState BrickletDualButton.getButtonState()¶

Rückgabeobjekt:	buttonL – Typ: short, Wertebereich: Siehe Konstanten buttonR – Typ: short, Wertebereich: Siehe Konstanten

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:

Für buttonL:

• BrickletDualButton.BUTTON_STATE_PRESSED = 0
• BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für buttonR:

• BrickletDualButton.BUTTON_STATE_PRESSED = 0
• BrickletDualButton.BUTTON_STATE_RELEASED = 1

Fortgeschrittene Funktionen¶

void BrickletDualButton.setSelectedLEDState(short led, short state)¶

Parameter:	led – Typ: short, Wertebereich: Siehe Konstanten state – Typ: short, Wertebereich: Siehe Konstanten

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

Die andere LED bleibt unangetastet.

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

Für led:

• BrickletDualButton.LED_LEFT = 0
• BrickletDualButton.LED_RIGHT = 1

Für state:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.Identity BrickletDualButton.getIdentity()¶

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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.

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.

callback BrickletDualButton.StateChangedCallback¶

Event-Objekt:	buttonL – Typ: short, Wertebereich: Siehe Konstanten buttonR – Typ: short, Wertebereich: Siehe Konstanten ledL – Typ: short, Wertebereich: Siehe Konstanten ledR – Typ: short, Wertebereich: Siehe Konstanten

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:

Für buttonL:

• BrickletDualButton.BUTTON_STATE_PRESSED = 0
• BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für buttonR:

• BrickletDualButton.BUTTON_STATE_PRESSED = 0
• BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für ledL:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

Für ledR:

• BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
• BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
• BrickletDualButton.LED_STATE_ON = 2
• BrickletDualButton.LED_STATE_OFF = 3

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

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

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.

short[] BrickletDualButton.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255]

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.

boolean BrickletDualButton.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: boolean

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:

Für functionId:

• BrickletDualButton.FUNCTION_SET_LED_STATE = 1
• BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

void BrickletDualButton.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

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

• BrickletDualButton.FUNCTION_SET_LED_STATE = 1
• BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

void BrickletDualButton.setResponseExpectedAll(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

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

Konstanten¶

int BrickletDualButton.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Dual Button 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.

String BrickletDualButton.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.