Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Rotary Poti Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Rotary Poti Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | function matlab_example_simple()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRotaryPoti;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Rotary Poti Bricklet
ipcon = IPConnection(); % Create IP connection
rp = handle(BrickletRotaryPoti(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current position
position = rp.getPosition();
fprintf('Position: %i\n', position); % Range: -150 to 150
input('Press key to exit\n', 's');
ipcon.disconnect();
end
|
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 | function matlab_example_callback()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRotaryPoti;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Rotary Poti Bricklet
ipcon = IPConnection(); % Create IP connection
rp = handle(BrickletRotaryPoti(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register position callback to function cb_position
set(rp, 'PositionCallback', @(h, e) cb_position(e));
% Set period for position callback to 0.05s (50ms)
% Note: The position callback is only called every 0.05 seconds
% if the position has changed since the last call!
rp.setPositionCallbackPeriod(50);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for position callback
function cb_position(e)
fprintf('Position: %i\n', e.position); % Range: -150 to 150
end
|
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 | function octave_example_simple()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Rotary Poti Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
rp = javaObject("com.tinkerforge.BrickletRotaryPoti", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current position
position = rp.getPosition();
fprintf("Position: %d\n", java2int(position)); % Range: -150 to 150
input("Press key to exit\n", "s");
ipcon.disconnect();
end
function int = java2int(value)
if compare_versions(version(), "3.8", "<=")
int = value.intValue();
else
int = value;
end
end
|
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 | function octave_example_callback()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Rotary Poti Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
rp = javaObject("com.tinkerforge.BrickletRotaryPoti", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register position callback to function cb_position
rp.addPositionCallback(@cb_position);
% Set period for position callback to 0.05s (50ms)
% Note: The position callback is only called every 0.05 seconds
% if the position has changed since the last call!
rp.setPositionCallbackPeriod(50);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for position callback
function cb_position(e)
fprintf("Position: %d\n", java2int(e.position)); % Range: -150 to 150
end
function int = java2int(value)
if compare_versions(version(), "3.8", "<=")
int = value.intValue();
else
int = value;
end
end
|
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.
BrickletRotaryPoti
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
.
In MATLAB:
import com.tinkerforge.BrickletRotaryPoti;
rotaryPoti = BrickletRotaryPoti("YOUR_DEVICE_UID", ipcon);
In Octave:
rotaryPoti = java_new("com.tinkerforge.BrickletRotaryPoti", "YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletRotaryPoti.
getPosition
()¶Rückgabe: |
|
---|
Gibt die Position des Drehpotentiometers zurück. Der Wertebereich ist von -150° (links gedreht) und 150° (rechts gedreht).
Wenn die Position periodisch abgefragt werden soll, wird empfohlen
den PositionCallback
Callback zu nutzen und die Periode mit
setPositionCallbackPeriod()
vorzugeben.
BrickletRotaryPoti.
getAnalogValue
()¶Rückgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von getPosition()
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen
den AnalogValueCallback
Callback zu nutzen und die Periode mit
setAnalogValueCallbackPeriod()
vorzugeben.
BrickletRotaryPoti.
getIdentity
()¶Rückgabeobjekt: |
|
---|
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.
BrickletRotaryPoti.
setPositionCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der PositionCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der PositionCallback
Callback wird nur ausgelöst, wenn sich die Position seit der
letzten Auslösung geändert hat.
BrickletRotaryPoti.
getPositionCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setPositionCallbackPeriod()
gesetzt.
BrickletRotaryPoti.
setAnalogValueCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AnalogValueCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
BrickletRotaryPoti.
getAnalogValueCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAnalogValueCallbackPeriod()
gesetzt.
BrickletRotaryPoti.
setPositionCallbackThreshold
(char option, short min, short max)¶Parameter: |
|
---|
Setzt den Schwellwert für den PositionReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Position außerhalb der min und max Werte ist |
'i' | Callback wird ausgelöst, wenn die Position innerhalb der min und max Werte ist |
'<' | Callback wird ausgelöst, wenn die Position kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Position größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletRotaryPoti.
getPositionCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setPositionCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletRotaryPoti.
setAnalogValueCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den AnalogValueReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Analogwert außerhalb der min und max Werte ist |
'i' | Callback wird ausgelöst, wenn der Analogwert innerhalb der min und max Werte ist |
'<' | Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletRotaryPoti.
getAnalogValueCallbackThreshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von setAnalogValueCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletRotaryPoti.
setDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletRotaryPoti.
getDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von setDebouncePeriod()
gesetzt.
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.
BrickletRotaryPoti.
PositionCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setPositionCallbackPeriod()
, ausgelöst. Der Parameter ist die
Position des Drehpotentiometers.
Der PositionCallback
Callback wird nur ausgelöst, wenn sich die Position seit der
letzten Auslösung geändert hat.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addPositionCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removePositionCallback()
wieder entfernt werden.
BrickletRotaryPoti.
AnalogValueCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setAnalogValueCallbackPeriod()
, ausgelöst. Der Parameter
ist der Analogwert des Drehpotentiometers.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addAnalogValueCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeAnalogValueCallback()
wieder entfernt werden.
BrickletRotaryPoti.
PositionReachedCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
setPositionCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Position des Drehpotentiometers.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addPositionReachedCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removePositionReachedCallback()
wieder entfernt werden.
BrickletRotaryPoti.
AnalogValueReachedCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
setAnalogValueCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist der Analogwert des Drehpotentiometers.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addAnalogValueReachedCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeAnalogValueReachedCallback()
wieder entfernt werden.
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.
BrickletRotaryPoti.
getAPIVersion
()¶Rückgabeobjekt: |
|
---|
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.
BrickletRotaryPoti.
getResponseExpected
(byte functionId)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletRotaryPoti.
setResponseExpected
(byte functionId, boolean responseExpected)¶Parameter: |
|
---|
Ä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:
BrickletRotaryPoti.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletRotaryPoti.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Rotary Poti 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.
BrickletRotaryPoti.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Rotary Poti Bricklet dar.