Visual Basic .NET - Industrial Dual Analog In Bricklet 2.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 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim idai As New BrickletIndustrialDualAnalogInV2(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 0
        Dim voltage As Integer = idai.GetVoltage(0)
        Console.WriteLine("Voltage (Channel 0): " + (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

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 2.0

    ' Callback subroutine for voltage callback
    Sub VoltageCB(ByVal sender As BrickletIndustrialDualAnalogInV2, _
                  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 BrickletIndustrialDualAnalogInV2(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 0) callback to 1s (1000ms) without a threshold
        idai.SetVoltageCallbackConfiguration(0, 1000, False, "x"C, 0, 0)

        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

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 2.0

    ' Callback subroutine for voltage callback
    Sub VoltageCB(ByVal sender As BrickletIndustrialDualAnalogInV2, _
                  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 BrickletIndustrialDualAnalogInV2(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

        ' Configure threshold for voltage (channel 0) "greater than 10 V"
        ' with a debounce period of 10s (10000ms)
        idai.SetVoltageCallbackConfiguration(0, 10000, False, ">"C, 10*1000, 0)

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

Grundfunktionen¶

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

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

Dim industrialDualAnalogInV2 As New BrickletIndustrialDualAnalogInV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletIndustrialDualAnalogInV2.GetVoltage(ByVal channel As Byte) As Integer¶

Parameter:	channel – Typ: Byte, Wertebereich: [0 bis 1]
Rückgabe:	voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

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

Wenn der Wert periodisch benötigt wird, kann auch der VoltageCallback Callback verwendet werden. Der Callback wird mit der Funktion SetVoltageCallbackConfiguration() konfiguriert.

Sub BrickletIndustrialDualAnalogInV2.SetChannelLEDConfig(ByVal channel As Byte, ByVal config As Byte)¶

Parameter:	channel – Typ: Byte, Wertebereich: [0 bis 1] config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

Das Verhalten des Kanalstatus kann mittels SetChannelLEDStatusConfig() eingestellt werden.

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

Für config:

• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_OFF = 0
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_ON = 1
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Function BrickletIndustrialDualAnalogInV2.GetChannelLEDConfig(ByVal channel As Byte) As Byte¶

Parameter:	channel – Typ: Byte, Wertebereich: [0 bis 1]
Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Kanal-LED-Konfiguration zurück, wie von SetChannelLEDConfig() gesetzt.

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

Für config:

• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_OFF = 0
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_ON = 1
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Sub BrickletIndustrialDualAnalogInV2.SetChannelLEDStatusConfig(ByVal channel As Byte, ByVal min As Integer, ByVal max As Integer, ByVal config As Byte)¶

Parameter:	channel – Typ: Byte, Wertebereich: [0 bis 1] min – Typ: Integer, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 10000 config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Kanal-LED auf Kanalstatus eingestellt ist, siehe SetChannelLEDConfig().

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10V wird die LED eingeschaltet sobald die gemessene Spannung über 10V steigt und wieder ausgeschaltet sobald der Strom unter 10V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald die gemessene Spannung unter 10V fällt und wieder ausgeschaltet sobald der Strom über 10V steigt.

Im Intensitätsmodus kann ein Bereich in mV angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4V und max=20V: Die LED ist bei 4V und darunter aus, bei 20V und darüber an und zwischen 4V und 20V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Sub BrickletIndustrialDualAnalogInV2.GetChannelLEDStatusConfig(ByVal channel As Byte, ByRef min As Integer, ByRef max As Integer, ByRef config As Byte)¶

Parameter:	channel – Typ: Byte, Wertebereich: [0 bis 1]
Ausgabeparameter:	min – Typ: Integer, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 10000 config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt die Kanal-LED-Status-Konfiguration zurück, wie von SetChannelLEDStatusConfig() gesetzt.

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

Für config:

• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen¶

Sub BrickletIndustrialDualAnalogInV2.SetSampleRate(ByVal rate As Byte)¶

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

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.

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

Für rate:

• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_976_SPS = 0
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_488_SPS = 1
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_244_SPS = 2
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_122_SPS = 3
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_61_SPS = 4
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_4_SPS = 5
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_2_SPS = 6
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_1_SPS = 7

Function BrickletIndustrialDualAnalogInV2.GetSampleRate() As Byte¶

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

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

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

Für rate:

• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_976_SPS = 0
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_488_SPS = 1
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_244_SPS = 2
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_122_SPS = 3
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_61_SPS = 4
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_4_SPS = 5
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_2_SPS = 6
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_1_SPS = 7

Sub BrickletIndustrialDualAnalogInV2.SetCalibration(ByVal offset() As Integer, ByVal gain() As Integer)¶

Parameter:	offset – Typ: Integer Array, Länge: 2, Wertebereich: [-223 bis 223 - 1] gain – Typ: Integer Array, Länge: 2, Wertebereich: [-223 bis 223 - 1]

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

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

Sub BrickletIndustrialDualAnalogInV2.GetCalibration(ByRef offset() As Integer, ByRef gain() As Integer)¶

Ausgabeparameter:	offset – Typ: Integer Array, Länge: 2, Wertebereich: [-223 bis 223 - 1] gain – Typ: Integer Array, Länge: 2, Wertebereich: [-223 bis 223 - 1]

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

Function BrickletIndustrialDualAnalogInV2.GetADCValues() As Integer()¶

Rückgabe:	value – Typ: Integer Array, Länge: 2, Wertebereich: [-223 bis 223 - 1]

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

Function BrickletIndustrialDualAnalogInV2.GetAllVoltages() As Integer()¶

Rückgabe:	voltages – Typ: Integer Array, Länge: 2, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Gibt die Spannung aller Kanäle zurück.

Wenn der Wert periodisch benötigt wird, kann auch der AllVoltagesCallback Callback verwendet werden. Der Callback wird mit der Funktion SetAllVoltagesCallbackConfiguration() konfiguriert.

Neu in Version 2.0.6 (Plugin).

Sub BrickletIndustrialDualAnalogInV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Ausgabeparameter:	errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

• ACK-Checksummen Fehler,
• Message-Checksummen Fehler,
• Framing Fehler und
• Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Sub BrickletIndustrialDualAnalogInV2.SetStatusLEDConfig(ByVal config As Byte)¶

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

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletIndustrialDualAnalogInV2.GetStatusLEDConfig() As Byte¶

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

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

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

Für config:

• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletIndustrialDualAnalogInV2.GetChipTemperature() As Short¶

Rückgabe:	temperature – Typ: Short, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

Sub BrickletIndustrialDualAnalogInV2.Reset()¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

Sub BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.SetVoltageCallbackConfiguration(ByVal channel As Byte, ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)¶

Parameter:

channel – Typ: Byte, Wertebereich: [0 bis 1] period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: Boolean, Standardwert: false option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der VoltageCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den VoltageCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

Sub BrickletIndustrialDualAnalogInV2.GetVoltageCallbackConfiguration(ByVal channel As Byte, ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)¶

Parameter:	channel – Typ: Byte, Wertebereich: [0 bis 1]
Ausgabeparameter:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: Boolean, Standardwert: false option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"C min – Typ: Integer, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Integer, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels SetVoltageCallbackConfiguration() gesetzt.

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

Für option:

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

Sub BrickletIndustrialDualAnalogInV2.SetAllVoltagesCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

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

Die Periode ist die Periode mit der der AllVoltagesCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Neu in Version 2.0.6 (Plugin).

Sub BrickletIndustrialDualAnalogInV2.GetAllVoltagesCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

Ausgabeparameter:	period – Typ: Long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: Boolean, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels SetAllVoltagesCallbackConfiguration() gesetzt.

Neu in Version 2.0.6 (Plugin).

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

AddHandler industrialDualAnalogInV2.ExampleCallback, AddressOf MyCallback

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

Event BrickletIndustrialDualAnalogInV2.VoltageCallback(ByVal sender As BrickletIndustrialDualAnalogInV2, ByVal channel As Byte, ByVal voltage As Integer)¶

Callback-Parameter:	sender – Typ: BrickletIndustrialDualAnalogInV2 channel – Typ: Byte, Wertebereich: [0 bis 1] voltage – Typ: Integer, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetVoltageCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie GetVoltage().

Event BrickletIndustrialDualAnalogInV2.AllVoltagesCallback(ByVal sender As BrickletIndustrialDualAnalogInV2, ByVal voltages() As Integer)¶

Callback-Parameter:	sender – Typ: BrickletIndustrialDualAnalogInV2 voltages – Typ: Integer Array, Länge: 2, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAllVoltagesCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der gleiche wie GetAllVoltages().

Neu in Version 2.0.6 (Plugin).

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

• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_SAMPLE_RATE = 5
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CALIBRATION = 7
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 10
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDualAnalogInV2.FUNCTION_RESET = 243
• BrickletIndustrialDualAnalogInV2.FUNCTION_WRITE_UID = 248

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

• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_SAMPLE_RATE = 5
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CALIBRATION = 7
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 10
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDualAnalogInV2.FUNCTION_RESET = 243
• BrickletIndustrialDualAnalogInV2.FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

Function BrickletIndustrialDualAnalogInV2.SetBootloaderMode(ByVal mode As Byte) As Byte¶

Parameter:	mode – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: Byte, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_OK = 0
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletIndustrialDualAnalogInV2.GetBootloaderMode() As Byte¶

Rückgabe:	mode – Typ: Byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

Für mode:

• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletIndustrialDualAnalogInV2.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameter:	pointer – Typ: Long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Function BrickletIndustrialDualAnalogInV2.WriteFirmware(ByVal data() As Byte) As Byte¶

Parameter:	data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: Byte, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Sub BrickletIndustrialDualAnalogInV2.WriteUID(ByVal uid As Long)¶

Parameter:	uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

Function BrickletIndustrialDualAnalogInV2.ReadUID() As Long¶

Rückgabe:	uid – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

Const BrickletIndustrialDualAnalogInV2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Dual Analog In 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 BrickletIndustrialDualAnalogInV2.DEVICE_DISPLAY_NAME¶

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