C# - Load Cell Bricklet 2.0

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

Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Load Cell Bricklet 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLoadCellV2 lc = new BrickletLoadCellV2(UID, ipcon); // Create device object

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

        // Get current weight
        int weight = lc.GetWeight();
        Console.WriteLine("Weight: " + weight + " g");

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback

Download (ExampleCallback.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Load Cell Bricklet 2.0

    // Callback function for weight callback
    static void WeightCB(BrickletLoadCellV2 sender, int weight)
    {
        Console.WriteLine("Weight: " + weight + " g");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLoadCellV2 lc = new BrickletLoadCellV2(UID, ipcon); // Create device object

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

        // Register weight callback to function WeightCB
        lc.WeightCallback += WeightCB;

        // Set period for weight callback to 1s (1000ms) without a threshold
        lc.SetWeightCallbackConfiguration(1000, false, 'x', 0, 0);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Threshold

Download (ExampleThreshold.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Load Cell Bricklet 2.0

    // Callback function for weight callback
    static void WeightCB(BrickletLoadCellV2 sender, int weight)
    {
        Console.WriteLine("Weight: " + weight + " g");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLoadCellV2 lc = new BrickletLoadCellV2(UID, ipcon); // Create device object

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

        // Register weight callback to function WeightCB
        lc.WeightCallback += WeightCB;

        // Configure threshold for weight "greater than 200 g"
        // with a debounce period of 1s (1000ms)
        lc.SetWeightCallbackConfiguration(1000, false, '>', 200, 0);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletLoadCellV2(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • loadCellV2 – Typ: BrickletLoadCellV2

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

BrickletLoadCellV2 loadCellV2 = new BrickletLoadCellV2("YOUR_DEVICE_UID", ipcon);

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

int BrickletLoadCellV2.GetWeight()
Rückgabe:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]

Gibt das aktuell gemessene Gewicht zurück.

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

void BrickletLoadCellV2.SetInfoLEDConfig(byte config)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 2

Konfiguriert die Info-LED. Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.

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

Für config:

  • BrickletLoadCellV2.INFO_LED_CONFIG_OFF = 0
  • BrickletLoadCellV2.INFO_LED_CONFIG_ON = 1
  • BrickletLoadCellV2.INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
byte BrickletLoadCellV2.GetInfoLEDConfig()
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 2

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

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

Für config:

  • BrickletLoadCellV2.INFO_LED_CONFIG_OFF = 0
  • BrickletLoadCellV2.INFO_LED_CONFIG_ON = 1
  • BrickletLoadCellV2.INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
void BrickletLoadCellV2.Tare()

Setzt das aktuell gemessene Gewicht als Leergewicht.

Fortgeschrittene Funktionen

void BrickletLoadCellV2.SetMovingAverage(int average)
Parameter:
  • average – Typ: int, Wertebereich: [1 bis 100], Standardwert: 4

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.

int BrickletLoadCellV2.GetMovingAverage()
Rückgabe:
  • average – Typ: int, Wertebereich: [1 bis 100], Standardwert: 4

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

void BrickletLoadCellV2.Calibrate(long weight)
Parameter:
  • weight – Typ: long, Einheit: 1 g, Wertebereich: [0 bis 232 - 1]

Zum Kalibrieren des Load Cell Bricklet 2.0 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 aufrufen.

Die Kalibrierung wird auf dem Flash 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.

void BrickletLoadCellV2.SetConfiguration(byte rate, byte gain)
Parameter:
  • rate – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • gain – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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 folgenden Konstanten sind für diese Funktion verfügbar:

Für rate:

  • BrickletLoadCellV2.RATE_10HZ = 0
  • BrickletLoadCellV2.RATE_80HZ = 1

Für gain:

  • BrickletLoadCellV2.GAIN_128X = 0
  • BrickletLoadCellV2.GAIN_64X = 1
  • BrickletLoadCellV2.GAIN_32X = 2
void BrickletLoadCellV2.GetConfiguration(out byte rate, out byte gain)
Ausgabeparameter:
  • rate – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • gain – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für rate:

  • BrickletLoadCellV2.RATE_10HZ = 0
  • BrickletLoadCellV2.RATE_80HZ = 1

Für gain:

  • BrickletLoadCellV2.GAIN_128X = 0
  • BrickletLoadCellV2.GAIN_64X = 1
  • BrickletLoadCellV2.GAIN_32X = 2
byte[] BrickletLoadCellV2.GetAPIVersion()
Ausgabeparameter:
  • apiVersion – Typ: byte[], 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.

bool BrickletLoadCellV2.GetResponseExpected(byte functionId)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool

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:

  • BrickletLoadCellV2.FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION = 2
  • BrickletLoadCellV2.FUNCTION_SET_MOVING_AVERAGE = 5
  • BrickletLoadCellV2.FUNCTION_SET_INFO_LED_CONFIG = 7
  • BrickletLoadCellV2.FUNCTION_CALIBRATE = 9
  • BrickletLoadCellV2.FUNCTION_TARE = 10
  • BrickletLoadCellV2.FUNCTION_SET_CONFIGURATION = 11
  • BrickletLoadCellV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLoadCellV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLoadCellV2.FUNCTION_RESET = 243
  • BrickletLoadCellV2.FUNCTION_WRITE_UID = 248
void BrickletLoadCellV2.SetResponseExpected(byte functionId, bool responseExpected)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool

Ä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:

  • BrickletLoadCellV2.FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION = 2
  • BrickletLoadCellV2.FUNCTION_SET_MOVING_AVERAGE = 5
  • BrickletLoadCellV2.FUNCTION_SET_INFO_LED_CONFIG = 7
  • BrickletLoadCellV2.FUNCTION_CALIBRATE = 9
  • BrickletLoadCellV2.FUNCTION_TARE = 10
  • BrickletLoadCellV2.FUNCTION_SET_CONFIGURATION = 11
  • BrickletLoadCellV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletLoadCellV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletLoadCellV2.FUNCTION_RESET = 243
  • BrickletLoadCellV2.FUNCTION_WRITE_UID = 248
void BrickletLoadCellV2.SetResponseExpectedAll(bool responseExpected)
Parameter:
  • responseExpected – Typ: bool

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

void BrickletLoadCellV2.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)
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.

byte BrickletLoadCellV2.SetBootloaderMode(byte mode)
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:

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

Für status:

  • BrickletLoadCellV2.BOOTLOADER_STATUS_OK = 0
  • BrickletLoadCellV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletLoadCellV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletLoadCellV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletLoadCellV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletLoadCellV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
byte BrickletLoadCellV2.GetBootloaderMode()
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:

  • BrickletLoadCellV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletLoadCellV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletLoadCellV2.SetWriteFirmwarePointer(long pointer)
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.

byte BrickletLoadCellV2.WriteFirmware(byte[] data)
Parameter:
  • data – Typ: byte[], 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.

void BrickletLoadCellV2.SetStatusLEDConfig(byte config)
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:

  • BrickletLoadCellV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletLoadCellV2.STATUS_LED_CONFIG_ON = 1
  • BrickletLoadCellV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLoadCellV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
byte BrickletLoadCellV2.GetStatusLEDConfig()
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:

  • BrickletLoadCellV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletLoadCellV2.STATUS_LED_CONFIG_ON = 1
  • BrickletLoadCellV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletLoadCellV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
short BrickletLoadCellV2.GetChipTemperature()
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.

void BrickletLoadCellV2.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.

void BrickletLoadCellV2.WriteUID(long uid)
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.

long BrickletLoadCellV2.ReadUID()
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.

void BrickletLoadCellV2.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: byte[], 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[], 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: int, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

void BrickletLoadCellV2.SetWeightCallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der WeightCallback 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 WeightCallback 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:

  • BrickletLoadCellV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLoadCellV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLoadCellV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLoadCellV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLoadCellV2.THRESHOLD_OPTION_GREATER = '>'
void BrickletLoadCellV2.GetWeightCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)
Ausgabeparameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

  • BrickletLoadCellV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLoadCellV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLoadCellV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLoadCellV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLoadCellV2.THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletLoadCellV2 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

loadCellV2.ExampleCallback += MyCallback;

Die verfügbaren Events 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 BrickletLoadCellV2.WeightCallback(BrickletLoadCellV2 sender, int weight)
Callback-Parameter:
  • sender – Typ: BrickletLoadCellV2
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetWeight().

Konstanten

int BrickletLoadCellV2.DEVICE_IDENTIFIER

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

string BrickletLoadCellV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet 2.0 dar.