Visual Basic .NET - Load Cell Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Load Cell Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Load Cell Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Load Cell Bricklet

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

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

        ' Get current weight
        Dim weight As Integer = lc.GetWeight()
        Console.WriteLine("Weight: " + weight.ToString() + " g")

        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
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 Load Cell Bricklet

    ' Callback subroutine for weight callback
    Sub WeightCB(ByVal sender As BrickletLoadCell, ByVal weight As Integer)
        Console.WriteLine("Weight: " + weight.ToString() + " g")
    End Sub

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

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

        ' Register weight callback to subroutine WeightCB
        AddHandler lc.WeightCallback, AddressOf WeightCB

        ' Set period for weight callback to 1s (1000ms)
        ' Note: The weight callback is only called every second
        '       if the weight has changed since the last call!
        lc.SetWeightCallbackPeriod(1000)

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

Threshold

Download (ExampleThreshold.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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 Load Cell Bricklet

    ' Callback subroutine for weight reached callback
    Sub WeightReachedCB(ByVal sender As BrickletLoadCell, ByVal weight As Integer)
        Console.WriteLine("Weight: " + weight.ToString() + " g")
    End Sub

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

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

        ' Get threshold callbacks with a debounce time of 1 second (1000ms)
        lc.SetDebouncePeriod(1000)

        ' Register weight reached callback to subroutine WeightReachedCB
        AddHandler lc.WeightReachedCallback, AddressOf WeightReachedCB

        ' Configure threshold for weight "greater than 200 g"
        lc.SetWeightCallbackThreshold(">"C, 200, 0)

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

API

Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

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

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

Dim loadCell As New BrickletLoadCell("YOUR_DEVICE_UID", ipcon)

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

Function BrickletLoadCell.GetWeight() As Integer

Gibt das aktuell gemessene Gewicht in Gramm zurück.

Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen den WeightCallback Callback zu nutzen und die Periode mit SetWeightCallbackPeriod() vorzugeben.

Sub BrickletLoadCell.LEDOn()

Aktiviert die LED.

Sub BrickletLoadCell.LEDOff()

Deaktiviert die LED.

Function BrickletLoadCell.IsLEDOn() As Boolean

Gibt true zurück wenn die LED aktiviert ist, false sonst.

Sub BrickletLoadCell.Tare()

Setzt das aktuell gemessene Gewicht als Leergewicht.

Fortgeschrittene Funktionen

Sub BrickletLoadCell.SetMovingAverage(ByVal average As Byte)

Setzt die Länge eines gleitenden Mittelwerts für den Gewichtswert.

Wenn die Länge auf 1 gesetzt wird, ist das Averaging aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-40.

Der Standardwert ist 4.

Function BrickletLoadCell.GetMovingAverage() As Byte

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage() gesetzt.

Sub BrickletLoadCell.Calibrate(ByVal weight As Long)

Zum Kalibrieren des Load Cell Bricklet müssen die folgenden zwei Schritte durchgeführt werden:

  • Die Waage leeren und die Funktion mit 0 aufrufen.
  • Eine bekanntes Gewicht auf die Waage legen und die Funktion mit dem Gewicht in Gramm aufrufen.

Die Kalibrierung wird auf dem EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

Wir empfehlen die Kalibrierung über den Brick Viewer zu setzen, diese Funktion muss nicht im Quelltext genutzt werden.

Sub BrickletLoadCell.SetConfiguration(ByVal rate As Byte, ByVal gain As Byte)

Für die Messungen sind Rate und Gain konfigurierbar.

Die Rate kann auf 10Hz oder 80Hz gesetzt werden. Eine schnellere Rate erzeugt mehr Störungen. Zusätzlich ist es möglich einen gleitenden Mittelwert auf die Werte anzuwenden (siehe SetMovingAverage()).

Der Gain kann zwischen 128x, 64x und 32x konfiguriert werden. Er repräsentiert einen Messbereich von ±20mV, ±40mV und ±80mV respektive. Das Load Cell Bricklet nutzt eine Erregerspannung (Excitation Voltage) von 5V und die meisten Wägezellen haben eine Ausgabe von 2mV/V. Dies bedeutet, der Spannungsbereich ist ±15mV für die meisten Wägezellen (d.h. ein Gain von 128x ist am geeignetsten). Falls nicht klar ist was dies alles bedeutet, ein Gain von 128x ist höchstwahrscheinlich korrekt.

Die Konfiguration wird auf dem EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

Wir empfehlen die Konfiguration über den Brick Viewer zu setzen, diese Funktion muss nicht im Quelltext genutzt werden.

Die Standardwerte sind 10Hz für die Rate und 128x für den Gain.

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

  • BrickletLoadCell.RATE_10HZ = 0
  • BrickletLoadCell.RATE_80HZ = 1
  • BrickletLoadCell.GAIN_128X = 0
  • BrickletLoadCell.GAIN_64X = 1
  • BrickletLoadCell.GAIN_32X = 2
Sub BrickletLoadCell.GetConfiguration(ByRef rate As Byte, ByRef gain As Byte)

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

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

  • BrickletLoadCell.RATE_10HZ = 0
  • BrickletLoadCell.RATE_80HZ = 1
  • BrickletLoadCell.GAIN_128X = 0
  • BrickletLoadCell.GAIN_64X = 1
  • BrickletLoadCell.GAIN_32X = 2
Function BrickletLoadCell.GetAPIVersion() As Byte()

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

Function BrickletLoadCell.GetResponseExpected(ByVal functionId As Byte) As Boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletLoadCell.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_PERIOD = 2
  • BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_THRESHOLD = 4
  • BrickletLoadCell.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletLoadCell.FUNCTION_SET_MOVING_AVERAGE = 8
  • BrickletLoadCell.FUNCTION_LED_ON = 10
  • BrickletLoadCell.FUNCTION_LED_OFF = 11
  • BrickletLoadCell.FUNCTION_CALIBRATE = 13
  • BrickletLoadCell.FUNCTION_TARE = 14
  • BrickletLoadCell.FUNCTION_SET_CONFIGURATION = 15
Sub BrickletLoadCell.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletLoadCell.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

Sub BrickletLoadCell.SetWeightCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms mit welcher der WeightCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der WeightCallback Callback wird nur ausgelöst, wenn sich das Gewicht seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

Function BrickletLoadCell.GetWeightCallbackPeriod() As Long

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

Sub BrickletLoadCell.SetWeightCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Setzt den Schwellwert für den WeightReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

  • BrickletLoadCell.THRESHOLD_OPTION_OFF = "x"C
  • BrickletLoadCell.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletLoadCell.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletLoadCell.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletLoadCell.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletLoadCell.GetWeightCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

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

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

Function BrickletLoadCell.GetDebouncePeriod() As Long

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletLoadCell, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler loadCell.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 BrickletLoadCell.WeightCallback(ByVal sender As BrickletLoadCell, ByVal weight As Integer)

Dieser Callback wird mit der Periode, wie gesetzt mit SetWeightCallbackPeriod(), ausgelöst. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.

Der WeightCallback Callback wird nur ausgelöst, wenn sich das Gewicht seit der letzten Auslösung geändert hat.

Event BrickletLoadCell.WeightReachedCallback(ByVal sender As BrickletLoadCell, ByVal weight As Integer)

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetWeightCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.

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

Konstanten

Const BrickletLoadCell.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Load Cell 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 BrickletLoadCell.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet dar.