Visual Basic .NET - Industrial Dual 0-20mA 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 Industrial Dual 0-20mA Bricklet

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

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

        ' Get current current from sensor 1
        Dim current As Integer = id020.GetCurrent(1)
        Console.WriteLine("Current (Sensor 1): " + (current/1000000.0).ToString() + " mA")

        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
35
36

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 Industrial Dual 0-20mA Bricklet

    ' Callback subroutine for current callback
    Sub CurrentCB(ByVal sender As BrickletIndustrialDual020mA, ByVal sensor As Byte, _
                  ByVal current As Integer)
        Console.WriteLine("Sensor: " + sensor.ToString())
        Console.WriteLine("Current: " + (current/1000000.0).ToString() + " mA")
        Console.WriteLine("")
    End Sub

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

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

        ' Register current callback to subroutine CurrentCB
        AddHandler id020.CurrentCallback, AddressOf CurrentCB

        ' Set period for current (sensor 1) callback to 1s (1000ms)
        ' Note: The current (sensor 1) callback is only called every second
        '       if the current (sensor 1) has changed since the last call!
        id020.SetCurrentCallbackPeriod(1, 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
37

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 Industrial Dual 0-20mA Bricklet

    ' Callback subroutine for current reached callback
    Sub CurrentReachedCB(ByVal sender As BrickletIndustrialDual020mA, _
                         ByVal sensor As Byte, ByVal current As Integer)
        Console.WriteLine("Sensor: " + sensor.ToString())
        Console.WriteLine("Current: " + (current/1000000.0).ToString() + " mA")
        Console.WriteLine("")
    End Sub

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

        ' Register current reached callback to subroutine CurrentReachedCB
        AddHandler id020.CurrentReachedCallback, AddressOf CurrentReachedCB

        ' Configure threshold for current (sensor 1) "greater than 10 mA"
        id020.SetCurrentCallbackThreshold(1, ">"C, 10*1000000, 0)

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

Grundfunktionen¶

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

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

Dim industrialDual020mA As New BrickletIndustrialDual020mA("YOUR_DEVICE_UID", ipcon)

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

Function BrickletIndustrialDual020mA.GetCurrent(ByVal sensor As Byte) As Integer¶

Parameter:	sensor – Typ: Byte, Wertebereich: [0 bis 1]
Rückgabe:	current – Typ: Integer, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Gibt die gemessenen Stromstärke des angegebenen Sensors zurück.

Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.

Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den CurrentCallback Callback zu nutzen und die Periode mit SetCurrentCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

Sub BrickletIndustrialDual020mA.SetSampleRate(ByVal rate As Byte)¶

Parameter:	rate – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.

Wert	Beschreibung
0	240 Samples pro Sekunde, 12 Bit Auflösung
1	60 Samples pro Sekunde, 14 Bit Auflösung
2	15 Samples pro Sekunde, 16 Bit Auflösung
3	4 Samples pro Sekunde, 18 Bit Auflösung

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

Für rate:

• BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
• BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
• BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
• BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3

Function BrickletIndustrialDual020mA.GetSampleRate() As Byte¶

Rückgabe:	rate – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Abtastrate zurück, wie von SetSampleRate() gesetzt.

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

Für rate:

• BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
• BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
• BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
• BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3

Sub BrickletIndustrialDual020mA.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 BrickletIndustrialDual020mA.SetCurrentCallbackPeriod(ByVal sensor As Byte, ByVal period As Long)¶

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

Setzt die Periode mit welcher der CurrentCallback Callback für den übergebenen Sensor ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

Function BrickletIndustrialDual020mA.GetCurrentCallbackPeriod(ByVal sensor As Byte) As Long¶

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

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

Sub BrickletIndustrialDual020mA.SetCurrentCallbackThreshold(ByVal sensor As Byte, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameter:	sensor – Typ: Byte, Wertebereich: [0 bis 1] option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert des CurrentReachedCallback Callbacks für den übergebenen Sensor.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

Sub BrickletIndustrialDual020mA.GetCurrentCallbackThreshold(ByVal sensor As Byte, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Parameter:	sensor – Typ: Byte, Wertebereich: [0 bis 1]
Ausgabeparameter:	option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

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

Sub BrickletIndustrialDual020mA.SetDebouncePeriod(ByVal debounce As Long)¶

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

Setzt die Periode mit welcher der Schwellwert Callback

• CurrentReachedCallback

ausgelöst werden, wenn der Schwellwert

• SetCurrentCallbackThreshold()

weiterhin erreicht bleibt.

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

AddHandler industrialDual020mA.ExampleCallback, AddressOf MyCallback

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

Event BrickletIndustrialDual020mA.CurrentCallback(ByVal sender As BrickletIndustrialDual020mA, ByVal sensor As Byte, ByVal current As Integer)¶

Callback-Parameter:	sender – Typ: BrickletIndustrialDual020mA sensor – Typ: Byte, Wertebereich: [0 bis 1] current – Typ: Integer, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Dieser Callback wird mit der Periode, wie gesetzt mit SetCurrentCallbackPeriod(), ausgelöst. Der Parameter ist die Stromstärke des Sensors.

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

Event BrickletIndustrialDual020mA.CurrentReachedCallback(ByVal sender As BrickletIndustrialDual020mA, ByVal sensor As Byte, ByVal current As Integer)¶

Callback-Parameter:	sender – Typ: BrickletIndustrialDual020mA sensor – Typ: Byte, Wertebereich: [0 bis 1] current – Typ: Integer, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCurrentCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Stromstärke 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 BrickletIndustrialDual020mA.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 BrickletIndustrialDual020mA.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:

• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
• BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8

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

• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
• BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8

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

Diese Konstante wird verwendet um ein Industrial Dual 0-20mA 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 BrickletIndustrialDual020mA.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet dar.