Java - Load Cell Bricklet

Dies ist die Beschreibung der Java 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 Java API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLoadCell;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Load Cell Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLoadCell lc = 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
        int weight = lc.getWeight(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Weight: " + weight + " g");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback

Download (ExampleCallback.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLoadCell;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Load Cell Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLoadCell lc = new BrickletLoadCell(UID, ipcon); // Create device object

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

        // Add weight listener
        lc.addWeightListener(new BrickletLoadCell.WeightListener() {
            public void weight(int weight) {
                System.out.println("Weight: " + weight + " g");
            }
        });

        // 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);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Threshold

Download (ExampleThreshold.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLoadCell;

public class ExampleThreshold {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Load Cell Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletLoadCell lc = 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);

        // Add weight reached listener
        lc.addWeightReachedListener(new BrickletLoadCell.WeightReachedListener() {
            public void weightReached(int weight) {
                System.out.println("Weight: " + weight + " g");
            }
        });

        // Configure threshold for weight "greater than 200 g"
        lc.setWeightCallbackThreshold('>', 200, 0);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API

Prinzipiell kann jede Methode der Java Bindings eine 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.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

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

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

BrickletLoadCell loadCell = new BrickletLoadCell("YOUR_DEVICE_UID", ipcon);

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

int BrickletLoadCell.getWeight()
Rückgabe:
  • weight – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt das aktuell gemessene Gewicht in Gramm zurück.

Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen den WeightListener Listener zu nutzen und die Periode mit setWeightCallbackPeriod() vorzugeben.

void BrickletLoadCell.ledOn()

Aktiviert die LED.

void BrickletLoadCell.ledOff()

Deaktiviert die LED.

boolean BrickletLoadCell.isLEDOn()
Rückgabe:
  • on – Typ: boolean

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

void BrickletLoadCell.tare()

Setzt das aktuell gemessene Gewicht als Leergewicht.

Fortgeschrittene Funktionen

void BrickletLoadCell.setMovingAverage(short average)
Parameter:
  • average – Typ: short, Wertebereich: [0 bis 255]

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.

short BrickletLoadCell.getMovingAverage()
Rückgabe:
  • average – Typ: short, Wertebereich: [0 bis 255]

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

void BrickletLoadCell.calibrate(long weight)
Parameter:
  • weight – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

void BrickletLoadCell.setConfiguration(short rate, short gain)
Parameter:
  • rate – Typ: short, Wertebereich: Siehe Konstanten
  • gain – Typ: short, Wertebereich: Siehe Konstanten

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:

Für rate:

  • BrickletLoadCell.RATE_10HZ = 0
  • BrickletLoadCell.RATE_80HZ = 1

Für gain:

  • BrickletLoadCell.GAIN_128X = 0
  • BrickletLoadCell.GAIN_64X = 1
  • BrickletLoadCell.GAIN_32X = 2
BrickletLoadCell.Configuration BrickletLoadCell.getConfiguration()
Rückgabeobjekt:
  • rate – Typ: short, Wertebereich: Siehe Konstanten
  • gain – Typ: short, Wertebereich: Siehe Konstanten

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

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

Für rate:

  • BrickletLoadCell.RATE_10HZ = 0
  • BrickletLoadCell.RATE_80HZ = 1

Für gain:

  • BrickletLoadCell.GAIN_128X = 0
  • BrickletLoadCell.GAIN_64X = 1
  • BrickletLoadCell.GAIN_32X = 2
short[] BrickletLoadCell.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]

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.

boolean BrickletLoadCell.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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 Listeners 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:

  • 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
void BrickletLoadCell.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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 Listeners (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:

  • 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
void BrickletLoadCell.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

BrickletLoadCell.Identity BrickletLoadCell.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3, 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 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 Listener

void BrickletLoadCell.setWeightCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der WeightListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

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

long BrickletLoadCell.getWeightCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletLoadCell.setWeightCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Setzt den Schwellwert für den WeightReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn das Gewicht außerhalb des min und max Wertes ist
'i' Listener wird ausgelöst, wenn das Gewicht innerhalb des min und max Wertes ist
'<' Listener wird ausgelöst, wenn das Gewicht kleiner als der min Wert ist (max wird ignoriert)
'>' Listener 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:

Für option:

  • BrickletLoadCell.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLoadCell.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLoadCell.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLoadCell.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLoadCell.THRESHOLD_OPTION_GREATER = '>'
BrickletLoadCell.WeightCallbackThreshold BrickletLoadCell.getWeightCallbackThreshold()
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

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

Für option:

  • BrickletLoadCell.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLoadCell.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLoadCell.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLoadCell.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLoadCell.THRESHOLD_OPTION_GREATER = '>'
void BrickletLoadCell.setDebouncePeriod(long debounce)
Parameter:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Listener

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

long BrickletLoadCell.getDebouncePeriod()
Rückgabe:
  • debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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

Listener

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickletLoadCell.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

Bemerkung

Listener 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.

class BrickletLoadCell.WeightListener()

Dieser Listener kann mit der Funktion addWeightListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeWeightListener() wieder entfernt werden.

void weight(int weight)
Parameter:
  • weight – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

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

class BrickletLoadCell.WeightReachedListener()

Dieser Listener kann mit der Funktion addWeightReachedListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeWeightReachedListener() wieder entfernt werden.

void weightReached(int weight)
Parameter:
  • weight – Typ: int, Wertebereich: [-231 bis 231 - 1]

Dieser Listener 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 Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

int BrickletLoadCell.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Load Cell Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateListener Listener der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletLoadCell.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet dar.