Dies ist die Beschreibung der LabVIEW API Bindings für das Industrial Dual 0-20mA Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die LabVIEW API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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.*
.
BrickletIndustrialDual020mAV2
(uid, ipcon) → industrialDual020mAV2¶Eingabe: |
|
---|---|
Ausgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
.
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletIndustrialDual020mAV2.
GetCurrent
(channel) → current¶Eingabe: |
|
---|---|
Ausgabe: |
|
Gibt die gemessenen Stromstärke des spezifizierten Kanals zurück.
Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.
Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.
Wenn der Wert periodisch benötigt wird, kann auch der CurrentCallback
Callback
verwendet werden. Der Callback wird mit der Funktion
SetCurrentCallbackConfiguration()
konfiguriert.
BrickletIndustrialDual020mAV2.
SetChannelLEDConfig
(channel, config)¶Eingabe: |
|
---|
Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.
Das Verhalten des Kanalstatus kann mittels SetChannelLEDStatusConfig()
eingestellt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletIndustrialDual020mAV2.
GetChannelLEDConfig
(channel) → config¶Eingabe: |
|
---|---|
Ausgabe: |
|
Gibt die Kanal-LED-Konfiguration zurück, wie von SetChannelLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletIndustrialDual020mAV2.
SetChannelLEDStatusConfig
(channel, min, max, config)¶Eingabe: |
|
---|
Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn
die Kanal-LED auf Kanalstatus eingestellt ist, siehe SetChannelLEDConfig()
.
Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.
Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom über 10mA steigt und wieder ausgeschaltet sobald der Strom unter 10mA fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom unter 10mA fällt und wieder ausgeschaltet sobald der Strom über 10mA steigt.
Im Intensitätsmodus kann ein Bereich in nA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4mA und max=20mA: Die LED ist bei 4mA und darunter aus, bei 20mA und darüber an und zwischen 4mA und 20mA wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletIndustrialDual020mAV2.
GetChannelLEDStatusConfig
(channel) → min, max, config¶Eingabe: |
|
---|---|
Ausgabe: |
|
Gibt die Kanal-LED-Status-Konfiguration zurück, wie von
SetChannelLEDStatusConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletIndustrialDual020mAV2.
SetSampleRate
(rate)¶Eingabe: |
|
---|
Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.
Wert | Beschreibung |
---|---|
0 | 240 Samples pro Sekunde, 12 Bit Auflösung |
1 | 60 Samples pro Sekunde, 14 Bit Auflösung |
2 | 15 Samples pro Sekunde, 16 Bit Auflösung |
3 | 4 Samples pro Sekunde, 18 Bit Auflösung |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
BrickletIndustrialDual020mAV2.
GetSampleRate
() → rate¶Ausgabe: |
|
---|
Gibt die Abtastrate zurück, wie von SetSampleRate()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für rate:
BrickletIndustrialDual020mAV2.
SetGain
(gain)¶Eingabe: |
|
---|
Setzt die Verstärkung zwischen 1x und 8x. Wenn ein sehr kleiner Strom gemessen werden soll, dann kann die Verstärkung hochgesetzt werden, um die Auflösung zu verbessern.
Beispiel: Wenn 0,5mA gemessen werden mit einer Verstärkung von 8x dann wird 4mA zurückgegeben.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
BrickletIndustrialDual020mAV2.
GetGain
() → gain¶Ausgabe: |
|
---|
Gibt die Verstärkung zurück, wie von SetGain()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
BrickletIndustrialDual020mAV2.
GetSPITFPErrorCount
() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow¶Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletIndustrialDual020mAV2.
SetStatusLEDConfig
(config)¶Eingabe: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletIndustrialDual020mAV2.
GetStatusLEDConfig
() → config¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletIndustrialDual020mAV2.
GetChipTemperature
() → temperature¶Ausgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletIndustrialDual020mAV2.
Reset
()¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
BrickletIndustrialDual020mAV2.
GetIdentity
() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶Ausgabe: |
|
---|
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.
BrickletIndustrialDual020mAV2.
SetCurrentCallbackConfiguration
(channel, period, valueHasToChange, option, min, max)¶Eingabe: |
|
---|
Die Periode ist die Periode mit der der CurrentCallback
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den CurrentCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletIndustrialDual020mAV2.
GetCurrentCallbackConfiguration
(channel) → period, valueHasToChange, option, min, max¶Eingabe: |
|
---|---|
Ausgabe: |
|
Gibt die Callback-Konfiguration zurück, wie mittels SetCurrentCallbackConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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.
BrickletIndustrialDual020mAV2.
CurrentCallback
→ sender, channel, current¶Callback-Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
SetCurrentCallbackConfiguration()
gesetzten Konfiguration
Der Parameter ist der gleiche wie GetCurrent()
.
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.
BrickletIndustrialDual020mAV2.
GetAPIVersion
() → apiVersion¶Ausgabe: |
|
---|
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.
BrickletIndustrialDual020mAV2.
GetResponseExpected
(functionId) → responseExpected¶Eingabe: |
|
---|---|
Ausgabe: |
|
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:
BrickletIndustrialDual020mAV2.
SetResponseExpected
(functionId, responseExpected)¶Eingabe: |
|
---|
Ä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:
BrickletIndustrialDual020mAV2.
SetResponseExpectedAll
(responseExpected)¶Eingabe: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
BrickletIndustrialDual020mAV2.
SetBootloaderMode
(mode) → status¶Eingabe: |
|
---|---|
Ausgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletIndustrialDual020mAV2.
GetBootloaderMode
() → mode¶Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletIndustrialDual020mAV2.
SetWriteFirmwarePointer
(pointer)¶Eingabe: |
|
---|
Setzt den Firmware-Pointer für WriteFirmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletIndustrialDual020mAV2.
WriteFirmware
(data) → status¶Eingabe: |
|
---|---|
Ausgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
SetWriteFirmwarePointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletIndustrialDual020mAV2.
WriteUID
(uid)¶Eingabe: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
BrickletIndustrialDual020mAV2.
ReadUID
() → uid¶Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletIndustrialDual020mAV2.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Industrial Dual 0-20mA Bricklet 2.0 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.
BrickletIndustrialDual020mAV2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet 2.0 dar.