LabVIEW - PTC Bricklet

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

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

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

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

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

BrickletPTC.GetTemperature() → temperature
Ausgabe:
  • temperature – Typ: Int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Gibt die Temperatur des verbundenen Sensors zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den TemperatureCallback Callback zu nutzen und die Periode mit SetTemperatureCallbackPeriod() vorzugeben.

BrickletPTC.IsSensorConnected() → connected
Ausgabe:
  • connected – Typ: Boolean

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

BrickletPTC.SetWireMode(mode)
Eingabe:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 2

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

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

Für mode:

  • BrickletPTC.WIRE_MODE_2 = 2
  • BrickletPTC.WIRE_MODE_3 = 3
  • BrickletPTC.WIRE_MODE_4 = 4
BrickletPTC.GetWireMode() → mode
Ausgabe:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 2

Gibt die Leiter-Konfiguration zurück, wie von SetWireMode() gesetzt.

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

Für mode:

  • BrickletPTC.WIRE_MODE_2 = 2
  • BrickletPTC.WIRE_MODE_3 = 3
  • BrickletPTC.WIRE_MODE_4 = 4

Fortgeschrittene Funktionen

BrickletPTC.GetResistance() → resistance
Ausgabe:
  • resistance – Typ: Int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den ResistanceCallback Callback zu nutzen und die Periode mit SetResistanceCallbackPeriod() vorzugeben.

BrickletPTC.SetNoiseRejectionFilter(filter)
Eingabe:
  • filter – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

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

Für filter:

  • BrickletPTC.FILTER_OPTION_50HZ = 0
  • BrickletPTC.FILTER_OPTION_60HZ = 1
BrickletPTC.GetNoiseRejectionFilter() → filter
Ausgabe:
  • filter – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Einstellung des Entstörfilters zurück, wie von SetNoiseRejectionFilter() gesetzt.

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

Für filter:

  • BrickletPTC.FILTER_OPTION_50HZ = 0
  • BrickletPTC.FILTER_OPTION_60HZ = 1
BrickletPTC.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", "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 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.

Konfigurationsfunktionen für Callbacks

BrickletPTC.SetTemperatureCallbackPeriod(period)
Eingabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der TemperatureCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der TemperatureCallback Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

BrickletPTC.GetTemperatureCallbackPeriod() → period
Ausgabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetTemperatureCallbackPeriod() gesetzt.

BrickletPTC.SetResistanceCallbackPeriod(period)
Eingabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ResistanceCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ResistanceCallback Callback wird nur ausgelöst, wenn sich der Widerstand seit der letzten Auslösung geändert hat.

BrickletPTC.GetResistanceCallbackPeriod() → period
Ausgabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetResistanceCallbackPeriod() gesetzt.

BrickletPTC.SetTemperatureCallbackThreshold(option, min, max)
Eingabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: Int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: Int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den TemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = "x"
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletPTC.THRESHOLD_OPTION_GREATER = ">"
BrickletPTC.GetTemperatureCallbackThreshold() → option, min, max
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: Int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: Int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetTemperatureCallbackThreshold() gesetzt.

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

Für option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = "x"
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletPTC.THRESHOLD_OPTION_GREATER = ">"
BrickletPTC.SetResistanceCallbackThreshold(option, min, max)
Eingabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: Int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: Int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den ResistanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = "x"
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletPTC.THRESHOLD_OPTION_GREATER = ">"
BrickletPTC.GetResistanceCallbackThreshold() → option, min, max
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: Int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: Int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetResistanceCallbackThreshold() gesetzt.

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

Für option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = "x"
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletPTC.THRESHOLD_OPTION_GREATER = ">"
BrickletPTC.SetDebouncePeriod(debounce)
Eingabe:
  • debounce – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletPTC.GetDebouncePeriod() → debounce
Ausgabe:
  • debounce – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

BrickletPTC.SetSensorConnectedCallbackConfiguration(enabled)
Eingabe:
  • enabled – Typ: Boolean, Standardwert: F

Wenn dieser Callback aktiviert ist, wird der SensorConnectedCallback Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Neu in Version 2.0.2 (Plugin).

BrickletPTC.GetSensorConnectedCallbackConfiguration() → enabled
Ausgabe:
  • enabled – Typ: Boolean, Standardwert: F

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

Neu in Version 2.0.2 (Plugin).

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten 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.

event BrickletPTC.TemperatureCallback → sender, temperature
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletPTC)
  • temperature – Typ: Int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Dieser Callback wird mit der Periode, wie gesetzt mit SetTemperatureCallbackPeriod(), ausgelöst. Der Parameter ist die Temperatur des verbundenen Sensors.

Der TemperatureCallback Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

event BrickletPTC.TemperatureReachedCallback → sender, temperature
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletPTC)
  • temperature – Typ: Int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Temperatur des verbundenen Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

event BrickletPTC.ResistanceCallback → sender, resistance
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletPTC)
  • resistance – Typ: Int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetResistanceCallbackPeriod(), ausgelöst. Der Parameter ist der Widerstand des verbundenen Sensors.

Der ResistanceCallback Callback wird nur ausgelöst, wenn sich der Widerstand seit der letzten Auslösung geändert hat.

event BrickletPTC.ResistanceReachedCallback → sender, resistance
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletPTC)
  • resistance – Typ: Int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetResistanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Widerstand des verbundenen Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

event BrickletPTC.SensorConnectedCallback → sender, connected
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletPTC)
  • connected – Typ: Boolean

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetSensorConnectedCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie bei IsSensorConnected().

Neu in Version 2.0.2 (Plugin).

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.

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

BrickletPTC.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:

  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
  • BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
BrickletPTC.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:

  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
  • BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
BrickletPTC.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

BrickletPTC.DEVICE_IDENTIFIER

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

BrickletPTC.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.