Dies ist die Beschreibung der Mathematica API Bindings für das Analog Out Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Analog Out Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Mathematica API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Analog Out Bricklet*)
(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
ao=NETNew["Tinkerforge.BrickletAnalogOut",uid,ipcon]
ipcon@Connect[host,port]
(*Set output voltage to 3.3V*)
ao@SetVoltage[3300]
(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[ao]
ReleaseNETObject[ipcon]
|
Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt
eine Tinkerforge.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.
Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out
Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.
Weitere Informationen über das out
Schlüsselwort in .NET/Link sind in der
entsprechende Mathematica .NET/Link Dokumentation
zu finden.
Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist
Tinkerforge.*
.
BrickletAnalogOut
[uid, ipcon] → analogOut¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
analogOut=NETNew["Tinkerforge.BrickletAnalogOut","YOUR_DEVICE_UID",ipcon]
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.
Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.
BrickletAnalogOut
@
SetVoltage
[voltage] → Null¶Parameter: |
|
---|
Setzt die Spannung. Dieser Funktionsaufruf setzt
den Modus auf 0 (siehe SetMode[]
).
BrickletAnalogOut
@
GetVoltage
[] → voltage¶Rückgabe: |
|
---|
Gibt die Spannung zurück, wie von SetVoltage[]
gesetzt.
BrickletAnalogOut
@
SetMode
[mode] → Null¶Parameter: |
|
---|
Setzt den Modus des Analogwertes. Mögliche Modi:
SetVoltage[]
gesetzt, wird ausgegeben.)Setzten des Modus auf 0 resultiert in einer Ausgabespannung von 0 V. Es kann
über einen Aufruf von SetVoltage[]
direkt auf eine
höhere Ausgabespannung gewechselt werden .
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletAnalogOut
@
GetMode
[] → mode¶Rückgabe: |
|
---|
Gibt den Modus zurück, wie von SetMode[]
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletAnalogOut
@
GetIdentity
[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶Ausgabeparameter: |
|
---|
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.
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.
BrickletAnalogOut
@
GetAPIVersion
[] → {apiVersion1, apiVersion2, apiVersion3}¶Ausgabeparameter: |
|
---|
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.
BrickletAnalogOut
@
GetResponseExpected
[functionId] → responseExpected¶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:
BrickletAnalogOut
@
SetResponseExpected
[functionId, responseExpected] → Null¶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:
BrickletAnalogOut
@
SetResponseExpectedAll
[responseExpected] → Null¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletAnalogOut
`
DEVICEUIDENTIFIER
¶Diese Konstante wird verwendet um ein Analog Out 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.
BrickletAnalogOut
`
DEVICEDISPLAYNAME
¶Diese Konstante stellt den Anzeigenamen eines Analog Out Bricklet dar.