LabVIEW - Industrial Analog Out Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

API

Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt eine Tinkerforge.TimeoutException melden. Dieser Fehler wird gemeldet 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.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletIndustrialAnalogOut(uid, ipcon) → industrialAnalogOut
Eingabe:
  • uid – Typ: String
  • ipcon – Typ: .NET Refnum (IPConnection)
Ausgabe:
  • industrialAnalogOut – Typ: .NET Refnum (BrickletIndustrialAnalogOut)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletIndustrialAnalogOut.Enable()

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

BrickletIndustrialAnalogOut.Disable()

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

BrickletIndustrialAnalogOut.IsEnabled() → enabled
Ausgabe:
  • enabled – Typ: Boolean, Standardwert: F

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

BrickletIndustrialAnalogOut.SetVoltage(voltage)
Eingabe:
  • voltage – Typ: Int32, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Setzt die Ausgangsspannung.

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

BrickletIndustrialAnalogOut.GetVoltage() → voltage
Ausgabe:
  • voltage – Typ: Int32, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Gibt die Spannung zurück, wie von SetVoltage() gesetzt.

BrickletIndustrialAnalogOut.SetCurrent(current)
Eingabe:
  • current – Typ: Int32, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Setzt den Ausgangsstrom.

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

BrickletIndustrialAnalogOut.GetCurrent() → current
Ausgabe:
  • current – Typ: Int32, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Gibt die Spannung zurück, wie von SetCurrent() gesetzt.

Fortgeschrittene Funktionen

BrickletIndustrialAnalogOut.SetConfiguration(voltageRange, currentRange)
Eingabe:
  • voltageRange – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1
  • currentRange – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA
  • 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:

Für voltageRange:

  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

Für currentRange:

  • BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2
BrickletIndustrialAnalogOut.GetConfiguration() → voltageRange, currentRange
Ausgabe:
  • voltageRange – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1
  • currentRange – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von SetConfiguration() gesetzt.

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

Für voltageRange:

  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

Für currentRange:

  • BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2
BrickletIndustrialAnalogOut.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardwareVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Int32, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

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.

BrickletIndustrialAnalogOut.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, 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.

BrickletIndustrialAnalogOut.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:
  • 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:

  • BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
  • BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
  • BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8
BrickletIndustrialAnalogOut.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • 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:

  • BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
  • BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
  • BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8
BrickletIndustrialAnalogOut.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected – Typ: Boolean

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

Konstanten

BrickletIndustrialAnalogOut.DEVICE_IDENTIFIER

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

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