Ruby - Current25 Bricklet¶

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

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
c = BrickletCurrent25.new UID, ipcon # Create device object

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

# Get current current
current = c.get_current
puts "Current: #{current/1000.0} A"

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

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
c = BrickletCurrent25.new UID, ipcon # Create device object

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

# Register current callback
c.register_callback(BrickletCurrent25::CALLBACK_CURRENT) do |current|
  puts "Current: #{current/1000.0} A"
end

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

include Tinkerforge

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

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

# Register current reached callback
c.register_callback(BrickletCurrent25::CALLBACK_CURRENT_REACHED) do |current|
  puts "Current: #{current/1000.0} A"
end

# Configure threshold for current "greater than 5 A"
c.set_current_callback_threshold '>', 5*1000, 0

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

Grundfunktionen¶

BrickletCurrent25::new(uid, ipcon) → current25¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	current25 – Typ: BrickletCurrent25

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

current25 = BrickletCurrent25.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletCurrent25#get_current → int¶

Rückgabe:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-25000 bis 25000]

Gibt die gemessene Stromstärke des Sensors zurück.

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¶

BrickletCurrent25#calibrate → nil¶

Kalibriert den Nullwert des Sensors. Diese Funktion muss aufgerufen werden, wenn kein Strom fließt.

Der Nullwert des Stromsensors ist abhängig von den exakten Eigenschaften des Analog-Digital-Wandlers, der Länge des Bricklet Kabels und der Temperatur. Daher ist es, bei Wechsel des Brick oder bei Veränderung der Umgebung in welcher das Bricklet genutzt wird, ratsam erneut zu kalibrieren.

Die resultierende Kalibrierung wird in den EEPROM des Current Bricklet gespeichert.

BrickletCurrent25#is_over_current → bool¶

Rückgabe:	over – Typ: bool

Gibt true zurück wenn mehr als 25A gemessen wurden.

Bemerkung

Um diesen Wert zurückzusetzen ist ein Aus- und Wiedereinschalten des Bricklet notwendig.

BrickletCurrent25#get_analog_value → int¶

Rückgabe:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von #get_current zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während #get_analog_value unverarbeitete Analogwerte zurück gibt. Der einzige Grund #get_analog_value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit #set_analog_value_callback_period vorzugeben.

BrickletCurrent25#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, Wertebereich: ['a' bis 'h', 'z'] 3: hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 4: firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, 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 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.

Konfigurationsfunktionen für Callbacks¶

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

BrickletCurrent25#set_current_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_CURRENT Callback 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.

BrickletCurrent25#get_current_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_current_callback_period gesetzt.

BrickletCurrent25#set_analog_value_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_ANALOG_VALUE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletCurrent25#get_analog_value_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_analog_value_callback_period gesetzt.

BrickletCurrent25#set_current_callback_threshold(option, min, max) → nil¶

Parameter:	option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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)

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

Für option:

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

BrickletCurrent25#get_current_callback_threshold → [chr, int, int]¶

Rückgabe-Array:	0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 1: min – Typ: int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 2: max – Typ: int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für option:

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

BrickletCurrent25#set_analog_value_callback_threshold(option, min, max) → nil¶

Parameter:	option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 212 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 212 - 1], Standardwert: 0

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

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert)

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

Für option:

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

BrickletCurrent25#get_analog_value_callback_threshold → [chr, int, int]¶

Rückgabe-Array:	0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 1: min – Typ: int, Wertebereich: [0 bis 212 - 1], Standardwert: 0 2: max – Typ: int, Wertebereich: [0 bis 212 - 1], Standardwert: 0

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

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

Für option:

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

BrickletCurrent25#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 Callbacks

• ::CALLBACK_CURRENT_REACHED,
• ::CALLBACK_ANALOG_VALUE_REACHED

ausgelöst werden, wenn die Schwellwerte

• #set_current_callback_threshold,
• #set_analog_value_callback_threshold

weiterhin erreicht bleiben.

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

current25.register_callback BrickletCurrent25::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

BrickletCurrent25::CALLBACK_CURRENT¶

Callback-Parameter:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-25000 bis 25000]

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.

BrickletCurrent25::CALLBACK_ANALOG_VALUE¶

Callback-Parameter:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_analog_value_callback_period, ausgelöst. Der Parameter ist der Analogwert des Sensors.

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

BrickletCurrent25::CALLBACK_CURRENT_REACHED¶

Callback-Parameter:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-25000 bis 25000]

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.

BrickletCurrent25::CALLBACK_ANALOG_VALUE_REACHED¶

Callback-Parameter:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

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

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

BrickletCurrent25::CALLBACK_OVER_CURRENT¶

Callback-Parameter:	keine Parameter

Dieser Callback wird ausgelöst, wenn ein Überstrom gemessen wurde (siehe #is_over_current).

Virtuelle Funktionen¶

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.

BrickletCurrent25#get_api_version → [int, ...]¶

Rückgabe-Array:	0: api_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255]

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.

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

• BrickletCurrent25::FUNCTION_CALIBRATE = 2
• BrickletCurrent25::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
• BrickletCurrent25::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletCurrent25::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
• BrickletCurrent25::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletCurrent25::FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

• BrickletCurrent25::FUNCTION_CALIBRATE = 2
• BrickletCurrent25::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
• BrickletCurrent25::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletCurrent25::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
• BrickletCurrent25::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletCurrent25::FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

Konstanten¶

BrickletCurrent25::DEVICE_IDENTIFIER¶

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

BrickletCurrent25::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Current25 Bricklet dar.