Ruby - Load Cell Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_load_cell'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Load Cell Bricklet

ipcon = IPConnection.new # Create IP connection
lc = BrickletLoadCell.new UID, ipcon # Create device object

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

# Get current weight
weight = lc.get_weight
puts "Weight: #{weight} g"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback

Download (example_callback.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_load_cell'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Load Cell Bricklet

ipcon = IPConnection.new # Create IP connection
lc = BrickletLoadCell.new UID, ipcon # Create device object

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

# Register weight callback
lc.register_callback(BrickletLoadCell::CALLBACK_WEIGHT) do |weight|
  puts "Weight: #{weight} g"
end

# 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.set_weight_callback_period 1000

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Threshold

Download (example_threshold.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_load_cell'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Load Cell Bricklet

ipcon = IPConnection.new # Create IP connection
lc = BrickletLoadCell.new 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.set_debounce_period 1000

# Register weight reached callback
lc.register_callback(BrickletLoadCell::CALLBACK_WEIGHT_REACHED) do |weight|
  puts "Weight: #{weight} g"
end

# Configure threshold for weight "greater than 200 g"
lc.set_weight_callback_threshold '>', 200, 0

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletLoadCell::new(uid, ipcon) → load_cell
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • load_cell – Typ: BrickletLoadCell

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

load_cell = BrickletLoadCell.new 'YOUR_DEVICE_UID', ipcon

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

BrickletLoadCell#get_weight → int
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 ::CALLBACK_WEIGHT Callback zu nutzen und die Periode mit #set_weight_callback_period vorzugeben.

BrickletLoadCell#led_on → nil

Aktiviert die LED.

BrickletLoadCell#led_off → nil

Deaktiviert die LED.

BrickletLoadCell#is_led_on → bool
Rückgabe:
  • on – Typ: bool

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

BrickletLoadCell#tare → nil

Setzt das aktuell gemessene Gewicht als Leergewicht.

Fortgeschrittene Funktionen

BrickletLoadCell#set_moving_average(average) → nil
Parameter:
  • average – Typ: int, 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.

BrickletLoadCell#get_moving_average → int
Rückgabe:
  • average – Typ: int, Wertebereich: [0 bis 255]

Gibt die Länge des gleitenden Mittelwerts zurück, wie von #set_moving_average gesetzt.

BrickletLoadCell#calibrate(weight) → nil
Parameter:
  • weight – Typ: int, 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.

BrickletLoadCell#set_configuration(rate, gain) → nil
Parameter:
  • rate – Typ: int, Wertebereich: Siehe Konstanten
  • gain – Typ: int, 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 #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 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#get_configuration → [int, int]
Rückgabe-Array:
  • 0: rate – Typ: int, Wertebereich: Siehe Konstanten
  • 1: gain – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von #set_configuration 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
BrickletLoadCell#get_api_version → [int, ...]
Rückgabe:
  • api_version – Typ: [int, ...], 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.

BrickletLoadCell#get_response_expected(function_id) → bool
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – 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 #set_response_expected. 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 function_id:

  • 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
BrickletLoadCell#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – 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 function_id:

  • 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
BrickletLoadCell#set_response_expected_all(response_expected) → nil
Parameter:
  • response_expected – Typ: bool

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

BrickletLoadCell#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Rückgabe-Array:
  • 0: uid – Typ: str, Länge: bis zu 8
  • 1: connected_uid – Typ: str, Länge: bis zu 8
  • 2: position – Typ: chr
  • 3: hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: firmware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 5: device_identifier – 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 Callbacks

BrickletLoadCell#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:
  • callback_id – Typ: int

Registriert den block für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletLoadCell#set_weight_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_WEIGHT Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletLoadCell#get_weight_callback_period → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von #set_weight_callback_period gesetzt.

BrickletLoadCell#set_weight_callback_threshold(option, min, max) → nil
Parameter:
  • option – Typ: chr, 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 ::CALLBACK_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)

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#get_weight_callback_threshold → [chr, int, int]
Rückgabe-Array:
  • 0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 2: max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt den Schwellwert zurück, wie von #set_weight_callback_threshold 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 = '>'
BrickletLoadCell#set_debounce_period(debounce) → nil
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletLoadCell#get_debounce_period → int
Rückgabe:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von #set_debounce_period gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

load_cell.register_callback BrickletLoadCell::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletLoadCell::CALLBACK_WEIGHT
Callback-Parameter:
  • weight – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

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

BrickletLoadCell::CALLBACK_WEIGHT_REACHED
Callback-Parameter:
  • weight – Typ: int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_weight_callback_threshold 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 #set_debounce_period gesetzt, ausgelöst.

Konstanten

BrickletLoadCell::DEVICE_IDENTIFIER

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

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletLoadCell::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet dar.