Dies ist die Beschreibung der Ruby API Bindings für das PTC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des PTC Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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_ptc'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your PTC Bricklet
ipcon = IPConnection.new # Create IP connection
ptc = BrickletPTC.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 = ptc.get_temperature
puts "Temperature: #{temperature/100.0} °C"
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
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_ptc'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your PTC Bricklet
ipcon = IPConnection.new # Create IP connection
ptc = BrickletPTC.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Register temperature callback
ptc.register_callback(BrickletPTC::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!
ptc.set_temperature_callback_period 1000
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
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_ptc'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your PTC Bricklet
ipcon = IPConnection.new # Create IP connection
ptc = BrickletPTC.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)
ptc.set_debounce_period 10000
# Register temperature reached callback
ptc.register_callback(BrickletPTC::CALLBACK_TEMPERATURE_REACHED) do |temperature|
puts "Temperature: #{temperature/100.0} °C"
end
# Configure threshold for temperature "greater than 30 °C"
ptc.set_temperature_callback_threshold '>', 30*100, 0
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletPTC
::
new
(uid, ipcon) → ptc¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
ptc = BrickletPTC.new 'YOUR_DEVICE_UID', ipcon
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletPTC
#
get_temperature
→ int¶Rückgabe: |
|
---|
Gibt die Temperatur des verbundenen Sensors zurück.
Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen
den ::CALLBACK_TEMPERATURE
Callback zu nutzen und die Periode mit
#set_temperature_callback_period
vorzugeben.
BrickletPTC
#
is_sensor_connected
→ bool¶Rückgabe: |
|
---|
Gibt true zurück wenn ein Sensor korrekt verbunden ist.
Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.
BrickletPTC
#
set_wire_mode
(mode) → nil¶Parameter: |
|
---|
Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPTC
#
get_wire_mode
→ int¶Rückgabe: |
|
---|
Gibt die Leiter-Konfiguration zurück, wie von #set_wire_mode
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPTC
#
get_resistance
→ int¶Rückgabe: |
|
---|
Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.
Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:
Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen
den ::CALLBACK_RESISTANCE
Callback zu nutzen und die Periode mit
#set_resistance_callback_period
vorzugeben.
BrickletPTC
#
set_noise_rejection_filter
(filter) → nil¶Parameter: |
|
---|
Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für filter:
BrickletPTC
#
get_noise_rejection_filter
→ int¶Rückgabe: |
|
---|
Gibt die Einstellung des Entstörfilters zurück, wie von
#set_noise_rejection_filter
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für filter:
BrickletPTC
#
get_identity
→ [str, str, chr, [int, ...], [int, ...], int]¶Rückgabe-Array: |
|
---|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
BrickletPTC
#
register_callback
(callback_id) { |param [, ...]| block } → nil¶Parameter: |
|
---|
Registriert den block
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletPTC
#
set_temperature_callback_period
(period) → nil¶Parameter: |
|
---|
Setzt die Periode 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.
BrickletPTC
#
get_temperature_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_temperature_callback_period
gesetzt.
BrickletPTC
#
set_resistance_callback_period
(period) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher der ::CALLBACK_RESISTANCE
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der ::CALLBACK_RESISTANCE
Callback wird nur ausgelöst, wenn sich der Widerstand seit
der letzten Auslösung geändert hat.
BrickletPTC
#
get_resistance_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_resistance_callback_period
gesetzt.
BrickletPTC
#
set_temperature_callback_threshold
(option, min, max) → nil¶Parameter: |
|
---|
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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC
#
get_temperature_callback_threshold
→ [chr, int, int]¶Rückgabe-Array: |
|
---|
Gibt den Schwellwert zurück, wie von #set_temperature_callback_threshold
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC
#
set_resistance_callback_threshold
(option, min, max) → nil¶Parameter: |
|
---|
Setzt den Schwellwert für den ::CALLBACK_RESISTANCE_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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC
#
get_resistance_callback_threshold
→ [chr, int, int]¶Rückgabe-Array: |
|
---|
Gibt den Schwellwert zurück, wie von #set_resistance_callback_threshold
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC
#
set_debounce_period
(debounce) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletPTC
#
get_debounce_period
→ int¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von #set_debounce_period
gesetzt.
BrickletPTC
#
set_sensor_connected_callback_configuration
(enabled) → nil¶Parameter: |
|
---|
Wenn dieser Callback aktiviert ist, wird der ::CALLBACK_SENSOR_CONNECTED
Callback
jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.
Neu in Version 2.0.2 (Plugin).
BrickletPTC
#
get_sensor_connected_callback_configuration
→ bool¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von #set_sensor_connected_callback_configuration
gesetzt.
Neu in Version 2.0.2 (Plugin).
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:
ptc.register_callback BrickletPTC::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.
BrickletPTC
::
CALLBACK_TEMPERATURE
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit #set_temperature_callback_period
,
ausgelöst. Der Parameter ist die Temperatur des verbundenen Sensors.
Der ::CALLBACK_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die Temperatur
seit der letzten Auslösung geändert hat.
BrickletPTC
::
CALLBACK_TEMPERATURE_REACHED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
#set_temperature_callback_threshold
gesetzt, erreicht wird.
Der Parameter ist die Temperatur des verbundenen Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit #set_debounce_period
gesetzt, ausgelöst.
BrickletPTC
::
CALLBACK_RESISTANCE
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit #set_resistance_callback_period
,
ausgelöst. Der Parameter ist der Widerstand des verbundenen Sensors.
Der ::CALLBACK_RESISTANCE
Callback wird nur ausgelöst, wenn sich der Widerstand seit
der letzten Auslösung geändert hat.
BrickletPTC
::
CALLBACK_RESISTANCE_REACHED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
#set_resistance_callback_threshold
gesetzt, erreicht wird.
Der Parameter ist der Widerstand des verbundenen Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit #set_debounce_period
gesetzt, ausgelöst.
BrickletPTC
::
CALLBACK_SENSOR_CONNECTED
¶Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
#set_sensor_connected_callback_configuration
gesetzten Konfiguration
Der Parameter ist der gleiche wie bei #is_sensor_connected
.
Neu in Version 2.0.2 (Plugin).
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
BrickletPTC
#
get_api_version
→ [int, ...]¶Rückgabe-Array: |
|
---|
Gibt die Version der API Definition 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.
BrickletPTC
#
get_response_expected
(function_id) → bool¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletPTC
#
set_response_expected
(function_id, response_expected) → nil¶Parameter: |
|
---|
Ä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:
BrickletPTC
#
set_response_expected_all
(response_expected) → nil¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletPTC
::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein PTC 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.
BrickletPTC
::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.