MATLAB/Octave - Energy Monitor Bricklet

This is the description of the MATLAB/Octave API bindings for the Energy Monitor Bricklet. General information and technical specifications for the Energy Monitor Bricklet are summarized in its hardware description.

An installation guide for the MATLAB/Octave API bindings is part of their general description.

Examples

The example code below is 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

Generally, every method of the MATLAB bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

class BrickletEnergyMonitor(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • energyMonitor – Type: BrickletEnergyMonitor

Creates an object with the unique device 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);

This object can then be used after the IP Connection is connected (see examples above).

BrickletEnergyMonitor.EnergyData BrickletEnergyMonitor.getEnergyData()
Return Object:
  • voltage – Type: int, Range: [-231 to 231 - 1]
  • current – Type: int, Range: [-231 to 231 - 1]
  • energy – Type: int, Range: [-231 to 231 - 1]
  • realPower – Type: int, Range: [-231 to 231 - 1]
  • apparentPower – Type: int, Range: [-231 to 231 - 1]
  • reactivePower – Type: int, Range: [-231 to 231 - 1]
  • powerFactor – Type: int, Range: [0 to 216 - 1]
  • frequency – Type: int, Range: [0 to 216 - 1]

Returns all of the measurements that are done by the Energy Monitor Bricklet.

  • Voltage (V): Voltage RMS with a resolution of 10mV (example: 230.05V = 23005)
  • Current (A): Current RMS with a resolution of 10mA (example: 1.42A = 142)
  • Energy (Wh): Energy (integrated over time) with a resolution of 10mWh (example: 1.1kWh = 110000)
  • Real Power (W): Real Power with a resolution of 10mW (example: 1234.56W = 123456)
  • Apparent Power (VA): Apparent Power with a resolution of 10mVA (example: 1234.56VA = 123456)
  • Reactive Power (VAR): Reactive Power with a resolution of 10mVAR (example: 1234.56VAR = 123456)
  • Power Factor: Power Factor with a resolution of 1/1000 (example: PF 0.995 = 995)
  • Frequency (Hz): AC Frequency of the mains voltage with a resolution of 1/100 Hz (example: 50Hz = 5000)

The frequency is recalculated every 6 seconds.

All other values are integrated over 10 zero-crossings of the voltage sine wave. With a standard AC mains voltage frequency of 50Hz this results in a 5 measurements per second (or an integration time of 200ms per measurement).

If no voltage transformer is connected, the Bricklet will use the current waveform to calculate the frequency and it will use an integration time of 10 zero-crossings of the current waveform.

void BrickletEnergyMonitor.resetEnergy()

Sets the energy value (see getEnergyData()) back to 0Wh.

int[] BrickletEnergyMonitor.getWaveform()
Returns:
  • waveform – Type: int[], Length: 1536, Range: [-215 to 215 - 1]

Returns a snapshot of the voltage and current waveform. The values in the returned array alternate between voltage and current. The data from one getter call contains 768 data points for voltage and current, which correspond to about 3 full sine waves.

The voltage is given with a resolution of 100mV and the current is given with a resolution of 10mA.

This data is meant to be used for a non-realtime graphical representation of the voltage and current waveforms.

BrickletEnergyMonitor.TransformerStatus BrickletEnergyMonitor.getTransformerStatus()
Return Object:
  • voltageTransformerConnected – Type: boolean
  • currentTransformerConnected – Type: boolean

Returns true if a voltage/current transformer is connected to the Bricklet.

void BrickletEnergyMonitor.setTransformerCalibration(int voltageRatio, int currentRatio, int phaseShift)
Parameters:
  • voltageRatio – Type: int, Range: [0 to 216 - 1]
  • currentRatio – Type: int, Range: [0 to 216 - 1]
  • phaseShift – Type: int, Range: [-215 to 215 - 1]

Sets the transformer ratio for the voltage and current transformer in 1/100 form.

Example: If your mains voltage is 230V, you use 9V voltage transformer and a 1V:30A current clamp your voltage ratio is 230/9 = 25.56 and your current ratio is 30/1 = 30.

In this case you have to set the values 2556 and 3000 for voltage ratio and current ratio.

The calibration is saved in non-volatile memory, you only have to set it once.

By default the voltage ratio is set to 1923 and the current ratio is set to 3000.

Set the phase shift to 0. It is for future use and currently not supported by the Bricklet.

BrickletEnergyMonitor.TransformerCalibration BrickletEnergyMonitor.getTransformerCalibration()
Return Object:
  • voltageRatio – Type: int, Range: [0 to 216 - 1]
  • currentRatio – Type: int, Range: [0 to 216 - 1]
  • phaseShift – Type: int, Range: [-215 to 215 - 1]

Returns the transformer calibration as set by setTransformerCalibration().

void BrickletEnergyMonitor.calibrateOffset()

Calling this function will start an offset calibration. The offset calibration will integrate the voltage and current waveform over a longer time period to find the 0 transition point in the sine wave.

The Bricklet comes with a factory-calibrated offset value, you should not have to call this function.

If you want to re-calibrate the offset we recommend that you connect a load that has a smooth sinusoidal voltage and current waveform. Alternatively you can also short both inputs.

The calibration is saved in non-volatile memory, you only have to set it once.

Advanced Functions

int[] BrickletEnergyMonitor.getAPIVersion()
Returns:
  • apiVersion – Type: int[], Length: 3, Range: [0 to 255]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

boolean BrickletEnergyMonitor.getResponseExpected(int functionId)
Parameters:
  • functionId – Type: int, Range: See constants
Returns:
  • responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)
Parameters:
  • functionId – Type: int, Range: See constants
  • responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)
Parameters:
  • responseExpected – Type: boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletEnergyMonitor.SPITFPErrorCount BrickletEnergyMonitor.getSPITFPErrorCount()
Return Object:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

int BrickletEnergyMonitor.setBootloaderMode(int mode)
Parameters:
  • mode – Type: int, Range: See constants
Returns:
  • status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For 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

For 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()
Returns:
  • mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For 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)
Parameters:
  • pointer – Type: long, Range: [0 to 232 - 1]

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletEnergyMonitor.writeFirmware(int[] data)
Parameters:
  • data – Type: int[], Length: 64, Range: [0 to 255]
Returns:
  • status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletEnergyMonitor.setStatusLEDConfig(int config)
Parameters:
  • config – Type: int, Range: See constants

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For 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()
Returns:
  • config – Type: int, Range: See constants

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For 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()
Returns:
  • temperature – Type: int, Range: [-215 to 215 - 1]

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletEnergyMonitor.reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

void BrickletEnergyMonitor.writeUID(long uid)
Parameters:
  • uid – Type: long, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

long BrickletEnergyMonitor.readUID()
Returns:
  • uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletEnergyMonitor.Identity BrickletEnergyMonitor.getIdentity()
Return Object:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char
  • hardwareVersion – Type: int[], Length: 3, Range: [0 to 255]
  • firmwareVersion – Type: int[], Length: 3, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

void BrickletEnergyMonitor.setEnergyDataCallbackConfiguration(long period, boolean valueHasToChange)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

The period is the period with which the EnergyDataCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletEnergyMonitor.EnergyDataCallbackConfiguration BrickletEnergyMonitor.getEnergyDataCallbackConfiguration()
Return Object:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by setEnergyDataCallbackConfiguration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

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

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

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

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

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

callback BrickletEnergyMonitor.EnergyDataCallback
Event Object:
  • voltage – Type: int, Range: [-231 to 231 - 1]
  • current – Type: int, Range: [-231 to 231 - 1]
  • energy – Type: int, Range: [-231 to 231 - 1]
  • realPower – Type: int, Range: [-231 to 231 - 1]
  • apparentPower – Type: int, Range: [-231 to 231 - 1]
  • reactivePower – Type: int, Range: [-231 to 231 - 1]
  • powerFactor – Type: int, Range: [0 to 216 - 1]
  • frequency – Type: int, Range: [0 to 216 - 1]

This callback is triggered periodically according to the configuration set by setEnergyDataCallbackConfiguration().

The parameters are the same as getEnergyData().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addEnergyDataCallback() function. An added callback function can be removed with the removeEnergyDataCallback() function.

Constants

int BrickletEnergyMonitor.DEVICE_IDENTIFIER

This constant is used to identify a Energy Monitor Bricklet.

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletEnergyMonitor.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Energy Monitor Bricklet.