Software / API Bindings / Ruby / API Referenz und Beispiele / Bricklets / Voltage/Current Bricklet 2.0

Ruby - Voltage/Current Bricklet 2.0¶

Dies ist die Beschreibung der Ruby API Bindings für das Voltage/Current Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current Bricklet 2.0 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).

Callback¶

Download (example_callback.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_voltage_current_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Voltage/Current Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
vc = BrickletVoltageCurrentV2.new UID, ipcon # Create device object

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

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

# Set period for current callback to 1s (1000ms) without a threshold
vc.set_current_callback_configuration 1000, false, 'x', 0, 0

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

Simple¶

Download (example_simple.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_voltage_current_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Voltage/Current Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
vc = BrickletVoltageCurrentV2.new UID, ipcon # Create device object

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

# Get current voltage
voltage = vc.get_voltage
puts "Voltage: #{voltage/1000.0} V"

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

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

Threshold¶

Download (example_threshold.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_voltage_current_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Voltage/Current Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
vc = BrickletVoltageCurrentV2.new UID, ipcon # Create device object

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

# Register power callback
vc.register_callback(BrickletVoltageCurrentV2::CALLBACK_POWER) do |power|
  puts "power: #{power/1000.0} W"
end

# Configure threshold for power "greater than 10 W"
# with a debounce period of 1s (1000ms)
vc.set_power_callback_configuration 1000, false, '>', 10*1000, 0

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

API¶

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletVoltageCurrentV2::new(uid, ipcon) → voltage_current_v2¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	voltage_current_v2 – Typ: BrickletVoltageCurrentV2

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

voltage_current_v2 = BrickletVoltageCurrentV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletVoltageCurrentV2#get_current → int¶

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

Gibt die gemessenen Stromstärke zurück.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_CURRENT Callback verwendet werden. Der Callback wird mit der Funktion #set_current_callback_configuration konfiguriert.

BrickletVoltageCurrentV2#get_voltage → int¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Gibt die gemessenen Spannung zurück.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_VOLTAGE Callback verwendet werden. Der Callback wird mit der Funktion #set_voltage_callback_configuration konfiguriert.

BrickletVoltageCurrentV2#get_power → int¶

Rückgabe:	power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_POWER Callback verwendet werden. Der Callback wird mit der Funktion #set_power_callback_configuration konfiguriert.

BrickletVoltageCurrentV2#set_configuration(averaging, voltage_conversion_time, current_conversion_time) → nil¶

Parameter:	averaging – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3 voltage_conversion_time – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4 current_conversion_time – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4

Setzt die Konfiguration des Voltage/Current Bricklet 2.0. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

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

Für averaging:

BrickletVoltageCurrentV2::AVERAGING_1 = 0
BrickletVoltageCurrentV2::AVERAGING_4 = 1
BrickletVoltageCurrentV2::AVERAGING_16 = 2
BrickletVoltageCurrentV2::AVERAGING_64 = 3
BrickletVoltageCurrentV2::AVERAGING_128 = 4
BrickletVoltageCurrentV2::AVERAGING_256 = 5
BrickletVoltageCurrentV2::AVERAGING_512 = 6
BrickletVoltageCurrentV2::AVERAGING_1024 = 7

Für voltage_conversion_time:

BrickletVoltageCurrentV2::CONVERSION_TIME_140US = 0
BrickletVoltageCurrentV2::CONVERSION_TIME_204US = 1
BrickletVoltageCurrentV2::CONVERSION_TIME_332US = 2
BrickletVoltageCurrentV2::CONVERSION_TIME_588US = 3
BrickletVoltageCurrentV2::CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrentV2::CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrentV2::CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrentV2::CONVERSION_TIME_8_244MS = 7

Für current_conversion_time:

BrickletVoltageCurrentV2::CONVERSION_TIME_140US = 0
BrickletVoltageCurrentV2::CONVERSION_TIME_204US = 1
BrickletVoltageCurrentV2::CONVERSION_TIME_332US = 2
BrickletVoltageCurrentV2::CONVERSION_TIME_588US = 3
BrickletVoltageCurrentV2::CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrentV2::CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrentV2::CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrentV2::CONVERSION_TIME_8_244MS = 7

BrickletVoltageCurrentV2#get_configuration → [int, int, int]¶

Rückgabe-Array:	0: averaging – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3 1: voltage_conversion_time – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4 2: current_conversion_time – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4

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

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

Für averaging:

BrickletVoltageCurrentV2::AVERAGING_1 = 0
BrickletVoltageCurrentV2::AVERAGING_4 = 1
BrickletVoltageCurrentV2::AVERAGING_16 = 2
BrickletVoltageCurrentV2::AVERAGING_64 = 3
BrickletVoltageCurrentV2::AVERAGING_128 = 4
BrickletVoltageCurrentV2::AVERAGING_256 = 5
BrickletVoltageCurrentV2::AVERAGING_512 = 6
BrickletVoltageCurrentV2::AVERAGING_1024 = 7

Für voltage_conversion_time:

BrickletVoltageCurrentV2::CONVERSION_TIME_140US = 0
BrickletVoltageCurrentV2::CONVERSION_TIME_204US = 1
BrickletVoltageCurrentV2::CONVERSION_TIME_332US = 2
BrickletVoltageCurrentV2::CONVERSION_TIME_588US = 3
BrickletVoltageCurrentV2::CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrentV2::CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrentV2::CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrentV2::CONVERSION_TIME_8_244MS = 7

Für current_conversion_time:

BrickletVoltageCurrentV2::CONVERSION_TIME_140US = 0
BrickletVoltageCurrentV2::CONVERSION_TIME_204US = 1
BrickletVoltageCurrentV2::CONVERSION_TIME_332US = 2
BrickletVoltageCurrentV2::CONVERSION_TIME_588US = 3
BrickletVoltageCurrentV2::CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrentV2::CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrentV2::CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrentV2::CONVERSION_TIME_8_244MS = 7

Fortgeschrittene Funktionen¶

BrickletVoltageCurrentV2#set_calibration(voltage_multiplier, voltage_divisor, current_multiplier, current_divisor) → nil¶

Parameter:	voltage_multiplier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] voltage_divisor – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] current_multiplier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] current_divisor – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Da der ADC und der Shunt-Widerstand für die Messungen verwendet werden nicht perfekt sind, ist es nötig einen Multiplikator und einen Divisor zu setzen falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet 2.0 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden. Das gleiches gilt für die Spannung.

Die Kalibrierung wird in den EEPROM des Voltage/Current Bricklet gespeichert und muss nur einmal gesetzt werden.

BrickletVoltageCurrentV2#get_calibration → [int, int, int, int]¶

Rückgabe-Array:	0: voltage_multiplier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 1: voltage_divisor – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 2: current_multiplier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 3: current_divisor – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Kalibrierung zurück, wie von #set_calibration gesetzt.

BrickletVoltageCurrentV2#get_spitfp_error_count → [int, int, int, int]¶

Rückgabe-Array:	0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] 2: error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletVoltageCurrentV2#set_status_led_config(config) → nil¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

BrickletVoltageCurrentV2::STATUS_LED_CONFIG_OFF = 0
BrickletVoltageCurrentV2::STATUS_LED_CONFIG_ON = 1
BrickletVoltageCurrentV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletVoltageCurrentV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletVoltageCurrentV2#get_status_led_config → int¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

BrickletVoltageCurrentV2::STATUS_LED_CONFIG_OFF = 0
BrickletVoltageCurrentV2::STATUS_LED_CONFIG_ON = 1
BrickletVoltageCurrentV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletVoltageCurrentV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletVoltageCurrentV2#get_chip_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletVoltageCurrentV2#reset → nil¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletVoltageCurrentV2#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

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 2¹⁶ - 1]

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 2¹⁶ - 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¶

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

BrickletVoltageCurrentV2#set_current_callback_configuration(period, value_has_to_change, option, min, max) → nil¶

Parameter:

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Die Periode ist die Periode mit der der ::CALLBACK_CURRENT Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_CURRENT Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

BrickletVoltageCurrentV2#get_current_callback_configuration → [int, bool, chr, int, int]¶

Rückgabe-Array:

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false 2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 3: min – Typ: int, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 4: max – Typ: int, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
1: value_has_to_change – Typ: bool, Standardwert: false
2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
3: min – Typ: int, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
4: max – Typ: int, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels #set_current_callback_configuration gesetzt.

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

Für option:

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

BrickletVoltageCurrentV2#set_voltage_callback_configuration(period, value_has_to_change, option, min, max) → nil¶

Parameter:

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Die Periode ist die Periode mit der der ::CALLBACK_VOLTAGE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_VOLTAGE Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

BrickletVoltageCurrentV2#get_voltage_callback_configuration → [int, bool, chr, int, int]¶

Rückgabe-Array:

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false 2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 3: min – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 4: max – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
1: value_has_to_change – Typ: bool, Standardwert: false
2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
3: min – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
4: max – Typ: int, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels #set_voltage_callback_configuration gesetzt.

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

Für option:

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

BrickletVoltageCurrentV2#set_power_callback_configuration(period, value_has_to_change, option, min, max) → nil¶

Parameter:

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Die Periode ist die Periode mit der der ::CALLBACK_POWER Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_POWER Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

BrickletVoltageCurrentV2#get_power_callback_configuration → [int, bool, chr, int, int]¶

Rückgabe-Array:

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false 2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x' 3: min – Typ: int, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 4: max – Typ: int, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
1: value_has_to_change – Typ: bool, Standardwert: false
2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
3: min – Typ: int, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
4: max – Typ: int, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels #set_power_callback_configuration gesetzt.

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

Für option:

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

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:

voltage_current_v2.register_callback BrickletVoltageCurrentV2::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.

BrickletVoltageCurrentV2::CALLBACK_CURRENT¶

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_current_callback_configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie #get_current.

BrickletVoltageCurrentV2::CALLBACK_VOLTAGE¶

Callback-Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_voltage_callback_configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie #get_voltage.

BrickletVoltageCurrentV2::CALLBACK_POWER¶

Callback-Parameter:	power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_power_callback_configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie #get_power.

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.

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

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

BrickletVoltageCurrentV2::FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
BrickletVoltageCurrentV2::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
BrickletVoltageCurrentV2::FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
BrickletVoltageCurrentV2::FUNCTION_SET_CONFIGURATION = 13
BrickletVoltageCurrentV2::FUNCTION_SET_CALIBRATION = 15
BrickletVoltageCurrentV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletVoltageCurrentV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletVoltageCurrentV2::FUNCTION_RESET = 243
BrickletVoltageCurrentV2::FUNCTION_WRITE_UID = 248

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

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

Für function_id:

BrickletVoltageCurrentV2::FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
BrickletVoltageCurrentV2::FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
BrickletVoltageCurrentV2::FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
BrickletVoltageCurrentV2::FUNCTION_SET_CONFIGURATION = 13
BrickletVoltageCurrentV2::FUNCTION_SET_CALIBRATION = 15
BrickletVoltageCurrentV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletVoltageCurrentV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletVoltageCurrentV2::FUNCTION_RESET = 243
BrickletVoltageCurrentV2::FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletVoltageCurrentV2#set_bootloader_mode(mode) → int¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

BrickletVoltageCurrentV2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletVoltageCurrentV2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletVoltageCurrentV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletVoltageCurrentV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletVoltageCurrentV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

BrickletVoltageCurrentV2::BOOTLOADER_STATUS_OK = 0
BrickletVoltageCurrentV2::BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletVoltageCurrentV2::BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletVoltageCurrentV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletVoltageCurrentV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletVoltageCurrentV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletVoltageCurrentV2#get_bootloader_mode → int¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

Für mode:

BrickletVoltageCurrentV2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletVoltageCurrentV2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletVoltageCurrentV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletVoltageCurrentV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletVoltageCurrentV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletVoltageCurrentV2#set_write_firmware_pointer(pointer) → nil¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Setzt den Firmware-Pointer für #write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletVoltageCurrentV2#write_firmware(data) → int¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletVoltageCurrentV2#write_uid(uid) → nil¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletVoltageCurrentV2#read_uid → int¶

Rückgabe:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

BrickletVoltageCurrentV2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Voltage/Current Bricklet 2.0 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.

BrickletVoltageCurrentV2::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet 2.0 dar.