Ruby - Thermocouple Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Thermocouple Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Thermocouple 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_thermocouple'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
t = BrickletThermocouple.new UID, ipcon # Create device object

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

# Get current temperature
temperature = t.get_temperature
puts "Temperature: #{temperature/100.0} °C"

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_thermocouple'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
t = BrickletThermocouple.new UID, ipcon # Create device object

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

# Register temperature callback
t.register_callback(BrickletThermocouple::CALLBACK_TEMPERATURE) do |temperature|
  puts "Temperature: #{temperature/100.0} °C"
end

# Set period for temperature callback to 1s (1000ms)
# Note: The temperature callback is only called every second
#       if the temperature has changed since the last call!
t.set_temperature_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_thermocouple'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
t = BrickletThermocouple.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 10 seconds (10000ms)
t.set_debounce_period 10000

# Register temperature reached callback
t.register_callback(BrickletThermocouple::CALLBACK_TEMPERATURE_REACHED) do |temperature|
  puts "Temperature: #{temperature/100.0} °C"
end

# Configure threshold for temperature "greater than 30 °C"
t.set_temperature_callback_threshold '>', 30*100, 0

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletThermocouple::new(uid, ipcon) → thermocouple
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

thermocouple = BrickletThermocouple.new 'YOUR_DEVICE_UID', ipcon

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

BrickletThermocouple#get_temperature → int

Gibt die Temperatur des Thermoelements zurück. Der Wert wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_TEMPERATURE Callback zu nutzen und die Periode mit #set_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen

BrickletThermocouple#set_configuration(averaging, thermocouple_type, filter) → nil
Parameter:
  • averaging -- int
  • thermocouple_type -- int
  • filter -- int

Konfiguriert werden können Averaging-Größe, Thermoelement-Typ und Frequenz-Filterung.

Mögliche Averaging-Größen sind 1, 2, 4, 8 und 16 Samples.

Als Thermoelement-Typ stehen B, E, J, K, N, R, S und T zur Verfügung. Falls ein anderes Thermoelement benutzt werden soll, können G8 und G32 genutzt werden. Mit diesen Typen wird der Wert nicht in °C/100 zurückgegeben sondern er wird durch folgende Formeln bestimmt:

  • G8: Wert = 8 * 1.6 * 2^17 * Vin
  • G32: Wert = 32 * 1.6 * 2^17 * Vin

dabei ist Vin die Eingangsspannung des Thermoelements.

Der Frequenz-Filter kann auf 50Hz und 60Hz konfiguriert werden. Er sollte abhängig von der lokalen Netzfrequenz gewählt werden.

Die Konvertierungszeit ist abhängig von der Averaging-Größe und der Frequenz-Filter-Konfiguration. Sie kann wie folgt bestimmt werden:

  • 60Hz: Zeit = 82 + (Samples - 1) * 16.67
  • 50Hz: Zeit = 98 + (Samples - 1) * 20

Die Standardkonfiguration ist 16 Samples, Typ K und 50Hz.

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

  • BrickletThermocouple::AVERAGING_1 = 1
  • BrickletThermocouple::AVERAGING_2 = 2
  • BrickletThermocouple::AVERAGING_4 = 4
  • BrickletThermocouple::AVERAGING_8 = 8
  • BrickletThermocouple::AVERAGING_16 = 16
  • BrickletThermocouple::TYPE_B = 0
  • BrickletThermocouple::TYPE_E = 1
  • BrickletThermocouple::TYPE_J = 2
  • BrickletThermocouple::TYPE_K = 3
  • BrickletThermocouple::TYPE_N = 4
  • BrickletThermocouple::TYPE_R = 5
  • BrickletThermocouple::TYPE_S = 6
  • BrickletThermocouple::TYPE_T = 7
  • BrickletThermocouple::TYPE_G8 = 8
  • BrickletThermocouple::TYPE_G32 = 9
  • BrickletThermocouple::FILTER_OPTION_50HZ = 0
  • BrickletThermocouple::FILTER_OPTION_60HZ = 1
BrickletThermocouple#get_configuration → [int, int, int]

Gibt die Konfiguration zurück, wie von #set_configuration gesetzt.

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

  • BrickletThermocouple::AVERAGING_1 = 1
  • BrickletThermocouple::AVERAGING_2 = 2
  • BrickletThermocouple::AVERAGING_4 = 4
  • BrickletThermocouple::AVERAGING_8 = 8
  • BrickletThermocouple::AVERAGING_16 = 16
  • BrickletThermocouple::TYPE_B = 0
  • BrickletThermocouple::TYPE_E = 1
  • BrickletThermocouple::TYPE_J = 2
  • BrickletThermocouple::TYPE_K = 3
  • BrickletThermocouple::TYPE_N = 4
  • BrickletThermocouple::TYPE_R = 5
  • BrickletThermocouple::TYPE_S = 6
  • BrickletThermocouple::TYPE_T = 7
  • BrickletThermocouple::TYPE_G8 = 8
  • BrickletThermocouple::TYPE_G32 = 9
  • BrickletThermocouple::FILTER_OPTION_50HZ = 0
  • BrickletThermocouple::FILTER_OPTION_60HZ = 1

Das zurückgegebene Array enthält die Werte averaging, thermocouple_type und filter.

BrickletThermocouple#get_error_state → [bool, bool]

Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:

  • Over/Under Voltage und
  • Open Circuit.

Over/Under Voltage bei Spannungen unter 0V oder über 3.3V ausgelöst. In diesem Fall ist mit hoher Wahrscheinlichkeit das Thermoelement defekt. Ein Open Circuit-Error deutet darauf hin, das kein Thermoelement angeschlossen ist.

Der ::CALLBACK_ERROR_STATE Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

Das zurückgegebene Array enthält die Werte over_under und open_circuit.

BrickletThermocouple#get_api_version → [int, int, int]

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.

BrickletThermocouple#get_response_expected(function_id) → bool
Parameter:function_id -- int

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.

Siehe #set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletThermocouple#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletThermocouple::FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • BrickletThermocouple::FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • BrickletThermocouple::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletThermocouple::FUNCTION_SET_CONFIGURATION = 10
BrickletThermocouple#set_response_expected_all(response_expected) → nil
Parameter:response_expected -- bool

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

BrickletThermocouple#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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.

Das zurückgegebene Array enthält die Werte uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickletThermocouple#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:callback_id -- int

Registriert den block für die gegebene callback_id.

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

BrickletThermocouple#set_temperature_callback_period(period) → nil
Parameter:period -- int

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

Der ::CALLBACK_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

BrickletThermocouple#get_temperature_callback_period → int

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

BrickletThermocouple#set_temperature_callback_threshold(option, min, max) → nil
Parameter:
  • option -- str
  • min -- int
  • max -- int

Setzt den Schwellwert für den ::CALLBACK_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

  • BrickletThermocouple::THRESHOLD_OPTION_OFF = 'x'
  • BrickletThermocouple::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletThermocouple::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletThermocouple::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletThermocouple::THRESHOLD_OPTION_GREATER = '>'
BrickletThermocouple#get_temperature_callback_threshold → [str, int, int]

Gibt den Schwellwert zurück, wie von #set_temperature_callback_threshold gesetzt.

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

  • BrickletThermocouple::THRESHOLD_OPTION_OFF = 'x'
  • BrickletThermocouple::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletThermocouple::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletThermocouple::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletThermocouple::THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Array enthält die Werte option, min und max.

BrickletThermocouple#set_debounce_period(debounce) → nil
Parameter:debounce -- int

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

BrickletThermocouple#get_debounce_period → int

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:

thermocouple.register_callback BrickletThermocouple::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.

BrickletThermocouple::CALLBACK_TEMPERATURE
Parameter:temperature -- int

Dieser Callback wird mit der Periode, wie gesetzt mit #set_temperature_callback_period, ausgelöst. Der Parameter ist die Temperatur des Thermoelements.

Der ::CALLBACK_TEMPERATURE Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

BrickletThermocouple::CALLBACK_TEMPERATURE_REACHED
Parameter:temperature -- int

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_temperature_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Temperatur des Thermoelements.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit #set_debounce_period gesetzt, ausgelöst.

BrickletThermocouple::CALLBACK_ERROR_STATE
Parameter:
  • over_under -- bool
  • open_circuit -- bool

Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert (siehe #get_error_state).

Konstanten

BrickletThermocouple::DEVICE_IDENTIFIER

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

BrickletThermocouple::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Thermocouple Bricklet dar.