Visual Basic .NET - Industrial Dual Analog In Bricklet

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

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

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

        ' Get current voltage from channel 1
        Dim voltage As Integer = idai.GetVoltage(1)
        Console.WriteLine("Voltage (Channel 1): " + (voltage/1000.0).ToString() + " V")

        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 Analog In Bricklet

    ' Callback subroutine for voltage callback
    Sub VoltageCB(ByVal sender As BrickletIndustrialDualAnalogIn, ByVal channel As Byte, _
                  ByVal voltage As Integer)
        Console.WriteLine("Channel: " + channel.ToString())
        Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
        Console.WriteLine("")
    End Sub

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

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

        ' Register voltage callback to subroutine VoltageCB
        AddHandler idai.VoltageCallback, AddressOf VoltageCB

        ' Set period for voltage (channel 1) callback to 1s (1000ms)
        ' Note: The voltage (channel 1) callback is only called every second
        '       if the voltage (channel 1) has changed since the last call!
        idai.SetVoltageCallbackPeriod(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 Analog In Bricklet

    ' Callback subroutine for voltage reached callback
    Sub VoltageReachedCB(ByVal sender As BrickletIndustrialDualAnalogIn, _
                         ByVal channel As Byte, ByVal voltage As Integer)
        Console.WriteLine("Channel: " + channel.ToString())
        Console.WriteLine("Voltage: " + (voltage/1000.0).ToString() + " V")
        Console.WriteLine("")
    End Sub

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

        ' Register voltage reached callback to subroutine VoltageReachedCB
        AddHandler idai.VoltageReachedCallback, AddressOf VoltageReachedCB

        ' Configure threshold for voltage (channel 1) "greater than 10 V"
        idai.SetVoltageCallbackThreshold(1, ">"C, 10*1000, 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.

Das Bricklet hat zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für das channel Parameter sind 0 und 1.

Grundfunktionen

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

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

Dim industrialDualAnalogIn As New BrickletIndustrialDualAnalogIn("YOUR_DEVICE_UID", ipcon)

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

Function BrickletIndustrialDualAnalogIn.GetVoltage(ByVal channel As Byte) As Integer

Gibt die Spannung für den übergebenen Kanal in mV zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den VoltageCallback Callback zu nutzen und die Periode mit SetVoltageCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

Sub BrickletIndustrialDualAnalogIn.SetSampleRate(ByVal rate As Byte)

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

Der Standardwert ist 6 (2 Werte pro Sekunde).

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

  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_1_SPS = 7
Function BrickletIndustrialDualAnalogIn.GetSampleRate() As Byte

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

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

  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_1_SPS = 7
Sub BrickletIndustrialDualAnalogIn.SetCalibration(ByVal offset() As Integer, ByVal gain() As Integer)

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

Sub BrickletIndustrialDualAnalogIn.GetCalibration(ByRef offset() As Integer, ByRef gain() As Integer)

Gibt die Kalibrierung zurück, wie von SetCalibration() gesetzt.

Function BrickletIndustrialDualAnalogIn.GetADCValues() As Integer()

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe SetCalibration().

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

  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_SAMPLE_RATE = 8
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_CALIBRATION = 10
Sub BrickletIndustrialDualAnalogIn.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletIndustrialDualAnalogIn.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 BrickletIndustrialDualAnalogIn.SetVoltageCallbackPeriod(ByVal channel As Byte, ByVal period As Long)

Setzt die Periode in ms mit welcher der VoltageCallback Callback für den übergebenen Kanal ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der VoltageCallback Callback wird nur ausgelöst wenn sich die Spannung seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

Function BrickletIndustrialDualAnalogIn.GetVoltageCallbackPeriod(ByVal channel As Byte) As Long

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

Sub BrickletIndustrialDualAnalogIn.SetVoltageCallbackThreshold(ByVal channel As Byte, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Setzt den Schwellwert des VoltageReachedCallback Callbacks für den übergebenen Kanal.

Die folgenden Optionen sind möglich:

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

  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OFF = "x"C
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletIndustrialDualAnalogIn.GetVoltageCallbackThreshold(ByVal channel As Byte, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

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

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

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

Setzt die Periode in ms mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

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

AddHandler industrialDualAnalogIn.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 BrickletIndustrialDualAnalogIn.VoltageCallback(ByVal sender As BrickletIndustrialDualAnalogIn, ByVal channel As Byte, ByVal voltage As Integer)

Dieser Callback wird mit der Periode, wie gesetzt mit SetVoltageCallbackPeriod(), ausgelöst. Der Parameter ist die Spannung des Kanals.

Der VoltageCallback Callback wird nur ausgelöst wenn sich die Spannung seit der letzten Auslösung geändert hat.

Event BrickletIndustrialDualAnalogIn.VoltageReachedCallback(ByVal sender As BrickletIndustrialDualAnalogIn, ByVal channel As Byte, ByVal voltage As Integer)

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von SetVoltageCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Spannung des Kanals.

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

Konstanten

Const BrickletIndustrialDualAnalogIn.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Dual Analog In Bricklet zu identifizieren.

Die GetIdentity() Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

Const BrickletIndustrialDualAnalogIn.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Dual Analog In Bricklet dar.