LabVIEW - UV Light Bricklet 2.0

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

BrickletUVLightV2(uid, ipcon) → uvLightV2
Eingabe:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Ausgabe:
  • uvLightV2 -- .NET Refnum (BrickletUVLightV2)

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

BrickletUVLightV2.GetUVA() → uva
Ausgabe:
  • uva -- Int32

Gibt die UVA Intensität des Sensors zurück. Die Intensität wird in der Einheit 1/10 mW/m² gegeben. Der Sensor hat die Intensität nicht mit dem Erythem-Wirkungsspektrum gewichtet, daher handelt es sich nicht um die hautbeeinflussende Bestrahlungsstärke. Der Wert kann nicht einfach durch 250 geteilt werden, um den UVA Index zu bestimmen. Um den UV Index zu bestimmen kann GetUVI() verwendet werden.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe SetConfiguration().

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den UVACallback Callback zu nutzen und die Periode mit SetUVACallbackConfiguration() vorzugeben.

Wenn der Wert periodisch benötigt wird, kann auch der UVACallback Callback verwendet werden. Der Callback wird mit der Funktion SetUVACallbackConfiguration() konfiguriert.

BrickletUVLightV2.GetUVB() → uvb
Ausgabe:
  • uvb -- Int32

Gibt die UVB Intensität des Sensors zurück. Die Intensität wird in der Einheit 1/10 mW/m² gegeben. Der Sensor hat die Intensität nicht mit dem Erythem-Wirkungsspektrum gewichtet, daher handelt es sich nicht um die hautbeeinflussende Bestrahlungsstärke. Der Wert kann nicht einfach durch 250 geteilt werde, um den UVB Index zu bestimmen. Um den UV Index zu bestimmen kann GetUVI() verwendet werden.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe SetConfiguration().

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den UVBCallback Callback zu nutzen und die Periode mit SetUVBCallbackConfiguration() vorzugeben.

Wenn der Wert periodisch benötigt wird, kann auch der UVBCallback Callback verwendet werden. Der Callback wird mit der Funktion SetUVBCallbackConfiguration() konfiguriert.

BrickletUVLightV2.GetUVI() → uvi
Ausgabe:
  • uvi -- Int32

Gibt den UV Index des Sensors in 1/10 zurück.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe SetConfiguration().

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den UVICallback Callback zu nutzen und die Periode mit SetUVICallbackConfiguration() vorzugeben.

Wenn der Wert periodisch benötigt wird, kann auch der UVICallback Callback verwendet werden. Der Callback wird mit der Funktion SetUVICallbackConfiguration() konfiguriert.

Fortgeschrittene Funktionen

BrickletUVLightV2.SetConfiguration(integrationTime)
Eingabe:
  • integrationTime -- Byte

Setzt die Konfiguration des Sensors. Die Integrationszeit kann zwischen 50 und 800 ms eingestellt werden. Mit einer kürzeren Integrationszeit wird der Sensorwert öfter aktualisiert, beinhaltet aber mehr Rauschen. Mit einer längeren Integrationszeit wird das Rauschen verringert aber der Sensorwert wird nicht so oft aktualisiert.

Mit einer längeren Integrationszeit (ins besondere 800 ms) und einer höheren UV Intensität kann der Sensor gesättigt (saturated) sein. Falls dies auftritt dann sind die UVA/UVB/UVI Messwerte alle -1. In diesem Fall muss eine kürzere Integrationszeit gewählt werden.

Standardwert: 400 ms.

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

  • BrickletUVLightV2.INTEGRATION_TIME_50MS = 0
  • BrickletUVLightV2.INTEGRATION_TIME_100MS = 1
  • BrickletUVLightV2.INTEGRATION_TIME_200MS = 2
  • BrickletUVLightV2.INTEGRATION_TIME_400MS = 3
  • BrickletUVLightV2.INTEGRATION_TIME_800MS = 4
BrickletUVLightV2.GetConfiguration() → integrationTime
Ausgabe:
  • integrationTime -- Byte

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

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

  • BrickletUVLightV2.INTEGRATION_TIME_50MS = 0
  • BrickletUVLightV2.INTEGRATION_TIME_100MS = 1
  • BrickletUVLightV2.INTEGRATION_TIME_200MS = 2
  • BrickletUVLightV2.INTEGRATION_TIME_400MS = 3
  • BrickletUVLightV2.INTEGRATION_TIME_800MS = 4
BrickletUVLightV2.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion -- Byte[3]

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.

BrickletUVLightV2.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId -- Byte
Ausgabe:
  • responseExpected -- 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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletUVLightV2.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId -- Byte
  • responseExpected -- 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletUVLightV2.FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
  • BrickletUVLightV2.FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
  • BrickletUVLightV2.FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
  • BrickletUVLightV2.FUNCTION_SET_CONFIGURATION = 13
  • BrickletUVLightV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletUVLightV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletUVLightV2.FUNCTION_RESET = 243
  • BrickletUVLightV2.FUNCTION_WRITE_UID = 248
BrickletUVLightV2.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected -- Boolean

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

BrickletUVLightV2.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Ausgabe:
  • errorCountAckChecksum -- Int64
  • errorCountMessageChecksum -- Int64
  • errorCountFrame -- Int64
  • errorCountOverflow -- Int64

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.

BrickletUVLightV2.SetBootloaderMode(mode) → status
Eingabe:
  • mode -- Byte
Ausgabe:
  • status -- Byte

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

  • BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletUVLightV2.BOOTLOADER_STATUS_OK = 0
  • BrickletUVLightV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletUVLightV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletUVLightV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletUVLightV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletUVLightV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletUVLightV2.GetBootloaderMode() → mode
Ausgabe:
  • mode -- Byte

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

  • BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletUVLightV2.SetWriteFirmwarePointer(pointer)
Eingabe:
  • pointer -- Int64

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.

BrickletUVLightV2.WriteFirmware(data) → status
Eingabe:
  • data -- Byte[64]
Ausgabe:
  • status -- Byte

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.

BrickletUVLightV2.SetStatusLEDConfig(config)
Eingabe:
  • config -- Byte

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:

  • BrickletUVLightV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletUVLightV2.STATUS_LED_CONFIG_ON = 1
  • BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletUVLightV2.GetStatusLEDConfig() → config
Ausgabe:
  • config -- Byte

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

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

  • BrickletUVLightV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletUVLightV2.STATUS_LED_CONFIG_ON = 1
  • BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletUVLightV2.GetChipTemperature() → temperature
Ausgabe:
  • temperature -- Int16

Gibt die Temperatur in °C, 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.

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

BrickletUVLightV2.WriteUID(uid)
Eingabe:
  • uid -- Int64

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.

BrickletUVLightV2.ReadUID() → uid
Ausgabe:
  • uid -- Int64

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletUVLightV2.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

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.

Konfigurationsfunktionen für Callbacks

BrickletUVLightV2.SetUVACallbackConfiguration(period, valueHasToChange, option, min, max)
Eingabe:
  • period -- Int64
  • valueHasToChange -- Boolean
  • option -- Char
  • min -- Int32
  • max -- Int32

Die Periode in ms ist die Periode mit der der UVACallback 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 UVACallback 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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
BrickletUVLightV2.GetUVACallbackConfiguration() → period, valueHasToChange, option, min, max
Ausgabe:
  • period -- Int64
  • valueHasToChange -- Boolean
  • option -- Char
  • min -- Int32
  • max -- Int32

Gibt die Callback-Konfiguration zurück, wie mittels SetUVACallbackConfiguration() gesetzt.

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

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
BrickletUVLightV2.SetUVBCallbackConfiguration(period, valueHasToChange, option, min, max)
Eingabe:
  • period -- Int64
  • valueHasToChange -- Boolean
  • option -- Char
  • min -- Int32
  • max -- Int32

Die Periode in ms ist die Periode mit der der UVBCallback 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 UVBCallback 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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
BrickletUVLightV2.GetUVBCallbackConfiguration() → period, valueHasToChange, option, min, max
Ausgabe:
  • period -- Int64
  • valueHasToChange -- Boolean
  • option -- Char
  • min -- Int32
  • max -- Int32

Gibt die Callback-Konfiguration zurück, wie mittels SetUVBCallbackConfiguration() gesetzt.

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

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
BrickletUVLightV2.SetUVICallbackConfiguration(period, valueHasToChange, option, min, max)
Eingabe:
  • period -- Int64
  • valueHasToChange -- Boolean
  • option -- Char
  • min -- Int32
  • max -- Int32

Die Periode in ms ist die Periode mit der der UVICallback 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 UVICallback 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.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
BrickletUVLightV2.GetUVICallbackConfiguration() → period, valueHasToChange, option, min, max
Ausgabe:
  • period -- Int64
  • valueHasToChange -- Boolean
  • option -- Char
  • min -- Int32
  • max -- Int32

Gibt die Callback-Konfiguration zurück, wie mittels SetUVICallbackConfiguration() gesetzt.

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

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'

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 BrickletUVLightV2.UVACallback(sender, uva)
Eingabe:
  • sender -- .NET Refnum (BrickletUVLightV2)
  • uva -- Int32

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

Der Parameter ist der gleiche wie GetUVA().

event BrickletUVLightV2.UVBCallback(sender, uvb)
Eingabe:
  • sender -- .NET Refnum (BrickletUVLightV2)
  • uvb -- Int32

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

Der Parameter ist der gleiche wie GetUVB().

event BrickletUVLightV2.UVICallback(sender, uvi)
Eingabe:
  • sender -- .NET Refnum (BrickletUVLightV2)
  • uvi -- Int32

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

Der Parameter ist der gleiche wie GetUVI().

Konstanten

BrickletUVLightV2.DEVICE_IDENTIFIER

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

BrickletUVLightV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet 2.0 dar.