Ruby - Temperature IR Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR 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
26
27
28
29
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_temperature_ir'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
tir = BrickletTemperatureIR.new UID, ipcon # Create device object

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

# Get current ambient temperature
ambient_temperature = tir.get_ambient_temperature
puts "Ambient Temperature: #{ambient_temperature/10.0} °C"

# Get current object temperature
object_temperature = tir.get_object_temperature
puts "Object Temperature: #{object_temperature/10.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_temperature_ir'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
tir = BrickletTemperatureIR.new UID, ipcon # Create device object

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

# Register object temperature callback
tir.register_callback(BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE) do |temperature|
  puts "Object Temperature: #{temperature/10.0} °C"
end

# Set period for object temperature callback to 1s (1000ms)
# Note: The object temperature callback is only called every second
#       if the object temperature has changed since the last call!
tir.set_object_temperature_callback_period 1000

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

Water Boiling

Download (example_water_boiling.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
33
34
35
36
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_temperature_ir'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
tir = BrickletTemperatureIR.new UID, ipcon # Create device object

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

# Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
tir.set_emissivity 64224

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tir.set_debounce_period 10000

# Register object temperature reached callback
tir.register_callback(BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED) do |temperature|
  puts "Object Temperature: #{temperature/10.0} °C"
  puts 'The water is boiling!'
end

# Configure threshold for object temperature "greater than 100 °C"
tir.set_object_temperature_callback_threshold '>', 100*10, 0

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletTemperatureIR::new(uid, ipcon) → temperature_ir
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

temperature_ir = BrickletTemperatureIR.new 'YOUR_DEVICE_UID', ipcon

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

BrickletTemperatureIR#get_ambient_temperature → int

Gibt die Umgebungstemperatur des Sensors zurück. Der Wertebereich ist von -400 bis 1250 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 423 eine gemessene Umgebungstemperatur von 42,3 °C.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_AMBIENT_TEMPERATURE Callback zu nutzen und die Periode mit #set_ambient_temperature_callback_period vorzugeben.

BrickletTemperatureIR#get_object_temperature → int

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt. Der Wertebereich ist von -700 bis 3800 und wird in °C/10 angegeben, z.B. bedeutet ein Wert von 3001 eine gemessene Temperatur von 300,1 °C auf der Oberfläche des Objektes.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit #set_emissivity gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_OBJECT_TEMPERATURE Callback zu nutzen und die Periode mit #set_object_temperature_callback_period vorzugeben.

Fortgeschrittene Funktionen

BrickletTemperatureIR#set_emissivity(emissivity) → nil
Parameter:emissivity -- int

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von #get_object_temperature zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von #set_emissivity muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Standard Emissionsgrad ist 1,0 (Wert von 65535) und der minimale Emissionsgrad welcher der Sensor verarbeiten kann ist 0,1 (Wert von 6553).

Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.

BrickletTemperatureIR#get_emissivity → int

Gibt den Emissionsgrad zurück, wie von #set_emissivity gesetzt.

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

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

BrickletTemperatureIR#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:

  • BrickletTemperatureIR::FUNCTION_SET_EMISSIVITY = 3
  • BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • BrickletTemperatureIR::FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletTemperatureIR#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.

BrickletTemperatureIR#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

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

BrickletTemperatureIR#set_ambient_temperature_callback_period(period) → nil
Parameter:period -- int

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

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

Der Standardwert ist 0.

BrickletTemperatureIR#get_ambient_temperature_callback_period → int

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

BrickletTemperatureIR#set_object_temperature_callback_period(period) → nil
Parameter:period -- int

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

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

Der Standardwert ist 0.

BrickletTemperatureIR#get_object_temperature_callback_period → int

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

BrickletTemperatureIR#set_ambient_temperature_callback_threshold(option, min, max) → nil
Parameter:
  • option -- str
  • min -- int
  • max -- int

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

Die folgenden Optionen sind möglich:

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

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

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

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

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

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

BrickletTemperatureIR#set_object_temperature_callback_threshold(option, min, max) → nil
Parameter:
  • option -- str
  • min -- int
  • max -- int

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

Die folgenden Optionen sind möglich:

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

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

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

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

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

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

BrickletTemperatureIR#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:

temperature_ir.register_callback BrickletTemperatureIR::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.

BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE
Parameter:temperature -- int

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

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

BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE
Parameter:temperature -- int

Dieser Callback wird mit der Periode, wie gesetzt mit #set_object_temperature_callback_period, ausgelöst. Der Parameter ist die Objekttemperatur des Sensors.

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

BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE_REACHED
Parameter:temperature -- int

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_ambient_temperature_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Umgebungstemperatur des Sensors.

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

BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED
Parameter:temperature -- int

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_object_temperature_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Objekttemperatur des Sensors.

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

Konstanten

BrickletTemperatureIR::DEVICE_IDENTIFIER

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

BrickletTemperatureIR::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.