Deutsch
English
Menu
Software / API Bindings / LabVIEW / API Referenz und Beispiele / Bricklets (Abgekündigt) / Distance US Bricklet

LabVIEW - Distance US Bricklet

Dies ist die Beschreibung der LabVIEW API Bindings für das Distance US Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance US 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

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

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

BrickletDistanceUS.GetDistanceValue() → distance
Ausgabe:
  • distance – Typ: Int32, Wertebereich: [0 bis 212 - 1]

Gibt den aktuellen Entfernungswert zurück. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den DistanceCallback Callback zu nutzen und die Periode mit SetDistanceCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

BrickletDistanceUS.SetMovingAverage(average)
Eingabe:
  • average – Typ: Byte, Wertebereich: [0 bis 100], Standardwert: 20

Setzt die Länge eines gleitenden Mittelwerts für den Entfernungswert.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

BrickletDistanceUS.GetMovingAverage() → average
Ausgabe:
  • average – Typ: Byte, Wertebereich: [0 bis 100], Standardwert: 20

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage() gesetzt.

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

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

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

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

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

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

BrickletDistanceUS.SetDistanceCallbackThreshold(option, min, max)
Eingabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: Int32, Wertebereich: [0 bis 212 - 1]
  • max – Typ: Int32, Wertebereich: [0 bis 212 - 1]

Setzt den Schwellwert für den DistanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

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

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

Für option:

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

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

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

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 BrickletDistanceUS.DistanceCallback → sender, distance
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletDistanceUS)
  • distance – Typ: Int32, Wertebereich: [0 bis 212 - 1]

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

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

event BrickletDistanceUS.DistanceReachedCallback → sender, distance
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletDistanceUS)
  • distance – Typ: Int32, Wertebereich: [0 bis 212 - 1]

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

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

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.

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

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

  • BrickletDistanceUS.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
  • BrickletDistanceUS.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
  • BrickletDistanceUS.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDistanceUS.FUNCTION_SET_MOVING_AVERAGE = 10
BrickletDistanceUS.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:

  • BrickletDistanceUS.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
  • BrickletDistanceUS.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
  • BrickletDistanceUS.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDistanceUS.FUNCTION_SET_MOVING_AVERAGE = 10
BrickletDistanceUS.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

BrickletDistanceUS.DEVICE_IDENTIFIER

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

BrickletDistanceUS.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance US Bricklet dar.