MQTT - Load Cell Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

1
2
3
4
5
6
# Change XYZ to the UID of your Load Cell Bricklet

setup:
    # Get current weight
    subscribe to tinkerforge/response/load_cell_bricklet/XYZ/get_weight
    publish '' to tinkerforge/request/load_cell_bricklet/XYZ/get_weight

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Load Cell Bricklet

setup:
    # Handle incoming weight callbacks
    subscribe to tinkerforge/callback/load_cell_bricklet/XYZ/weight
    publish '{"register": true}' to tinkerforge/register/load_cell_bricklet/XYZ/weight # Register weight callback

    # 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!
    publish '{"period": 1000}' to tinkerforge/request/load_cell_bricklet/XYZ/set_weight_callback_period

Threshold

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Change XYZ to the UID of your Load Cell Bricklet

setup:
    # Get threshold callbacks with a debounce time of 1 second (1000ms)
    publish '{"debounce": 1000}' to tinkerforge/request/load-cell_bricklet/XYZ/set_debounce_period

    # Handle incoming weight reached callbacks
    subscribe to tinkerforge/callback/load_cell_bricklet/XYZ/weight_reached
    publish '{"register": true}' to tinkerforge/register/load_cell_bricklet/XYZ/weight_reached # Register weight_reached callback

    # Configure threshold for weight "greater than 200 g"
    publish '{"option": "greater", "min": 200, "max": 0}' to tinkerforge/request/load_cell_bricklet/XYZ/set_weight_callback_threshold

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/load_cell_bricklet/<UID>/get_weight
Anfrage:
  • keine Nutzdaten
Antwort:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]

Gibt das aktuell gemessene Gewicht zurück.

Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen den register/load_cell_bricklet/<UID>/weight Callback zu nutzen und die Periode mit request/load_cell_bricklet/<UID>/set_weight_callback_period vorzugeben.

request/load_cell_bricklet/<UID>/led_on
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert die LED.

request/load_cell_bricklet/<UID>/led_off
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert die LED.

request/load_cell_bricklet/<UID>/is_led_on
Anfrage:
  • keine Nutzdaten
Antwort:
  • on – Typ: bool, Standardwert: false

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

request/load_cell_bricklet/<UID>/tare
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Setzt das aktuell gemessene Gewicht als Leergewicht.

Fortgeschrittene Funktionen

request/load_cell_bricklet/<UID>/set_moving_average
Anfrage:
  • average – Typ: int, Wertebereich: [1 bis 40], Standardwert: 4
Antwort:
  • keine Antwort

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.

request/load_cell_bricklet/<UID>/get_moving_average
Anfrage:
  • keine Nutzdaten
Antwort:
  • average – Typ: int, Wertebereich: [1 bis 40], Standardwert: 4

Gibt die Länge des gleitenden Mittelwerts zurück, wie von request/load_cell_bricklet/<UID>/set_moving_average gesetzt.

request/load_cell_bricklet/<UID>/calibrate
Anfrage:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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

request/load_cell_bricklet/<UID>/set_configuration
Anfrage:
  • rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • gain – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:
  • keine Antwort

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 request/load_cell_bricklet/<UID>/set_moving_average).

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

Für rate:

  • "10hz" = 0
  • "80hz" = 1

Für gain:

  • "128x" = 0
  • "64x" = 1
  • "32x" = 2
request/load_cell_bricklet/<UID>/get_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
  • gain – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von request/load_cell_bricklet/<UID>/set_configuration gesetzt.

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

Für rate:

  • "10hz" = 0
  • "80hz" = 1

Für gain:

  • "128x" = 0
  • "64x" = 1
  • "32x" = 2
request/load_cell_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Load Cell.

Konfigurationsfunktionen für Callbacks

request/load_cell_bricklet/<UID>/set_weight_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/load_cell_bricklet/<UID>/weight Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/load_cell_bricklet/<UID>/weight Callback wird nur ausgelöst, wenn sich das Gewicht seit der letzten Auslösung geändert hat.

request/load_cell_bricklet/<UID>/get_weight_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/load_cell_bricklet/<UID>/set_weight_callback_period gesetzt.

request/load_cell_bricklet/<UID>/set_weight_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, 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
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/load_cell_bricklet/<UID>/weight_reached 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)

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/load_cell_bricklet/<UID>/get_weight_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, 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 den Schwellwert zurück, wie von request/load_cell_bricklet/<UID>/set_weight_callback_threshold gesetzt.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/load_cell_bricklet/<UID>/set_debounce_period
Anfrage:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

request/load_cell_bricklet/<UID>/get_debounce_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/load_cell_bricklet/<UID>/set_debounce_period gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/load_cell_bricklet/<UID>/weight
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/load_cell_bricklet/<UID>/weight[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/load_cell_bricklet/<UID>/weight[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/load_cell_bricklet/<UID>/set_weight_callback_period, ausgelöst. Der Payload des Callbacks ist das Gewicht wie von der Wägezelle gemessen.

Der register/load_cell_bricklet/<UID>/weight Callback wird nur ausgelöst, wenn sich das Gewicht seit der letzten Auslösung geändert hat.

register/load_cell_bricklet/<UID>/weight_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/load_cell_bricklet/<UID>/weight_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/load_cell_bricklet/<UID>/weight_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/load_cell_bricklet/<UID>/set_weight_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist das Gewicht wie von der Wägezelle gemessen.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/load_cell_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.