Visual Basic .NET - Industrial Digital In 4 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
25
26
27
28

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 Digital In 4 Bricklet 2.0

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

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

        ' Get current value
        Dim value As Boolean() = idi4.GetValue()

        Console.WriteLine("Channel 0: " + value(0).ToString())
        Console.WriteLine("Channel 1: " + value(1).ToString())
        Console.WriteLine("Channel 2: " + value(2).ToString())
        Console.WriteLine("Channel 3: " + value(3).ToString())

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

Edge Count¶

Download (ExampleEdgeCount.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 System.Threading
Imports Tinkerforge

Module ExampleEdgeCount
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

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

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

        ' Configure rising edge count (channel 3) with 10ms debounce
        idi4.SetEdgeCountConfiguration(3, 0, 10)

        ' Get edge count 10 times with 1s delay
        Dim i As Integer
        For i = 0 To 9
            Thread.Sleep(1000)

            ' Get current edge count
            Dim count As Long = idi4.GetEdgeCount(3, False)
            Console.WriteLine("Count: " + count.ToString())
        Next i

        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
37
38
39
40
41
42
43
44

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 Digital In 4 Bricklet 2.0

    ' Callback subroutine for value callback
    Sub ValueCB(ByVal sender As BrickletIndustrialDigitalIn4V2, ByVal channel As Byte, _
                ByVal changed As Boolean, ByVal value As Boolean)
        If channel = BrickletIndustrialDigitalIn4V2.CHANNEL_0 Then
            Console.WriteLine("Channel: 0")
        Else If channel = BrickletIndustrialDigitalIn4V2.CHANNEL_1 Then
            Console.WriteLine("Channel: 1")
        Else If channel = BrickletIndustrialDigitalIn4V2.CHANNEL_2 Then
            Console.WriteLine("Channel: 2")
        Else If channel = BrickletIndustrialDigitalIn4V2.CHANNEL_3 Then
            Console.WriteLine("Channel: 3")
        End If

        Console.WriteLine("Changed: " + changed.ToString())
        Console.WriteLine("Value: " + value.ToString())
        Console.WriteLine("")
    End Sub

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

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

        ' Register value callback to subroutine ValueCB
        AddHandler idi4.ValueCallback, AddressOf ValueCB

        ' Set period for value (channel 1) callback to 0.1s (100ms)
        idi4.SetValueCallbackConfiguration(1, 100, False)

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

Grundfunktionen¶

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

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

Dim industrialDigitalIn4V2 As New BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletIndustrialDigitalIn4V2.GetValue() As Boolean()¶

Rückgabe:	value – Typ: Boolean Array, Länge: 4

Gibt die Eingangswerte als Bools zurück, true bedeutet logisch 1 und false logisch 0.

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

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten 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 ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

Für channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Für config:

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

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

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten
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 channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Für config:

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

Fortgeschrittene Funktionen¶

Function BrickletIndustrialDigitalIn4V2.GetEdgeCount(ByVal channel As Byte, ByVal resetCounter As Boolean) As Long¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten resetCounter – Typ: Boolean
Rückgabe:	count – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Kanal zurück. Die zu zählenden Flanken können mit SetEdgeCountConfiguration() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

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

Für channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Sub BrickletIndustrialDigitalIn4V2.SetEdgeCountConfiguration(ByVal channel As Byte, ByVal edgeType As Byte, ByVal debounce As Byte)¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten edgeType – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: Byte, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

• 0 = steigend
• 1 = fallend
• 2 = beide

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Für edgeType:

• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2

Sub BrickletIndustrialDigitalIn4V2.GetEdgeCountConfiguration(ByVal channel As Byte, ByRef edgeType As Byte, ByRef debounce As Byte)¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:	edgeType – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: Byte, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanals zurück, wie von SetEdgeCountConfiguration() gesetzt.

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

Für channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Für edgeType:

• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2

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

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

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

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

Function BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.SetValueCallbackConfiguration(ByVal channel As Byte, ByVal period As Long, ByVal valueHasToChange As Boolean)¶

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

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der ValueCallback 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.

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

Für channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Sub BrickletIndustrialDigitalIn4V2.GetValueCallbackConfiguration(ByVal channel As Byte, ByRef period As Long, ByRef valueHasToChange As Boolean)¶

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

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels SetValueCallbackConfiguration() gesetzt.

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

Für channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Sub BrickletIndustrialDigitalIn4V2.SetAllValueCallbackConfiguration(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 AllValueCallback 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.

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

AddHandler industrialDigitalIn4V2.ExampleCallback, AddressOf MyCallback

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

Event BrickletIndustrialDigitalIn4V2.ValueCallback(ByVal sender As BrickletIndustrialDigitalIn4V2, ByVal channel As Byte, ByVal changed As Boolean, ByVal value As Boolean)¶

Callback-Parameter:	sender – Typ: BrickletIndustrialDigitalIn4V2 channel – Typ: Byte, Wertebereich: Siehe Konstanten changed – Typ: Boolean value – Typ: Boolean

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

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

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

Für channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

Event BrickletIndustrialDigitalIn4V2.AllValueCallback(ByVal sender As BrickletIndustrialDigitalIn4V2, ByVal changed() As Boolean, ByVal value() As Boolean)¶

Callback-Parameter:	sender – Typ: BrickletIndustrialDigitalIn4V2 changed – Typ: Boolean Array, Länge: 4 value – Typ: Boolean Array, Länge: 4

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

Die Parameter sind der gleiche wie GetValue(). Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

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

• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
• BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248

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

• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
• BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248

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

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

Für status:

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

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

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

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

Diese Konstante wird verwendet um ein Industrial Digital In 4 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 BrickletIndustrialDigitalIn4V2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial Digital In 4 Bricklet 2.0 dar.