Mathematica - Industrial Analog Out Bricklet

Dies ist die Beschreibung der Mathematica API Bindings für das Industrial Analog Out Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Analog Out Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Mathematica API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple Current

Download (ExampleSimpleCurrent.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Industrial Analog Out Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
iao=NETNew["Tinkerforge.BrickletIndustrialAnalogOut",uid,ipcon]
ipcon@Connect[host,port]

(*Set output current to 4.5mA*)
iao@SetCurrent[4500]
iao@Enable[]

Input["Click OK to exit"]

(*Clean up*)
iao@Disable[]
ipcon@Disconnect[]
ReleaseNETObject[iao]
ReleaseNETObject[ipcon]

Simple Voltage

Download (ExampleSimpleVoltage.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Industrial Analog Out Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
iao=NETNew["Tinkerforge.BrickletIndustrialAnalogOut",uid,ipcon]
ipcon@Connect[host,port]

(*Set output voltage to 3.3V*)
iao@SetVoltage[3300]
iao@Enable[]

Input["Click OK to exit"]

(*Clean up*)
iao@Disable[]
ipcon@Disconnect[]
ReleaseNETObject[iao]
ReleaseNETObject[ipcon]

API

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

Grundfunktionen

BrickletIndustrialAnalogOut[uid, ipcon] → industrialAnalogOut
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • industrialAnalogOut -- NETObject[BrickletIndustrialAnalogOut]

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

industrialAnalogOut=NETNew["Tinkerforge.BrickletIndustrialAnalogOut","YOUR_DEVICE_UID",ipcon]

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

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.

BrickletIndustrialAnalogOut@Enable[] → Null

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

BrickletIndustrialAnalogOut@Disable[] → Null

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

BrickletIndustrialAnalogOut@IsEnabled[] → enabled
Rückgabe:
  • enabled -- True/False

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

BrickletIndustrialAnalogOut@SetVoltage[voltage] → Null
Parameter:
  • voltage -- Integer

Setzt die Ausgangsspannung in mV.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

BrickletIndustrialAnalogOut@GetVoltage[] → voltage
Rückgabe:
  • voltage -- Integer

Gibt die Spannung zurück, wie von SetVoltage[] gesetzt.

BrickletIndustrialAnalogOut@SetCurrent[current] → Null
Parameter:
  • current -- Integer

Setzt den Ausgangsstrom in µA.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

BrickletIndustrialAnalogOut@GetCurrent[] → current
Rückgabe:
  • current -- Integer

Gibt die Spannung zurück, wie von SetCurrent[] gesetzt.

Fortgeschrittene Funktionen

BrickletIndustrialAnalogOut@SetConfiguration[voltageRange, currentRange] → Null
Parameter:
  • voltageRange -- Integer
  • currentRange -- Integer

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V (Standard)

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA (Standard)
  • 0mA bis 20mA
  • 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

  • BrickletIndustrialAnalogOut`VOLTAGEURANGEU0UTOU5V = 0
  • BrickletIndustrialAnalogOut`VOLTAGEURANGEU0UTOU10V = 1
  • BrickletIndustrialAnalogOut`CURRENTURANGEU4UTOU20MA = 0
  • BrickletIndustrialAnalogOut`CURRENTURANGEU0UTOU20MA = 1
  • BrickletIndustrialAnalogOut`CURRENTURANGEU0UTOU24MA = 2
BrickletIndustrialAnalogOut@GetConfiguration[out voltageRange, out currentRange] → Null
Parameter:
  • voltageRange -- Integer
  • currentRange -- Integer

Gibt die Konfiguration zurück, wie von SetConfiguration[] gesetzt.

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

  • BrickletIndustrialAnalogOut`VOLTAGEURANGEU0UTOU5V = 0
  • BrickletIndustrialAnalogOut`VOLTAGEURANGEU0UTOU10V = 1
  • BrickletIndustrialAnalogOut`CURRENTURANGEU4UTOU20MA = 0
  • BrickletIndustrialAnalogOut`CURRENTURANGEU0UTOU20MA = 1
  • BrickletIndustrialAnalogOut`CURRENTURANGEU0UTOU24MA = 2
BrickletIndustrialAnalogOut@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

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.

BrickletIndustrialAnalogOut@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- True/False

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:

  • BrickletIndustrialAnalogOut`FUNCTIONUENABLE = 1
  • BrickletIndustrialAnalogOut`FUNCTIONUDISABLE = 2
  • BrickletIndustrialAnalogOut`FUNCTIONUSETUVOLTAGE = 4
  • BrickletIndustrialAnalogOut`FUNCTIONUSETUCURRENT = 6
  • BrickletIndustrialAnalogOut`FUNCTIONUSETUCONFIGURATION = 8
BrickletIndustrialAnalogOut@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- True/False

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

  • BrickletIndustrialAnalogOut`FUNCTIONUENABLE = 1
  • BrickletIndustrialAnalogOut`FUNCTIONUDISABLE = 2
  • BrickletIndustrialAnalogOut`FUNCTIONUSETUVOLTAGE = 4
  • BrickletIndustrialAnalogOut`FUNCTIONUSETUCURRENT = 6
  • BrickletIndustrialAnalogOut`FUNCTIONUSETUCONFIGURATION = 8
BrickletIndustrialAnalogOut@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

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

BrickletIndustrialAnalogOut@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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.

Konstanten

BrickletIndustrialAnalogOut`DEVICEUIDENTIFIER

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

BrickletIndustrialAnalogOut`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet dar.