Visual Basic .NET - Ambient Light Bricklet¶

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

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim al As New BrickletAmbientLight(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 Integer = al.GetIlluminance()
        Console.WriteLine("Illuminance: " + (illuminance/10.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
34

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

    ' Callback subroutine for illuminance callback
    Sub IlluminanceCB(ByVal sender As BrickletAmbientLight, _
                      ByVal illuminance As Integer)
        Console.WriteLine("Illuminance: " + (illuminance/10.0).ToString() + " lx")
    End Sub

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

    ' Callback subroutine for illuminance reached callback
    Sub IlluminanceReachedCB(ByVal sender As BrickletAmbientLight, _
                             ByVal illuminance As Integer)
        Console.WriteLine("Illuminance: " + (illuminance/10.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 BrickletAmbientLight(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 200 lx"
        al.SetIlluminanceCallbackThreshold(">"C, 200*10, 0)

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

Grundfunktionen¶

Class BrickletAmbientLight(ByVal uid As String, ByVal ipcon As IPConnection)¶

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

Dim ambientLight As New BrickletAmbientLight("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

Function BrickletAmbientLight.GetIlluminance() As Integer¶

Rückgabe:	illuminance – Typ: Integer, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück.

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

Fortgeschrittene Funktionen¶

Function BrickletAmbientLight.GetAnalogValue() As Integer¶

Rückgabe:	value – Typ: Integer, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von GetIlluminance() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Weiterhin deckt der Analog-Digital-Wandler drei unterschiedliche Bereiche ab, welche dynamisch gewechselt werden abhängig von der Lichtintensität. Es ist nicht möglich, anhand der Analogwerte, zwischen diesen Bereichen zu unterscheiden.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod() vorzugeben.

Sub BrickletAmbientLight.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, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 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 Array, Länge: 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: 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 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¶

Sub BrickletAmbientLight.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 BrickletAmbientLight.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 BrickletAmbientLight.SetAnalogValueCallbackPeriod(ByVal period As Long)¶

Parameter:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Function BrickletAmbientLight.GetAnalogValueCallbackPeriod() As Long¶

Rückgabe:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Sub BrickletAmbientLight.SetIlluminanceCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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)

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

Für option:

• BrickletAmbientLight.THRESHOLD_OPTION_OFF = "x"C
• BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletAmbientLight.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletAmbientLight.GetIlluminanceCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Ausgabeparameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• BrickletAmbientLight.THRESHOLD_OPTION_OFF = "x"C
• BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletAmbientLight.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletAmbientLight.SetAnalogValueCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den AnalogValueReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BrickletAmbientLight.THRESHOLD_OPTION_OFF = "x"C
• BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletAmbientLight.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletAmbientLight.GetAnalogValueCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Ausgabeparameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: Integer, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• BrickletAmbientLight.THRESHOLD_OPTION_OFF = "x"C
• BrickletAmbientLight.THRESHOLD_OPTION_OUTSIDE = "o"C
• BrickletAmbientLight.THRESHOLD_OPTION_INSIDE = "i"C
• BrickletAmbientLight.THRESHOLD_OPTION_SMALLER = "<"C
• BrickletAmbientLight.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletAmbientLight.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

• IlluminanceReachedCallback,
• AnalogValueReachedCallback

ausgelöst werden, wenn die Schwellwerte

• SetIlluminanceCallbackThreshold(),
• SetAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

Function BrickletAmbientLight.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 BrickletAmbientLight, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler ambientLight.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Event BrickletAmbientLight.IlluminanceCallback(ByVal sender As BrickletAmbientLight, ByVal illuminance As Integer)¶

Callback-Parameter:	sender – Typ: BrickletAmbientLight illuminance – Typ: Integer, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

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 BrickletAmbientLight.AnalogValueCallback(ByVal sender As BrickletAmbientLight, ByVal value As Integer)¶

Callback-Parameter:	sender – Typ: BrickletAmbientLight value – Typ: Integer, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Umgebungslichtsensors.

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

Event BrickletAmbientLight.IlluminanceReachedCallback(ByVal sender As BrickletAmbientLight, ByVal illuminance As Integer)¶

Callback-Parameter:	sender – Typ: BrickletAmbientLight illuminance – Typ: Integer, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

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.

Event BrickletAmbientLight.AnalogValueReachedCallback(ByVal sender As BrickletAmbientLight, ByVal value As Integer)¶

Callback-Parameter:	sender – Typ: BrickletAmbientLight value – Typ: Integer, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Umgebungslichtsensors.

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.

Function BrickletAmbientLight.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 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.

Function BrickletAmbientLight.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:

• BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
• BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
• BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletAmbientLight.FUNCTION_SET_DEBOUNCE_PERIOD = 11

Sub BrickletAmbientLight.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:

• BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
• BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletAmbientLight.FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
• BrickletAmbientLight.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletAmbientLight.FUNCTION_SET_DEBOUNCE_PERIOD = 11

Sub BrickletAmbientLight.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.

Konstanten¶

Const BrickletAmbientLight.DEVICE_IDENTIFIER¶

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

Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet dar.