MATLAB/Octave - Energy Monitor Bricklet

Dies ist die Beschreibung der MATLAB/Octave 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 MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

Download (matlab_example_simple.m)

 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
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletEnergyMonitor;

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

    ipcon = IPConnection(); % Create IP connection
    em = handle(BrickletEnergyMonitor(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current Energy Data
    energyData = em.getEnergyData();

    fprintf('Voltage: %g V\n', energyData.voltage/100.0);
    fprintf('Current: %g A\n', energyData.current/100.0);
    fprintf('Energy: %g Wh\n', energyData.energy/100.0);
    fprintf('Real Power: %g h\n', energyData.realPower/100.0);
    fprintf('Apparent Power: %g VA\n', energyData.apparentPower/100.0);
    fprintf('Reactive Power: %g VAR\n', energyData.reactivePower/100.0);
    fprintf('Power Factor: %g\n', energyData.powerFactor/1000.0);
    fprintf('Frequency: %g Hz\n', energyData.frequency/100.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletEnergyMonitor;

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

    ipcon = IPConnection(); % Create IP connection
    em = handle(BrickletEnergyMonitor(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register Energy Data callback to function cb_energy_data
    set(em, 'EnergyDataCallback', @(h, e) cb_energy_data(e));

    % Set period for Energy Data callback to 1s (1000ms)
    em.setEnergyDataCallbackConfiguration(1000, false);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for Energy Data callback
function cb_energy_data(e)
    fprintf('Voltage: %g V\n', e.voltage/100.0);
    fprintf('Current: %g A\n', e.current/100.0);
    fprintf('Energy: %g Wh\n', e.energy/100.0);
    fprintf('Real Power: %g h\n', e.realPower/100.0);
    fprintf('Apparent Power: %g VA\n', e.apparentPower/100.0);
    fprintf('Reactive Power: %g VAR\n', e.reactivePower/100.0);
    fprintf('Power Factor: %g\n', e.powerFactor/1000.0);
    fprintf('Frequency: %g Hz\n', e.frequency/100.0);
    fprintf('\n');
end

Simple (Octave)

Download (octave_example_simple.m)

 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
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Energy Monitor Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    em = javaObject("com.tinkerforge.BrickletEnergyMonitor", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current Energy Data
    energyData = em.getEnergyData();

    fprintf("Voltage: %g V\n", energyData.voltage/100.0);
    fprintf("Current: %g A\n", energyData.current/100.0);
    fprintf("Energy: %g Wh\n", energyData.energy/100.0);
    fprintf("Real Power: %g h\n", energyData.realPower/100.0);
    fprintf("Apparent Power: %g VA\n", energyData.apparentPower/100.0);
    fprintf("Reactive Power: %g VAR\n", energyData.reactivePower/100.0);
    fprintf("Power Factor: %g\n", energyData.powerFactor/1000.0);
    fprintf("Frequency: %g Hz\n", energyData.frequency/100.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)

Download (octave_example_callback.m)

 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
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Energy Monitor Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    em = javaObject("com.tinkerforge.BrickletEnergyMonitor", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register Energy Data callback to function cb_energy_data
    em.addEnergyDataCallback(@cb_energy_data);

    % Set period for Energy Data callback to 1s (1000ms)
    em.setEnergyDataCallbackConfiguration(1000, false);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for Energy Data callback
function cb_energy_data(e)
    fprintf("Voltage: %g V\n", e.voltage/100.0);
    fprintf("Current: %g A\n", e.current/100.0);
    fprintf("Energy: %g Wh\n", e.energy/100.0);
    fprintf("Real Power: %g h\n", e.realPower/100.0);
    fprintf("Apparent Power: %g VA\n", e.apparentPower/100.0);
    fprintf("Reactive Power: %g VAR\n", e.reactivePower/100.0);
    fprintf("Power Factor: %g\n", e.powerFactor/1000.0);
    fprintf("Frequency: %g Hz\n", e.frequency/100.0);
    fprintf("\n");
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletEnergyMonitor(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • energyMonitor – Typ: BrickletEnergyMonitor

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

In MATLAB:

import com.tinkerforge.BrickletEnergyMonitor;

energyMonitor = BrickletEnergyMonitor("YOUR_DEVICE_UID", ipcon);

In Octave:

energyMonitor = java_new("com.tinkerforge.BrickletEnergyMonitor", "YOUR_DEVICE_UID", ipcon);

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

BrickletEnergyMonitor.EnergyData BrickletEnergyMonitor.getEnergyData()
Rückgabeobjekt:
  • voltage – Typ: int, Einheit: 1/100 V, Wertebereich: [-231 bis 231 - 1]
  • current – Typ: int, Einheit: 1/100 A, Wertebereich: [-231 bis 231 - 1]
  • energy – Typ: int, Einheit: 1/100 Wh, Wertebereich: [-231 bis 231 - 1]
  • realPower – Typ: int, Einheit: 1/100 W, Wertebereich: [-231 bis 231 - 1]
  • apparentPower – Typ: int, Einheit: 1/100 VA, Wertebereich: [-231 bis 231 - 1]
  • reactivePower – Typ: int, Einheit: 1/100 var, Wertebereich: [-231 bis 231 - 1]
  • powerFactor – Typ: int, Einheit: 1/1000, Wertebereich: [0 bis 216 - 1]
  • frequency – Typ: int, Einheit: 1/100 Hz, Wertebereich: [0 bis 216 - 1]

Gibt alle Messdaten des Energy Monitor Bricklets zurück.

  • Voltage: RMS-Spannung (Effektivwert)
  • Current: RMS-Strom (Effektivwert)
  • Energy: Energie (integriert über Zeit)
  • Real Power: Wirkleistung
  • Apparent Power: Scheinleistung
  • Reactive Power: Blindleistung
  • Power Factor: Leistungsfaktor
  • Frequency: AC-Frequenz der Netzspannung

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.

void BrickletEnergyMonitor.resetEnergy()

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

int[] BrickletEnergyMonitor.getWaveform()
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.TransformerStatus BrickletEnergyMonitor.getTransformerStatus()
Rückgabeobjekt:
  • voltageTransformerConnected – Typ: boolean
  • currentTransformerConnected – Typ: boolean

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

void BrickletEnergyMonitor.setTransformerCalibration(int voltageRatio, int currentRatio, int phaseShift)
Parameter:
  • voltageRatio – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 1923
  • currentRatio – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 3000
  • phaseShift – Typ: int, Wertebereich: [0], Standardwert: 0

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.

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

BrickletEnergyMonitor.TransformerCalibration BrickletEnergyMonitor.getTransformerCalibration()
Rückgabeobjekt:
  • voltageRatio – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 1923
  • currentRatio – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 3000
  • phaseShift – Typ: int, Wertebereich: [0], Standardwert: 0

Gibt die Transformator-Kalibrierung zurück, wie von setTransformerCalibration() gesetzt.

void BrickletEnergyMonitor.calibrateOffset()

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.SPITFPErrorCount BrickletEnergyMonitor.getSPITFPErrorCount()
Rückgabeobjekt:
  • errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, 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.

int BrickletEnergyMonitor.setBootloaderMode(int mode)
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:

  • 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
int BrickletEnergyMonitor.getBootloaderMode()
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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
void BrickletEnergyMonitor.setWriteFirmwarePointer(long pointer)
Parameter:
  • pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). 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.

int BrickletEnergyMonitor.writeFirmware(int[] data)
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 setWriteFirmwarePointer() 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.

void BrickletEnergyMonitor.setStatusLEDConfig(int config)
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:

  • 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
int BrickletEnergyMonitor.getStatusLEDConfig()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() 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
int BrickletEnergyMonitor.getChipTemperature()
Rückgabe:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 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.

void BrickletEnergyMonitor.reset()

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.

void BrickletEnergyMonitor.writeUID(long uid)
Parameter:
  • uid – Typ: long, 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.

long BrickletEnergyMonitor.readUID()
Rückgabe:
  • uid – Typ: long, 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.Identity BrickletEnergyMonitor.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: revision – Typ: int, Wertebereich: [0 bis 255]
  • deviceIdentifier – 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

void BrickletEnergyMonitor.setEnergyDataCallbackConfiguration(long period, boolean valueHasToChange)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false

Die Periode ist die Periode mit der der EnergyDataCallback 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.EnergyDataCallbackConfiguration BrickletEnergyMonitor.getEnergyDataCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels setEnergyDataCallbackConfiguration() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletEnergyMonitor.EnergyDataCallback
Event-Objekt:
  • voltage – Typ: int, Einheit: 1/100 V, Wertebereich: [-231 bis 231 - 1]
  • current – Typ: int, Einheit: 1/100 A, Wertebereich: [-231 bis 231 - 1]
  • energy – Typ: int, Einheit: 1/100 Wh, Wertebereich: [-231 bis 231 - 1]
  • realPower – Typ: int, Einheit: 1/100 W, Wertebereich: [-231 bis 231 - 1]
  • apparentPower – Typ: int, Einheit: 1/100 VA, Wertebereich: [-231 bis 231 - 1]
  • reactivePower – Typ: int, Einheit: 1/100 var, Wertebereich: [-231 bis 231 - 1]
  • powerFactor – Typ: int, Einheit: 1/1000, Wertebereich: [0 bis 216 - 1]
  • frequency – Typ: int, Einheit: 1/100 Hz, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setEnergyDataCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der gleiche wie getEnergyData().

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addEnergyDataCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeEnergyDataCallback() wieder entfernt werden.

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.

int[] BrickletEnergyMonitor.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: 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.

boolean BrickletEnergyMonitor.getResponseExpected(int functionId)
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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 setResponseExpected(). 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 functionId:

  • 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
void BrickletEnergyMonitor.setResponseExpected(int functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ä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 functionId:

  • 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
void BrickletEnergyMonitor.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

int BrickletEnergyMonitor.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Energy Monitor Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletEnergyMonitor.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Energy Monitor Bricklet dar.