Visual Basic .NET - UV Light Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das UV Light Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des UV Light Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your UV Light Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim uvl As New BrickletUVLight(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Get current UV light
        Dim uvLight As Long = uvl.GetUVLight()
        Console.WriteLine("UV Light: " + (uvLight/10.0).ToString() + " mW/m²")

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback

Download (ExampleCallback.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your UV Light Bricklet

    ' Callback subroutine for UV light callback
    Sub UVLightCB(ByVal sender As BrickletUVLight, ByVal uvLight As Long)
        Console.WriteLine("UV Light: " + (uvLight/10.0).ToString() + " mW/m²")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim uvl As New BrickletUVLight(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register UV light callback to subroutine UVLightCB
        AddHandler uvl.UVLightCallback, AddressOf UVLightCB

        ' Set period for UV light callback to 1s (1000ms)
        ' Note: The UV light callback is only called every second
        '       if the UV light has changed since the last call!
        uvl.SetUVLightCallbackPeriod(1000)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Threshold

Download (ExampleThreshold.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Imports System
Imports Tinkerforge

Module ExampleThreshold
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your UV Light Bricklet

    ' Callback subroutine for UV light reached callback
    Sub UVLightReachedCB(ByVal sender As BrickletUVLight, ByVal uvLight As Long)
        Console.WriteLine("UV Light: " + (uvLight/10.0).ToString() + " mW/m²")
        Console.WriteLine("UV Index > 3. Use sunscreen!")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim uvl As New BrickletUVLight(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        uvl.SetDebouncePeriod(10000)

        ' Register UV light reached callback to subroutine UVLightReachedCB
        AddHandler uvl.UVLightReachedCallback, AddressOf UVLightReachedCB

        ' Configure threshold for UV light "greater than 75 mW/m²"
        uvl.SetUVLightCallbackThreshold(">"C, 75*10, 0)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

Class BrickletUVLight(ByVal uid As String, ByVal ipcon As IPConnection)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

Dim uvLight As New BrickletUVLight("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Function BrickletUVLight.GetUVLight() As Long

Gibt die UV-Licht-Intensität des Sensors zurück. Die Intensität wird in der Einheit 1/10 mW/m² gegeben. Der Sensor hat die Intensität bereits mit dem Erythem-Wirkungsspektrum gewichtet, um die hautbeeinflussende Bestrahlungsstärke zu bestimmen.

Die Intensität kann dann einfach durch 250 geteilt werden um den UV Index zu bestimmen. Beispiel: Eine UV-Licht-Intensität von 500 entspricht einem UV Index von 2.

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

Fortgeschrittene Funktionen

Function BrickletUVLight.GetAPIVersion() As Byte()

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.

Function BrickletUVLight.GetResponseExpected(ByVal functionId As Byte) As 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.

Sub BrickletUVLight.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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:

  • BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2
  • BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4
  • BrickletUVLight.FUNCTION_SET_DEBOUNCE_PERIOD = 6
Sub BrickletUVLight.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletUVLight.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

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

Sub BrickletUVLight.SetUVLightCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletUVLight.GetUVLightCallbackPeriod() As Long

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

Sub BrickletUVLight.SetUVLightCallbackThreshold(ByVal option As Char, ByVal min As Long, ByVal max As Long)

Setzt den Schwellwert für den UVLightReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • BrickletUVLight.THRESHOLD_OPTION_OFF = "x"C
  • BrickletUVLight.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletUVLight.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletUVLight.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletUVLight.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletUVLight.GetUVLightCallbackThreshold(ByRef option As Char, ByRef min As Long, ByRef max As Long)

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

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

  • BrickletUVLight.THRESHOLD_OPTION_OFF = "x"C
  • BrickletUVLight.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletUVLight.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletUVLight.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletUVLight.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletUVLight.SetDebouncePeriod(ByVal debounce As Long)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

Function BrickletUVLight.GetDebouncePeriod() As Long

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 Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletUVLight, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler uvLight.ExampleCallback, AddressOf MyCallback

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 BrickletUVLight.UVLightCallback(ByVal sender As BrickletUVLight, ByVal uvLight As Long)

Dieser Callback wird mit der Periode, wie gesetzt mit SetUVLightCallbackPeriod(), ausgelöst. Der Parameter ist die UV-Licht-Intensität des Sensors.

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

Event BrickletUVLight.UVLightReachedCallback(ByVal sender As BrickletUVLight, ByVal uvLight As Long)

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetUVLightCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die UV-Licht-Intensität des Sensors.

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

Konstanten

Const BrickletUVLight.DEVICE_IDENTIFIER

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

Const BrickletUVLight.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet dar.