Visual Basic .NET - Moisture Bricklet¶

Simple¶

Download (ExampleSimple.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleSimple
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Moisture Bricklet
 8
 9    Sub Main()
10        Dim ipcon As New IPConnection() ' Create IP connection
11        Dim m As New BrickletMoisture(UID, ipcon) ' Create device object
12
13        ipcon.Connect(HOST, PORT) ' Connect to brickd
14        ' Don't use device before ipcon is connected
15
16        ' Get current moisture value
17        Dim moisture As Integer = m.GetMoistureValue()
18        Console.WriteLine("Moisture Value: " + moisture.ToString())
19
20        Console.WriteLine("Press key to exit")
21        Console.ReadLine()
22        ipcon.Disconnect()
23    End Sub
24End Module

Callback¶

Download (ExampleCallback.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleCallback
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Moisture Bricklet
 8
 9    ' Callback subroutine for moisture value callback
10    Sub MoistureCB(ByVal sender As BrickletMoisture, ByVal moisture As Integer)
11        Console.WriteLine("Moisture Value: " + moisture.ToString())
12    End Sub
13
14    Sub Main()
15        Dim ipcon As New IPConnection() ' Create IP connection
16        Dim m As New BrickletMoisture(UID, ipcon) ' Create device object
17
18        ipcon.Connect(HOST, PORT) ' Connect to brickd
19        ' Don't use device before ipcon is connected
20
21        ' Register moisture value callback to subroutine MoistureCB
22        AddHandler m.MoistureCallback, AddressOf MoistureCB
23
24        ' Set period for moisture value callback to 1s (1000ms)
25        ' Note: The moisture value callback is only called every second
26        '       if the moisture value has changed since the last call!
27        m.SetMoistureCallbackPeriod(1000)
28
29        Console.WriteLine("Press key to exit")
30        Console.ReadLine()
31        ipcon.Disconnect()
32    End Sub
33End Module

Threshold¶

Download (ExampleThreshold.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleThreshold
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Moisture Bricklet
 8
 9    ' Callback subroutine for moisture value reached callback
10    Sub MoistureReachedCB(ByVal sender As BrickletMoisture, ByVal moisture As Integer)
11        Console.WriteLine("Moisture Value: " + moisture.ToString())
12    End Sub
13
14    Sub Main()
15        Dim ipcon As New IPConnection() ' Create IP connection
16        Dim m As New BrickletMoisture(UID, ipcon) ' Create device object
17
18        ipcon.Connect(HOST, PORT) ' Connect to brickd
19        ' Don't use device before ipcon is connected
20
21        ' Get threshold callbacks with a debounce time of 1 second (1000ms)
22        m.SetDebouncePeriod(1000)
23
24        ' Register moisture value reached callback to subroutine MoistureReachedCB
25        AddHandler m.MoistureReachedCallback, AddressOf MoistureReachedCB
26
27        ' Configure threshold for moisture value "greater than 200"
28        m.SetMoistureCallbackThreshold(">"C, 200, 0)
29
30        Console.WriteLine("Press key to exit")
31        Console.ReadLine()
32        ipcon.Disconnect()
33    End Sub
34End Module

Grundfunktionen¶

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

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

Dim moisture As New BrickletMoisture("YOUR_DEVICE_UID", ipcon)

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

Function BrickletMoisture.GetMoistureValue() As Integer¶

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

Gibt den aktuellen Feuchtigkeitswert zurück. Ein kleiner Wert entspricht einer geringen Feuchtigkeit, ein großer Wert entspricht einer hohen Feuchtigkeit.

Wenn der Feuchtigkeitswert periodisch abgefragt werden soll, wird empfohlen den MoistureCallback Callback zu nutzen und die Periode mit SetMoistureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

Sub BrickletMoisture.SetMovingAverage(ByVal average As Byte)¶

Parameter:	average – Typ: Byte, Wertebereich: [0 bis 100], Standardwert: 100

Setzt die Länge eines gleitenden Mittelwerts für den Feuchtigkeitswert.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Function BrickletMoisture.GetMovingAverage() As Byte¶

Rückgabe:	average – Typ: Byte, Wertebereich: [0 bis 100], Standardwert: 100

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage() gesetzt.

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

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

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

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

Function BrickletMoisture.GetMoistureCallbackPeriod() As Long¶

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

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

Sub BrickletMoisture.SetMoistureCallbackThreshold(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 MoistureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BrickletMoisture.THRESHOLD_OPTION_OFF = "x"C

• BrickletMoisture.THRESHOLD_OPTION_OUTSIDE = "o"C

• BrickletMoisture.THRESHOLD_OPTION_INSIDE = "i"C

• BrickletMoisture.THRESHOLD_OPTION_SMALLER = "<"C

• BrickletMoisture.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletMoisture.GetMoistureCallbackThreshold(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 SetMoistureCallbackThreshold() gesetzt.

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

Für option:

• BrickletMoisture.THRESHOLD_OPTION_OFF = "x"C

• BrickletMoisture.THRESHOLD_OPTION_OUTSIDE = "o"C

• BrickletMoisture.THRESHOLD_OPTION_INSIDE = "i"C

• BrickletMoisture.THRESHOLD_OPTION_SMALLER = "<"C

• BrickletMoisture.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletMoisture.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 Callback

• MoistureReachedCallback

ausgelöst wird, wenn der Schwellwert

• SetMoistureCallbackThreshold()

weiterhin erreicht bleibt.

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

AddHandler moisture.ExampleCallback, AddressOf MyCallback

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

Event BrickletMoisture.MoistureCallback(ByVal sender As BrickletMoisture, ByVal moisture As Integer)¶

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

Dieser Callback wird mit der Periode, wie gesetzt mit SetMoistureCallbackPeriod(), ausgelöst. Der Parameter ist der Feuchtigkeitswert des Sensors.

The MoistureCallback Callback wird nur ausgelöst, wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

Event BrickletMoisture.MoistureReachedCallback(ByVal sender As BrickletMoisture, ByVal moisture As Integer)¶

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetMoistureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Feuchtigkeitswert des Sensors.

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 BrickletMoisture.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 BrickletMoisture.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:

• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2

• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4

• BrickletMoisture.FUNCTION_SET_DEBOUNCE_PERIOD = 6

• BrickletMoisture.FUNCTION_SET_MOVING_AVERAGE = 10

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

• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2

• BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4

• BrickletMoisture.FUNCTION_SET_DEBOUNCE_PERIOD = 6

• BrickletMoisture.FUNCTION_SET_MOVING_AVERAGE = 10

Sub BrickletMoisture.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 BrickletMoisture.DEVICE_IDENTIFIER¶

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

Diese Konstante stellt den Anzeigenamen eines Moisture Bricklet dar.