Ruby - Energy Monitor Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Energy Monitor Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Energy Monitor 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
30
31
32
33
34
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_energy_monitor'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
em = BrickletEnergyMonitor.new UID, ipcon # Create device object

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

# Get current Energy Data as [voltage, current, energy, real_power, apparent_power,
#                             reactive_power, power_factor, frequency]
energy_data = em.get_energy_data

puts "Voltage: #{energy_data[0]/100.0} V"
puts "Current: #{energy_data[1]/100.0} A"
puts "Energy: #{energy_data[2]/100.0} Wh"
puts "Real Power: #{energy_data[3]/100.0} h"
puts "Apparent Power: #{energy_data[4]/100.0} VA"
puts "Reactive Power: #{energy_data[5]/100.0} VAR"
puts "Power Factor: #{energy_data[6]/1000.0}"
puts "Frequency: #{energy_data[7]/100.0} Hz"

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
35
36
37
38
39
40
41
42
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_energy_monitor'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
em = BrickletEnergyMonitor.new UID, ipcon # Create device object

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

# Register Energy Data callback
em.register_callback(BrickletEnergyMonitor::CALLBACK_ENERGY_DATA) do |voltage, current,
                                                                      energy, real_power,
                                                                      apparent_power,
                                                                      reactive_power,
                                                                      power_factor,
                                                                      frequency|
  puts "Voltage: #{voltage/100.0} V"
  puts "Current: #{current/100.0} A"
  puts "Energy: #{energy/100.0} Wh"
  puts "Real Power: #{real_power/100.0} h"
  puts "Apparent Power: #{apparent_power/100.0} VA"
  puts "Reactive Power: #{reactive_power/100.0} VAR"
  puts "Power Factor: #{power_factor/1000.0}"
  puts "Frequency: #{frequency/100.0} Hz"
  puts ''
end

# Set period for Energy Data callback to 1s (1000ms)
em.set_energy_data_callback_configuration 1000, false

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletEnergyMonitor::new(uid, ipcon) → energy_monitor
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • energy_monitor – Typ: BrickletEnergyMonitor

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

energy_monitor = BrickletEnergyMonitor.new 'YOUR_DEVICE_UID', ipcon

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

BrickletEnergyMonitor#get_energy_data → [int, int, int, int, int, int, int, int]
Rückgabe-Array:
  • 0: voltage – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 1: current – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 2: energy – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 3: real_power – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 4: apparent_power – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 5: reactive_power – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 6: power_factor – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 7: frequency – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt alle Messdaten des Energy Monitor Bricklets zurück.

  • Voltage (V): RMS-Spannung (Effektivwert) mit einer Auflösung von 10mV (Beispiel: 230,05V = 23005)
  • Current (A): RMS-Strom (Effektivwert) mit einer Auflösung von 10mA (Beispiel: 1,42A = 142)
  • Energy (Wh): Energie (integriert über Zeit) mit einer Auflösung von 10mWh (Beispiel: 1,1kWh = 110000)
  • Real Power (W): Wirkleistung mit einer Auflösung von 10mW (Beispiel: 1234,56W = 123456)
  • Apparent Power (VA): Scheinleistung mit einer Auflösung von 10mVA (Beispiel: 1234,56VA = 123456)
  • Reactive Power (VAR): Blindleistung mit einer Auflösung von 10mVAR (Beispiel: 1234,56VAR = 123456)
  • Power Factor: Leistungsfaktor mit einer Auflösung von 1/1000 (Beispiel: PF 0,995 = 995)
  • Frequency (Hz): AC-Frequenz der Netzspannung mit einer Auflösung von 1/100 Hz (Beispiel: 50Hz = 5000)

Die Frequenz wird alle 6 Sekunden neu berechnet.

Alle anderen Werte werden über 10 Nulldurchgänge der Spannungs-Sinuskurve integriert. Mit einer Standard Netzspannungsfrequenz von 50Hz entspricht das 5 Messungen pro Sekunde (oder einer Integrationszeit von 200ms pro Messung).

Wenn kein Spannungstransformator angeschlossen ist, nutzt das Bricklet den Kurvenverlauf des Stroms, um die Frequenz zu bestimmen und die Integrationszeit beträgt 10 Nulldurchläufe der Strom-Sinuskurve.

BrickletEnergyMonitor#reset_energy → nil

Setzt den Energiewert (siehe #get_energy_data) zurück auf 0Wh

BrickletEnergyMonitor#get_waveform → [int, ...]
Rückgabe:
  • waveform – Typ: [int, ...], Länge: 1536, Wertebereich: [-215 bis 215 - 1]

Gibt eine Momentaufnahme des Spannungs- und Stromkurvenverlaufs zurück. Die Werte im zurückgegebenen Array alternieren zwischen Spannung und Strom. Die Daten eines Getter-Aufrufs beinhalten 768 Datenpunkte für Spannung und Strom, diese korrespondieren zu ungefähr 3 vollen Sinuskurven.

Die Spannung hat eine Auflösung von 100mV und der Strom hat eine Auflösung von 10mA.

Die Daten können für eine grafische Repräsentation (nicht-Realzeit) der Kurvenverläufe genutzt werden.

BrickletEnergyMonitor#get_transformer_status → [bool, bool]
Rückgabe-Array:
  • 0: voltage_transformer_connected – Typ: bool
  • 1: current_transformer_connected – Typ: bool

Gibt true zurück wenn ein Spannungs-/Stromtransformator mit dem Bricklet verbunden ist.

BrickletEnergyMonitor#set_transformer_calibration(voltage_ratio, current_ratio, phase_shift) → nil
Parameter:
  • voltage_ratio – Typ: int, Wertebereich: [0 bis 216 - 1]
  • current_ratio – Typ: int, Wertebereich: [0 bis 216 - 1]
  • phase_shift – Typ: int, Wertebereich: [-215 bis 215 - 1]

Setzt das Transformer-Verhältnis für Strom und Spannung in Hundertstel.

Beispiel: Wenn die Netzspannung 230V beträgt und ein 9V Spannungstransformer sowie eine 1V:30A Spannungszange verwendet wird, ergibt das ein Spannungsverhältnis von 230/9 = 25,56 und ein Stromverhältnis von 30/1 = 30.

In diesem Fall müssten also die Werte 2556 und 3000 gesetzt werden.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal gesetzt werden.

Im Auslieferungszustand ist das Spannungsverhältnis auf 1923 und das Stromverhältnis auf 3000 gesetzt.

Der Parameter Phase Shift muss auf 0 gesetzt werden. Dieser Parameter wird aktuell von der Firmware nicht genutzt.

BrickletEnergyMonitor#get_transformer_calibration → [int, int, int]
Rückgabe-Array:
  • 0: voltage_ratio – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 1: current_ratio – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: phase_shift – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Transformator-Kalibrierung zurück, wie von #set_transformer_calibration gesetzt.

BrickletEnergyMonitor#calibrate_offset → nil

Ein Aufruf dieser Funktion startet eine Offset-Kalibrierung. Dazu werden die Spannungs- und Stromkurvenverläufe über einen längeren Zeitraum aufsummiert, um den Nulldurchgangspunkt der Sinuskurve zu finden.

Der Offset für das Bricklet wird von Tinkerforge ab Werk kalibriert. Ein Aufruf dieser Funktion sollte also nicht notwendig sein.

Wenn der Offset rekalibriert werden soll, empfehlen wir entweder eine Last anzuschließen, die eine glatte Sinuskurve für Spannung und Strom erzeugt, oder die beiden Eingänge kurzzuschließen.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal gesetzt werden.

Fortgeschrittene Funktionen

BrickletEnergyMonitor#get_api_version → [int, ...]
Rückgabe:
  • api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

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.

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

  • BrickletEnergyMonitor::FUNCTION_RESET_ENERGY = 2
  • BrickletEnergyMonitor::FUNCTION_SET_TRANSFORMER_CALIBRATION = 5
  • BrickletEnergyMonitor::FUNCTION_CALIBRATE_OFFSET = 7
  • BrickletEnergyMonitor::FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION = 8
  • BrickletEnergyMonitor::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletEnergyMonitor::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletEnergyMonitor::FUNCTION_RESET = 243
  • BrickletEnergyMonitor::FUNCTION_WRITE_UID = 248
BrickletEnergyMonitor#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:

  • BrickletEnergyMonitor::FUNCTION_RESET_ENERGY = 2
  • BrickletEnergyMonitor::FUNCTION_SET_TRANSFORMER_CALIBRATION = 5
  • BrickletEnergyMonitor::FUNCTION_CALIBRATE_OFFSET = 7
  • BrickletEnergyMonitor::FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION = 8
  • BrickletEnergyMonitor::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletEnergyMonitor::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletEnergyMonitor::FUNCTION_RESET = 243
  • BrickletEnergyMonitor::FUNCTION_WRITE_UID = 248
BrickletEnergyMonitor#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.

BrickletEnergyMonitor#get_spitfp_error_count → [int, int, int, int]
Rückgabe-Array:
  • 0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 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.

BrickletEnergyMonitor#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 Bootlodaer- 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:

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

Für status:

  • BrickletEnergyMonitor::BOOTLOADER_STATUS_OK = 0
  • BrickletEnergyMonitor::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletEnergyMonitor::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletEnergyMonitor::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletEnergyMonitor::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletEnergyMonitor::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletEnergyMonitor#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:

  • BrickletEnergyMonitor::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletEnergyMonitor::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletEnergyMonitor::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletEnergyMonitor::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletEnergyMonitor::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletEnergyMonitor#set_write_firmware_pointer(pointer) → nil
Parameter:
  • pointer – Typ: int, Wertebereich: [0 bis 232 - 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.

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

BrickletEnergyMonitor#set_status_led_config(config) → nil
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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:

  • BrickletEnergyMonitor::STATUS_LED_CONFIG_OFF = 0
  • BrickletEnergyMonitor::STATUS_LED_CONFIG_ON = 1
  • BrickletEnergyMonitor::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletEnergyMonitor::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletEnergyMonitor#get_status_led_config → int
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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:

  • BrickletEnergyMonitor::STATUS_LED_CONFIG_OFF = 0
  • BrickletEnergyMonitor::STATUS_LED_CONFIG_ON = 1
  • BrickletEnergyMonitor::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletEnergyMonitor::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletEnergyMonitor#get_chip_temperature → int
Rückgabe:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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.

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

BrickletEnergyMonitor#write_uid(uid) → nil
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 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.

BrickletEnergyMonitor#read_uid → int
Rückgabe:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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

BrickletEnergyMonitor#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
  • 3: hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: firmware_version – Typ: [int, ...], Länge: 3, 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 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.

Konfigurationsfunktionen für Callbacks

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

BrickletEnergyMonitor#set_energy_data_callback_configuration(period, value_has_to_change) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_ENERGY_DATA 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.

BrickletEnergyMonitor#get_energy_data_callback_configuration → [int, bool]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_energy_data_callback_configuration 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:

energy_monitor.register_callback BrickletEnergyMonitor::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.

BrickletEnergyMonitor::CALLBACK_ENERGY_DATA
Callback-Parameter:
  • voltage – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • current – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • energy – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • real_power – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • apparent_power – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • reactive_power – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • power_factor – Typ: int, Wertebereich: [0 bis 216 - 1]
  • frequency – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Die Parameter sind der gleiche wie #get_energy_data.

Konstanten

BrickletEnergyMonitor::DEVICE_IDENTIFIER

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

BrickletEnergyMonitor::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Energy Monitor Bricklet dar.