Visual Basic .NET - Ambient Light Bricklet 2.0

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

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

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

        ' Get current illuminance
        Dim illuminance As Long = al.GetIlluminance()
        Console.WriteLine("Illuminance: " + (illuminance/100.0).ToString() + " lx")

        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 Ambient Light Bricklet 2.0

    ' Callback subroutine for illuminance callback
    Sub IlluminanceCB(ByVal sender As BrickletAmbientLightV2, ByVal illuminance As Long)
        Console.WriteLine("Illuminance: " + (illuminance/100.0).ToString() + " lx")
    End Sub

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

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

        ' Register illuminance callback to subroutine IlluminanceCB
        AddHandler al.IlluminanceCallback, AddressOf IlluminanceCB

        ' Set period for illuminance callback to 1s (1000ms)
        ' Note: The illuminance callback is only called every second
        '       if the illuminance has changed since the last call!
        al.SetIlluminanceCallbackPeriod(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
36
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 Ambient Light Bricklet 2.0

    ' Callback subroutine for illuminance reached callback
    Sub IlluminanceReachedCB(ByVal sender As BrickletAmbientLightV2, _
                             ByVal illuminance As Long)
        Console.WriteLine("Illuminance: " + (illuminance/100.0).ToString() + " lx")
        Console.WriteLine("Too bright, close the curtains!")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim al As New BrickletAmbientLightV2(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)
        al.SetDebouncePeriod(10000)

        ' Register illuminance reached callback to subroutine IlluminanceReachedCB
        AddHandler al.IlluminanceReachedCallback, AddressOf IlluminanceReachedCB

        ' Configure threshold for illuminance "greater than 500 lx"
        al.SetIlluminanceCallbackThreshold(">"C, 500*100, 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 BrickletAmbientLightV2(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim ambientLightV2 As New BrickletAmbientLightV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletAmbientLightV2.GetIlluminance() As Long
Rückgabe:
  • illuminance – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab. Die Beleuchtungsstärke ist in Lux/100 angegeben, d.h. bei einem Wert von 450000 wurde eine Beleuchtungsstärke von 4500Lux gemessen.

Geändert in Version 2.0.2 (Plugin): Eine Beleuchtungsstärke von 0Lux bedeutet, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte, siehe SetConfiguration().

Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen den IlluminanceCallback Callback zu nutzen und die Periode mit SetIlluminanceCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

Sub BrickletAmbientLightV2.SetConfiguration(ByVal illuminanceRange As Byte, ByVal integrationTime As Byte)
Parameter:
  • illuminanceRange – Typ: Byte, Wertebereich: Siehe Konstanten
  • integrationTime – Typ: Byte, Wertebereich: Siehe Konstanten

Setzt die Konfiguration. Es ist möglich den Helligkeitswertebereich zwischen 0-600Lux und 0-64000Lux sowie eine Integrationszeit zwischen 50ms und 400ms zu konfigurieren.

Neu in Version 2.0.2 (Plugin): Der unbeschränkt (unlimited) Helligkeitswertebereich ermöglicht es bis über 100000Lux zu messen, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Ein kleinerer Helligkeitswertebereich erhöht die Auflösung der Daten. Eine längere Integrationszeit verringert das Rauschen auf den Daten.

Geändert in Version 2.0.2 (Plugin): Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben GetIlluminance() und der IlluminanceCallback Callback das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

Geändert in Version 2.0.2 (Plugin): Bei einer langen Integrationszeit kann es sein, dass der Sensor gesättigt (saturated) ist bevor der Messwert das Maximum des ausgewählten Helligkeitswertebereichs erreicht hat. In diesem Fall geben GetIlluminance() und der IlluminanceCallback Callback 0Lux zurück.

Wenn der Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt oder der Sensor gesättigt ist, dann sollte der nächst höhere Helligkeitswertebereich eingestellt werden. Wenn der höchste Helligkeitswertebereich schon erreicht ist, dann kann noch die Integrationszeit verringert werden.

Die Standardwerte sind 0-8000Lux Helligkeitsbereich und 200ms Integrationszeit.

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

Für illuminanceRange:

  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_UNLIMITED = 6
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_64000LUX = 0
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_32000LUX = 1
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_16000LUX = 2
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_8000LUX = 3
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_1300LUX = 4
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_600LUX = 5

Für integrationTime:

  • BrickletAmbientLightV2.INTEGRATION_TIME_50MS = 0
  • BrickletAmbientLightV2.INTEGRATION_TIME_100MS = 1
  • BrickletAmbientLightV2.INTEGRATION_TIME_150MS = 2
  • BrickletAmbientLightV2.INTEGRATION_TIME_200MS = 3
  • BrickletAmbientLightV2.INTEGRATION_TIME_250MS = 4
  • BrickletAmbientLightV2.INTEGRATION_TIME_300MS = 5
  • BrickletAmbientLightV2.INTEGRATION_TIME_350MS = 6
  • BrickletAmbientLightV2.INTEGRATION_TIME_400MS = 7
Sub BrickletAmbientLightV2.GetConfiguration(ByRef illuminanceRange As Byte, ByRef integrationTime As Byte)
Ausgabeparameter:
  • illuminanceRange – Typ: Byte, Wertebereich: Siehe Konstanten
  • integrationTime – Typ: Byte, Wertebereich: Siehe Konstanten

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

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

Für illuminanceRange:

  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_UNLIMITED = 6
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_64000LUX = 0
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_32000LUX = 1
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_16000LUX = 2
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_8000LUX = 3
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_1300LUX = 4
  • BrickletAmbientLightV2.ILLUMINANCE_RANGE_600LUX = 5

Für integrationTime:

  • BrickletAmbientLightV2.INTEGRATION_TIME_50MS = 0
  • BrickletAmbientLightV2.INTEGRATION_TIME_100MS = 1
  • BrickletAmbientLightV2.INTEGRATION_TIME_150MS = 2
  • BrickletAmbientLightV2.INTEGRATION_TIME_200MS = 3
  • BrickletAmbientLightV2.INTEGRATION_TIME_250MS = 4
  • BrickletAmbientLightV2.INTEGRATION_TIME_300MS = 5
  • BrickletAmbientLightV2.INTEGRATION_TIME_350MS = 6
  • BrickletAmbientLightV2.INTEGRATION_TIME_400MS = 7
Function BrickletAmbientLightV2.GetAPIVersion() As Byte()
Rückgabe:
  • apiVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]

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 BrickletAmbientLightV2.GetResponseExpected(ByVal functionId As Byte) As Boolean
Parameter:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • 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:

  • BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
  • BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
  • BrickletAmbientLightV2.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAmbientLightV2.FUNCTION_SET_CONFIGURATION = 8
Sub BrickletAmbientLightV2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)
Parameter:
  • 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:

  • BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
  • BrickletAmbientLightV2.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
  • BrickletAmbientLightV2.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAmbientLightV2.FUNCTION_SET_CONFIGURATION = 8
Sub BrickletAmbientLightV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)
Parameter:
  • responseExpected – Typ: Boolean

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

Sub BrickletAmbientLightV2.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)
Ausgabeparameter:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char
  • hardwareVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte Array, Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Integer, 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 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 BrickletAmbientLightV2.SetIlluminanceCallbackPeriod(ByVal period As Long)
Parameter:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Function BrickletAmbientLightV2.GetIlluminanceCallbackPeriod() As Long
Rückgabe:
  • period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Sub BrickletAmbientLightV2.SetIlluminanceCallbackThreshold(ByVal option As Char, ByVal min As Long, ByVal max As Long)
Parameter:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • max – Typ: Long, Wertebereich: [0 bis 232 - 1]

Setzt den Schwellwert für den IlluminanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Beleuchtungsstärke außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Beleuchtungsstärke innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Beleuchtungsstärke kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Beleuchtungsstärke 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:

Für option:

  • BrickletAmbientLightV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletAmbientLightV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletAmbientLightV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletAmbientLightV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletAmbientLightV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletAmbientLightV2.GetIlluminanceCallbackThreshold(ByRef option As Char, ByRef min As Long, ByRef max As Long)
Ausgabeparameter:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C
  • min – Typ: Long, Wertebereich: [0 bis 232 - 1]
  • max – Typ: Long, Wertebereich: [0 bis 232 - 1]

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

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

Für option:

  • BrickletAmbientLightV2.THRESHOLD_OPTION_OFF = "x"C
  • BrickletAmbientLightV2.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletAmbientLightV2.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletAmbientLightV2.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletAmbientLightV2.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletAmbientLightV2.SetDebouncePeriod(ByVal debounce As Long)
Parameter:
  • debounce – Typ: Long, 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.

Function BrickletAmbientLightV2.GetDebouncePeriod() As Long
Rückgabe:
  • debounce – Typ: Long, 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 Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

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

AddHandler ambientLightV2.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 BrickletAmbientLightV2.IlluminanceCallback(ByVal sender As BrickletAmbientLightV2, ByVal illuminance As Long)
Callback-Parameter:
  • sender – Typ: BrickletAmbientLightV2
  • illuminance – Typ: Long, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetIlluminanceCallbackPeriod(), ausgelöst. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

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

Event BrickletAmbientLightV2.IlluminanceReachedCallback(ByVal sender As BrickletAmbientLightV2, ByVal illuminance As Long)
Callback-Parameter:
  • sender – Typ: BrickletAmbientLightV2
  • illuminance – Typ: Long, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetIlluminanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Beleuchtungsstärke des Umgebungslichtsensors.

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

Konstanten

Const BrickletAmbientLightV2.DEVICE_IDENTIFIER

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

Const BrickletAmbientLightV2.DEVICE_DISPLAY_NAME

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