Software / API Bindings / Visual Basic .NET / API Referenz und Beispiele / Bricklets / Industrial Counter Bricklet

Visual Basic .NET - Industrial Counter Bricklet¶

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

Callback¶

Download (ExampleCallback.vb)

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 Counter Bricklet

    ' Callback subroutine for all counter callback
    Sub AllCounterCB(ByVal sender As BrickletIndustrialCounter, ByVal counter As Long())
        Console.WriteLine("Counter (Channel 0): " + counter(0).ToString())
        Console.WriteLine("Counter (Channel 1): " + counter(1).ToString())
        Console.WriteLine("Counter (Channel 2): " + counter(2).ToString())
        Console.WriteLine("Counter (Channel 3): " + counter(3).ToString())
        Console.WriteLine("")
    End Sub

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

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

        ' Register all counter callback to subroutine AllCounterCB
        AddHandler ic.AllCounterCallback, AddressOf AllCounterCB

        ' Set period for all counter callback to 1s (1000ms)
        ic.SetAllCounterCallbackConfiguration(1000, True)

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

Simple¶

Download (ExampleSimple.vb)

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 Counter Bricklet

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

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

        ' Get current counter from channel 0
        Dim counter As Long = ic.GetCounter(BrickletIndustrialCounter.CHANNEL_0)
        Console.WriteLine("Counter (Channel 0): " + counter.ToString())

        ' Get current signal data from channel 0
        Dim dutyCycle As Integer
        Dim period, frequency As Long
        Dim value As Boolean

        ic.GetSignalData(BrickletIndustrialCounter.CHANNEL_0, dutyCycle, period, _
                         frequency, value)

        Console.WriteLine("Duty Cycle (Channel 0): " + (dutyCycle/100.0).ToString() + " %")
        Console.WriteLine("Period (Channel 0): " + period.ToString() + " ns")
        Console.WriteLine("Frequency (Channel 0): " + (frequency/1000.0).ToString() + " Hz")
        Console.WriteLine("Value (Channel 0): " + value.ToString())

        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.

Grundfunktionen¶

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

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

Dim industrialCounter As New BrickletIndustrialCounter("YOUR_DEVICE_UID", ipcon)

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

Function BrickletIndustrialCounter.GetCounter(ByVal channel As Byte) As Long¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	counter – Typ: Long, Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]

Gibt den aktuellen Zählerstand für den gegebenen Kanal zurück.

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

Für channel:

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Function BrickletIndustrialCounter.GetAllCounter() As Long()¶

Rückgabe:	counter – Typ: Long Array, Länge: 4, Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]

Gibt die Zählerstände für alle vier Kanäle zurück.

Sub BrickletIndustrialCounter.SetCounter(ByVal channel As Byte, ByVal counter As Long)¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten counter – Typ: Long, Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]

Setzt den Zählerstand für den gegebenen Kanal.

Der Standardwert für alle Zähler nach dem Start ist 0.

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

Für channel:

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Sub BrickletIndustrialCounter.SetAllCounter(ByVal counter() As Long)¶

Parameter:	counter – Typ: Long Array, Länge: 4, Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]

Setzt die Zählerstände für alle vier Kanäle.

Der Standardwert für die Zähler nach dem Starten ist 0.

Sub BrickletIndustrialCounter.GetSignalData(ByVal channel As Byte, ByRef dutyCycle As Integer, ByRef period As Long, ByRef frequency As Long, ByRef value As Boolean)¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:	dutyCycle – Typ: Integer, Einheit: 1/100 %, Wertebereich: [0 bis 10000] period – Typ: Long, Einheit: 1 ns, Wertebereich: [0 bis 2⁶⁴ - 1] frequency – Typ: Long, Einheit: 1/1000 Hz, Wertebereich: [0 bis 2³² - 1] value – Typ: Boolean

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für den gegebenen Kanal.

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

Für channel:

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Sub BrickletIndustrialCounter.GetAllSignalData(ByRef dutyCycle() As Integer, ByRef period() As Long, ByRef frequency() As Long, ByRef value() As Boolean)¶

Ausgabeparameter:	dutyCycle – Typ: Integer Array, Länge: 4, Einheit: 1/100 %, Wertebereich: [0 bis 10000] period – Typ: Long Array, Länge: 4, Einheit: 1 ns, Wertebereich: [0 bis 2⁶⁴ - 1] frequency – Typ: Long Array, Länge: 4, Einheit: 1/1000 Hz, Wertebereich: [0 bis 2³² - 1] value – Typ: Boolean Array, Länge: 4

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für alle vier Kanäle zurück.

Sub BrickletIndustrialCounter.SetCounterActive(ByVal channel As Byte, ByVal active As Boolean)¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten active – Typ: Boolean, Standardwert: true

Aktiviert/Deaktiviert den Zähler für den gegebenen Kanal.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

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

Für channel:

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Sub BrickletIndustrialCounter.SetAllCounterActive(ByVal active() As Boolean)¶

Parameter:	active – Typ: Boolean Array, Länge: 4, Standardwert: {true, true, true, true}

Aktiviert/Deaktiviert den Zähler für alle vier Kanäle.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

Function BrickletIndustrialCounter.GetCounterActive(ByVal channel As Byte) As Boolean¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	active – Typ: Boolean, Standardwert: true

Gibt den Zustand (aktiviert/deaktiviert) des gegebenen Zähler zurück.

true = aktiviert, false = deaktiviert.

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

Für channel:

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Function BrickletIndustrialCounter.GetAllCounterActive() As Boolean()¶

Rückgabe:	active – Typ: Boolean Array, Länge: 4, Standardwert: {true, true, true, true}

Gibt den Zustand (aktiviert/deaktiviert) aller vier Zähler zurück.

true = aktiviert, false = deaktiviert.

Sub BrickletIndustrialCounter.SetCounterConfiguration(ByVal channel As Byte, ByVal countEdge As Byte, ByVal countDirection As Byte, ByVal dutyCyclePrescaler As Byte, ByVal frequencyIntegrationTime As Byte)¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten countEdge – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 countDirection – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 dutyCyclePrescaler – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 frequencyIntegrationTime – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Zähler-Konfiguration für den gegebenen Kanal.

Zählflanke: Der Zähler kann bei der steigenden, fallenden oder beiden Flanken zählen.
Zählrichtung: Der Zähler kann hoch- oder runterzählen. Es kann auch ein weiterer Kanal als Richtungseingang genutzt werden. Siehe hier für weitere Details.
Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details.
Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details.

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

Für channel:

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Für countEdge:

BrickletIndustrialCounter.COUNT_EDGE_RISING = 0
BrickletIndustrialCounter.COUNT_EDGE_FALLING = 1
BrickletIndustrialCounter.COUNT_EDGE_BOTH = 2

Für countDirection:

BrickletIndustrialCounter.COUNT_DIRECTION_UP = 0
BrickletIndustrialCounter.COUNT_DIRECTION_DOWN = 1
BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_UP = 2
BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für dutyCyclePrescaler:

BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1 = 0
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2 = 1
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4 = 2
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8 = 3
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16 = 4
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32 = 5
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_64 = 6
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_128 = 7
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_256 = 8
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_512 = 9
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1024 = 10
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2048 = 11
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4096 = 12
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8192 = 13
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16384 = 14
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32768 = 15

Für frequencyIntegrationTime:

BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_128_MS = 0
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_256_MS = 1
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_512_MS = 2
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_1024_MS = 3
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_2048_MS = 4
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_4096_MS = 5
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_8192_MS = 6
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_16384_MS = 7
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_32768_MS = 8

Sub BrickletIndustrialCounter.GetCounterConfiguration(ByVal channel As Byte, ByRef countEdge As Byte, ByRef countDirection As Byte, ByRef dutyCyclePrescaler As Byte, ByRef frequencyIntegrationTime As Byte)¶

Parameter:	channel – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:	countEdge – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 countDirection – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 dutyCyclePrescaler – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 frequencyIntegrationTime – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Zähler-Konfiguration zurück, wie Sie mittels SetCounterConfiguration() gesetzt wurde.

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

Für channel:

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Für countEdge:

BrickletIndustrialCounter.COUNT_EDGE_RISING = 0
BrickletIndustrialCounter.COUNT_EDGE_FALLING = 1
BrickletIndustrialCounter.COUNT_EDGE_BOTH = 2

Für countDirection:

BrickletIndustrialCounter.COUNT_DIRECTION_UP = 0
BrickletIndustrialCounter.COUNT_DIRECTION_DOWN = 1
BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_UP = 2
BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für dutyCyclePrescaler:

BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1 = 0
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2 = 1
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4 = 2
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8 = 3
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16 = 4
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32 = 5
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_64 = 6
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_128 = 7
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_256 = 8
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_512 = 9
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1024 = 10
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2048 = 11
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4096 = 12
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8192 = 13
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16384 = 14
BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32768 = 15

Für frequencyIntegrationTime:

BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_128_MS = 0
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_256_MS = 1
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_512_MS = 2
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_1024_MS = 3
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_2048_MS = 4
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_4096_MS = 5
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_8192_MS = 6
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_16384_MS = 7
BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_32768_MS = 8

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

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

Für channel:

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Für config:

BrickletIndustrialCounter.CHANNEL_LED_CONFIG_OFF = 0
BrickletIndustrialCounter.CHANNEL_LED_CONFIG_ON = 1
BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

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

BrickletIndustrialCounter.CHANNEL_0 = 0
BrickletIndustrialCounter.CHANNEL_1 = 1
BrickletIndustrialCounter.CHANNEL_2 = 2
BrickletIndustrialCounter.CHANNEL_3 = 3

Für config:

BrickletIndustrialCounter.CHANNEL_LED_CONFIG_OFF = 0
BrickletIndustrialCounter.CHANNEL_LED_CONFIG_ON = 1
BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen¶

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

Ausgabeparameter:	errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: Long, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: Long, Wertebereich: [0 bis 2³² - 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 BrickletIndustrialCounter.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:

BrickletIndustrialCounter.STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialCounter.STATUS_LED_CONFIG_ON = 1
BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

BrickletIndustrialCounter.STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialCounter.STATUS_LED_CONFIG_ON = 1
BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletIndustrialCounter.GetChipTemperature() As Short¶

Rückgabe:	temperature – Typ: Short, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 BrickletIndustrialCounter.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 BrickletIndustrialCounter.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:

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 2¹⁶ - 1]

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 2¹⁶ - 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 BrickletIndustrialCounter.SetAllCounterCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

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

Die Periode ist die Periode mit der der AllCounterCallback 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 BrickletIndustrialCounter.GetAllCounterCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

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

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

Sub BrickletIndustrialCounter.SetAllSignalDataCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

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

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

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 BrickletIndustrialCounter.GetAllSignalDataCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

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

Gibt die Callback-Konfiguration zurück, wie mittels SetAllSignalDataCallbackConfiguration() 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 BrickletIndustrialCounter, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler industrialCounter.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 BrickletIndustrialCounter.AllCounterCallback(ByVal sender As BrickletIndustrialCounter, ByVal counter() As Long)¶

Callback-Parameter:	sender – Typ: BrickletIndustrialCounter counter – Typ: Long Array, Länge: 4, Wertebereich: [-2⁴⁷ bis 2⁴⁷ - 1]

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

Die Parameter sind der gleiche wie GetAllCounter().

Event BrickletIndustrialCounter.AllSignalDataCallback(ByVal sender As BrickletIndustrialCounter, ByVal dutyCycle() As Integer, ByVal period() As Long, ByVal frequency() As Long, ByVal value() As Boolean)¶

Callback-Parameter:	sender – Typ: BrickletIndustrialCounter dutyCycle – Typ: Integer Array, Länge: 4, Einheit: 1/100 %, Wertebereich: [0 bis 10000] period – Typ: Long Array, Länge: 4, Einheit: 1 ns, Wertebereich: [0 bis 2⁶⁴ - 1] frequency – Typ: Long Array, Länge: 4, Einheit: 1/1000 Hz, Wertebereich: [0 bis 2³² - 1] value – Typ: Boolean Array, Länge: 4

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

Die Parameter sind der gleiche wie GetAllSignalData().

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

BrickletIndustrialCounter.FUNCTION_SET_COUNTER = 3
BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER = 4
BrickletIndustrialCounter.FUNCTION_SET_COUNTER_ACTIVE = 7
BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
BrickletIndustrialCounter.FUNCTION_SET_COUNTER_CONFIGURATION = 11
BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
BrickletIndustrialCounter.FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
BrickletIndustrialCounter.FUNCTION_SET_CHANNEL_LED_CONFIG = 17
BrickletIndustrialCounter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialCounter.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialCounter.FUNCTION_RESET = 243
BrickletIndustrialCounter.FUNCTION_WRITE_UID = 248

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

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

Für functionId:

BrickletIndustrialCounter.FUNCTION_SET_COUNTER = 3
BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER = 4
BrickletIndustrialCounter.FUNCTION_SET_COUNTER_ACTIVE = 7
BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
BrickletIndustrialCounter.FUNCTION_SET_COUNTER_CONFIGURATION = 11
BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
BrickletIndustrialCounter.FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
BrickletIndustrialCounter.FUNCTION_SET_CHANNEL_LED_CONFIG = 17
BrickletIndustrialCounter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialCounter.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialCounter.FUNCTION_RESET = 243
BrickletIndustrialCounter.FUNCTION_WRITE_UID = 248

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

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

Für status:

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

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

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

Sub BrickletIndustrialCounter.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameter:	pointer – Typ: Long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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 BrickletIndustrialCounter.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 BrickletIndustrialCounter.WriteUID(ByVal uid As Long)¶

Parameter:	uid – Typ: Long, Wertebereich: [0 bis 2³² - 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 BrickletIndustrialCounter.ReadUID() As Long¶

Rückgabe:	uid – Typ: Long, Wertebereich: [0 bis 2³² - 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 BrickletIndustrialCounter.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Counter 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 BrickletIndustrialCounter.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Counter Bricklet dar.