Ruby - Industrial Dual 0-20mA Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Industrial Dual 0-20mA Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA 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_industrial_dual_0_20ma'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

ipcon = IPConnection.new # Create IP connection
id020 = BrickletIndustrialDual020mA.new UID, ipcon # Create device object

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

# Get current current from sensor 1
current = id020.get_current 1
puts "Current (Sensor 1): #{current/1000000.0} mA"

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_0_20ma'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

ipcon = IPConnection.new # Create IP connection
id020 = BrickletIndustrialDual020mA.new UID, ipcon # Create device object

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

# Register current callback
id020.register_callback(BrickletIndustrialDual020mA::CALLBACK_CURRENT) do |sensor,
                                                                           current|
  puts "Sensor: #{sensor}"
  puts "Current: #{current/1000000.0} mA"
  puts ''
end

# Set period for current (sensor 1) callback to 1s (1000ms)
# Note: The current (sensor 1) callback is only called every second
#       if the current (sensor 1) has changed since the last call!
id020.set_current_callback_period 1, 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
33
34
35
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_dual_0_20ma'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet

ipcon = IPConnection.new # Create IP connection
id020 = BrickletIndustrialDual020mA.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)
id020.set_debounce_period 10000

# Register current reached callback
id020.register_callback(BrickletIndustrialDual020mA::CALLBACK_CURRENT_REACHED) do |sensor,
                                                                                   current|
  puts "Sensor: #{sensor}"
  puts "Current: #{current/1000000.0} mA"
  puts ''
end

# Configure threshold for current (sensor 1) "greater than 10 mA"
id020.set_current_callback_threshold 1, '>', 10*1000000, 0

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Es können zwei Sensoren an das Bricklet angeschlossen werden. Funktionen die sich direkt auf einen der Sensoren beziehen haben einen sensor Parameter, um den Sensor anzugeben. Gültige Werte für den sensor Parameter sind 0 und 1.

Grundfunktionen

BrickletIndustrialDual020mA::new(uid, ipcon) → industrial_dual_0_20ma
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

industrial_dual_0_20ma = BrickletIndustrialDual020mA.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialDual020mA#get_current(sensor) → int
Parameter:sensor -- int

Gibt die gemessenen Stromstärke des angegebenen Sensors (0 oder 1) zurück. Der Wert ist in nA und im Bereich von 0nA bis 22505322nA (22,5mA).

Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.

Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_CURRENT Callback zu nutzen und die Periode mit #set_current_callback_period vorzugeben.

Fortgeschrittene Funktionen

BrickletIndustrialDual020mA#set_sample_rate(rate) → nil
Parameter:rate -- int

Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.

Wert Beschreibung
0 240 Samples pro Sekunde, 12 Bit Auflösung
1 60 Samples pro Sekunde, 14 Bit Auflösung
2 15 Samples pro Sekunde, 16 Bit Auflösung
3 4 Samples pro Sekunde, 18 Bit Auflösung

Der Standardwert ist 3 (4 Samples pro Sekunde mit 18 Bit Auflösung).

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

  • BrickletIndustrialDual020mA::SAMPLE_RATE_240_SPS = 0
  • BrickletIndustrialDual020mA::SAMPLE_RATE_60_SPS = 1
  • BrickletIndustrialDual020mA::SAMPLE_RATE_15_SPS = 2
  • BrickletIndustrialDual020mA::SAMPLE_RATE_4_SPS = 3
BrickletIndustrialDual020mA#get_sample_rate → int

Gibt die Abtastrate zurück, wie von #set_sample_rate gesetzt.

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

  • BrickletIndustrialDual020mA::SAMPLE_RATE_240_SPS = 0
  • BrickletIndustrialDual020mA::SAMPLE_RATE_60_SPS = 1
  • BrickletIndustrialDual020mA::SAMPLE_RATE_15_SPS = 2
  • BrickletIndustrialDual020mA::SAMPLE_RATE_4_SPS = 3
BrickletIndustrialDual020mA#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.

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

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

  • BrickletIndustrialDual020mA::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
  • BrickletIndustrialDual020mA::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
  • BrickletIndustrialDual020mA::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletIndustrialDual020mA::FUNCTION_SET_SAMPLE_RATE = 8
BrickletIndustrialDual020mA#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 Konstanten sind für diese Funktion verfügbar:

  • BrickletIndustrialDual020mA::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
  • BrickletIndustrialDual020mA::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
  • BrickletIndustrialDual020mA::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletIndustrialDual020mA::FUNCTION_SET_SAMPLE_RATE = 8
BrickletIndustrialDual020mA#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.

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

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

BrickletIndustrialDual020mA#set_current_callback_period(sensor, period) → nil
Parameter:
  • sensor -- int
  • period -- int

Setzt die Periode in ms mit welcher der ::CALLBACK_CURRENT Callback für den übergebenen Sensor ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

Der Standardwert ist 0.

BrickletIndustrialDual020mA#get_current_callback_period(sensor) → int
Parameter:sensor -- int

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

BrickletIndustrialDual020mA#set_current_callback_threshold(sensor, option, min, max) → nil
Parameter:
  • sensor -- int
  • option -- str
  • min -- int
  • max -- int

Setzt den Schwellwert des ::CALLBACK_CURRENT_REACHED Callbacks für den übergebenen Sensor.

Die folgenden Optionen sind möglich:

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

  • BrickletIndustrialDual020mA::THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDual020mA::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDual020mA::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDual020mA::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDual020mA::THRESHOLD_OPTION_GREATER = '>'
BrickletIndustrialDual020mA#get_current_callback_threshold(sensor) → [str, int, int]
Parameter:sensor -- int

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

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

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

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

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

Setzt die Periode in ms mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

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

industrial_dual_0_20ma.register_callback BrickletIndustrialDual020mA::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.

BrickletIndustrialDual020mA::CALLBACK_CURRENT
Parameter:
  • sensor -- int
  • current -- int

Dieser Callback wird mit der Periode, wie gesetzt mit #set_current_callback_period, ausgelöst. Der Parameter ist die Stromstärke des Sensors.

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

BrickletIndustrialDual020mA::CALLBACK_CURRENT_REACHED
Parameter:
  • sensor -- int
  • current -- int

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_current_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Stromstärke des Sensors.

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

Konstanten

BrickletIndustrialDual020mA::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Dual 0-20mA 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.

BrickletIndustrialDual020mA::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet dar.