Software / API Bindings / JavaScript / API Reference and Examples / Bricklets / Energy Monitor Bricklet

JavaScript - Energy Monitor Bricklet¶

This is the description of the JavaScript 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 JavaScript API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple (Node.js)¶

Download (ExampleSimple.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var em = new Tinkerforge.BrickletEnergyMonitor(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get current energy data
        em.getEnergyData(
            function (voltage, current, energy, realPower, apparentPower, reactivePower, powerFactor, frequency) {
                console.log('Voltage: ' + voltage/100.0 + ' V');
                console.log('Current: ' + current/100.0 + ' A');
                console.log('Energy: ' + energy/100.0 + ' Wh');
                console.log('Real Power: ' + realPower/100.0 + ' h');
                console.log('Apparent Power: ' + apparentPower/100.0 + ' VA');
                console.log('Reactive Power: ' + reactivePower/100.0 + ' var');
                console.log('Power Factor: ' + powerFactor/1000.0);
                console.log('Frequency: ' + frequency/100.0 + ' Hz');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (Node.js)¶

Download (ExampleCallback.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var em = new Tinkerforge.BrickletEnergyMonitor(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Set period for energy data callback to 1s (1000ms)
        em.setEnergyDataCallbackConfiguration(1000, false);
    }
);

// Register energy data callback
em.on(Tinkerforge.BrickletEnergyMonitor.CALLBACK_ENERGY_DATA,
    // Callback function for energy data callback
    function (voltage, current, energy, realPower, apparentPower, reactivePower,
              powerFactor, frequency) {
        console.log('Voltage: ' + voltage/100.0 + ' V');
        console.log('Current: ' + current/100.0 + ' A');
        console.log('Energy: ' + energy/100.0 + ' Wh');
        console.log('Real Power: ' + realPower/100.0 + ' h');
        console.log('Apparent Power: ' + apparentPower/100.0 + ' VA');
        console.log('Reactive Power: ' + reactivePower/100.0 + ' var');
        console.log('Power Factor: ' + powerFactor/1000.0);
        console.log('Frequency: ' + frequency/100.0 + ' Hz');
        console.log();
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Simple (HTML)¶

Download (ExampleSimple.html), Test (ExampleSimple.html)

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Energy Monitor Bricklet Simple Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var em = new Tinkerforge.BrickletEnergyMonitor(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get current energy data
                        em.getEnergyData(
                            function (voltage, current, energy, realPower, apparentPower, reactivePower, powerFactor, frequency) {
                                textArea.value += 'Voltage: ' + voltage/100.0 + ' V\n';
                                textArea.value += 'Current: ' + current/100.0 + ' A\n';
                                textArea.value += 'Energy: ' + energy/100.0 + ' Wh\n';
                                textArea.value += 'Real Power: ' + realPower/100.0 + ' h\n';
                                textArea.value += 'Apparent Power: ' + apparentPower/100.0 + ' VA\n';
                                textArea.value += 'Reactive Power: ' + reactivePower/100.0 + ' var\n';
                                textArea.value += 'Power Factor: ' + powerFactor/1000.0 + '\n';
                                textArea.value += 'Frequency: ' + frequency/100.0 + ' Hz\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)¶

Download (ExampleCallback.html), Test (ExampleCallback.html)

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Energy Monitor Bricklet Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var em = new Tinkerforge.BrickletEnergyMonitor(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Set period for energy data callback to 1s (1000ms)
                        em.setEnergyDataCallbackConfiguration(1000, false);
                    }
                );

                // Register energy data callback
                em.on(Tinkerforge.BrickletEnergyMonitor.CALLBACK_ENERGY_DATA,
                    // Callback function for energy data callback
                    function (voltage, current, energy, realPower, apparentPower, reactivePower,
                              powerFactor, frequency) {
                        textArea.value += 'Voltage: ' + voltage/100.0 + ' V\n';
                        textArea.value += 'Current: ' + current/100.0 + ' A\n';
                        textArea.value += 'Energy: ' + energy/100.0 + ' Wh\n';
                        textArea.value += 'Real Power: ' + realPower/100.0 + ' h\n';
                        textArea.value += 'Apparent Power: ' + apparentPower/100.0 + ' VA\n';
                        textArea.value += 'Reactive Power: ' + reactivePower/100.0 + ' var\n';
                        textArea.value += 'Power Factor: ' + powerFactor/1000.0 + '\n';
                        textArea.value += 'Frequency: ' + frequency/100.0 + ' Hz\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API¶

Generally, every function of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback function is called with the results as arguments, if the function returns its results asynchronously. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:

IPConnection.ERROR_ALREADY_CONNECTED = 11
IPConnection.ERROR_NOT_CONNECTED = 12
IPConnection.ERROR_CONNECT_FAILED = 13
IPConnection.ERROR_INVALID_FUNCTION_ID = 21
IPConnection.ERROR_TIMEOUT = 31
IPConnection.ERROR_INVALID_PARAMETER = 41
IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
IPConnection.ERROR_UNKNOWN_ERROR = 43
IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions¶

new BrickletEnergyMonitor(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	energyMonitor – Type: BrickletEnergyMonitor

Creates an object with the unique device ID uid:

var energyMonitor = new BrickletEnergyMonitor("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

BrickletEnergyMonitor.getEnergyData([returnCallback][, errorCallback])¶

Callback Parameters:

Callback Parameters:	voltage – Type: int, Unit: 1/100 V, Range: [-2³¹ to 2³¹ - 1] current – Type: int, Unit: 1/100 A, Range: [-2³¹ to 2³¹ - 1] energy – Type: int, Unit: 1/100 Wh, Range: [-2³¹ to 2³¹ - 1] realPower – Type: int, Unit: 1/100 W, Range: [-2³¹ to 2³¹ - 1] apparentPower – Type: int, Unit: 1/100 VA, Range: [-2³¹ to 2³¹ - 1] reactivePower – Type: int, Unit: 1/100 var, Range: [-2³¹ to 2³¹ - 1] powerFactor – Type: int, Unit: 1/1000, Range: [0 to 2¹⁶ - 1] frequency – Type: int, Unit: 1/100 Hz, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

voltage – Type: int, Unit: 1/100 V, Range: [-2³¹ to 2³¹ - 1]
current – Type: int, Unit: 1/100 A, Range: [-2³¹ to 2³¹ - 1]
energy – Type: int, Unit: 1/100 Wh, Range: [-2³¹ to 2³¹ - 1]
realPower – Type: int, Unit: 1/100 W, Range: [-2³¹ to 2³¹ - 1]
apparentPower – Type: int, Unit: 1/100 VA, Range: [-2³¹ to 2³¹ - 1]
reactivePower – Type: int, Unit: 1/100 var, Range: [-2³¹ to 2³¹ - 1]
powerFactor – Type: int, Unit: 1/1000, Range: [0 to 2¹⁶ - 1]
frequency – Type: int, Unit: 1/100 Hz, Range: [0 to 2¹⁶ - 1]

Returns:

undefined

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

Voltage RMS
Current RMS
Energy (integrated over time)
Real Power
Apparent Power
Reactive Power
Power Factor
Frequency (AC Frequency of the mains voltage)

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.

BrickletEnergyMonitor.resetEnergy([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

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

BrickletEnergyMonitor.getWaveform([returnCallback][, errorCallback])¶

Callback Parameters:	waveform – Type: [int, ...], Length: 1536, Range: [-2¹⁵ to 2¹⁵ - 1]
Returns:	undefined

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.getTransformerStatus([returnCallback][, errorCallback])¶

Callback Parameters:	voltageTransformerConnected – Type: boolean currentTransformerConnected – Type: boolean
Returns:	undefined

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

BrickletEnergyMonitor.setTransformerCalibration(voltageRatio, currentRatio, phaseShift[, returnCallback][, errorCallback])¶

Parameters:	voltageRatio – Type: int, Range: [0 to 2¹⁶ - 1], Default: 1923 currentRatio – Type: int, Range: [0 to 2¹⁶ - 1], Default: 3000 phaseShift – Type: int, Range: [0], Default: 0
Callback Parameters:	undefined
Returns:	undefined

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.

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

BrickletEnergyMonitor.getTransformerCalibration([returnCallback][, errorCallback])¶

Callback Parameters:	voltageRatio – Type: int, Range: [0 to 2¹⁶ - 1], Default: 1923 currentRatio – Type: int, Range: [0 to 2¹⁶ - 1], Default: 3000 phaseShift – Type: int, Range: [0], Default: 0
Returns:	undefined

Returns the transformer calibration as set by setTransformerCalibration().

BrickletEnergyMonitor.calibrateOffset([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

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¶

BrickletEnergyMonitor.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback Parameters:	errorCountAckChecksum – Type: int, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: int, Range: [0 to 2³² - 1] errorCountFrame – Type: int, Range: [0 to 2³² - 1] errorCountOverflow – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

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.

BrickletEnergyMonitor.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

Parameters:	config – Type: int, Range: See constants, Default: 3
Callback Parameters:	undefined
Returns:	undefined

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

BrickletEnergyMonitor.getStatusLEDConfig([returnCallback][, errorCallback])¶

Callback Parameters:	config – Type: int, Range: See constants, Default: 3
Returns:	undefined

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

BrickletEnergyMonitor.getChipTemperature([returnCallback][, errorCallback])¶

Callback Parameters:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]
Returns:	undefined

Returns the temperature 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.

BrickletEnergyMonitor.reset([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

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!

BrickletEnergyMonitor.getIdentity([returnCallback][, errorCallback])¶

Callback Parameters:

Callback Parameters:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

firmwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

Returns:

undefined

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions¶

BrickletEnergyMonitor.on(callback_id, function[, errorCallback])¶

Parameters:	callback_id – Type: int function – Type: function
Returns:	undefined

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletEnergyMonitor.setEnergyDataCallbackConfiguration(period, valueHasToChange[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false
Callback Parameters:	undefined
Returns:	undefined

The period is the period with which the CALLBACK_ENERGY_DATA 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.getEnergyDataCallbackConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false
Returns:	undefined

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 the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

energyMonitor.on(BrickletEnergyMonitor.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters 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.

BrickletEnergyMonitor.CALLBACK_ENERGY_DATA¶

Callback Parameters:

Callback Parameters:	voltage – Type: int, Unit: 1/100 V, Range: [-2³¹ to 2³¹ - 1] current – Type: int, Unit: 1/100 A, Range: [-2³¹ to 2³¹ - 1] energy – Type: int, Unit: 1/100 Wh, Range: [-2³¹ to 2³¹ - 1] realPower – Type: int, Unit: 1/100 W, Range: [-2³¹ to 2³¹ - 1] apparentPower – Type: int, Unit: 1/100 VA, Range: [-2³¹ to 2³¹ - 1] reactivePower – Type: int, Unit: 1/100 var, Range: [-2³¹ to 2³¹ - 1] powerFactor – Type: int, Unit: 1/1000, Range: [0 to 2¹⁶ - 1] frequency – Type: int, Unit: 1/100 Hz, Range: [0 to 2¹⁶ - 1]

voltage – Type: int, Unit: 1/100 V, Range: [-2³¹ to 2³¹ - 1]
current – Type: int, Unit: 1/100 A, Range: [-2³¹ to 2³¹ - 1]
energy – Type: int, Unit: 1/100 Wh, Range: [-2³¹ to 2³¹ - 1]
realPower – Type: int, Unit: 1/100 W, Range: [-2³¹ to 2³¹ - 1]
apparentPower – Type: int, Unit: 1/100 VA, Range: [-2³¹ to 2³¹ - 1]
reactivePower – Type: int, Unit: 1/100 var, Range: [-2³¹ to 2³¹ - 1]
powerFactor – Type: int, Unit: 1/1000, Range: [0 to 2¹⁶ - 1]
frequency – Type: int, Unit: 1/100 Hz, Range: [0 to 2¹⁶ - 1]

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

The parameters are the same as getEnergyData().

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletEnergyMonitor.getAPIVersion()¶

Returns:	apiVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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.

BrickletEnergyMonitor.getResponseExpected(functionId[, errorCallback])¶

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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.setResponseExpected(functionId, responseExpected[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants responseExpected – Type: boolean
Returns:	undefined

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.

The following constants are available for this function:

For 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.setResponseExpectedAll(responseExpected)¶

Parameters:	responseExpected – Type: boolean
Returns:	undefined

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletEnergyMonitor.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

Parameters:	mode – Type: int, Range: See constants
Callback Parameters:	status – Type: int, Range: See constants
Returns:	undefined

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

BrickletEnergyMonitor.getBootloaderMode([returnCallback][, errorCallback])¶

Callback Parameters:	mode – Type: int, Range: See constants
Returns:	undefined

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

BrickletEnergyMonitor.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
Callback Parameters:	undefined
Returns:	undefined

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.

BrickletEnergyMonitor.writeFirmware(data[, returnCallback][, errorCallback])¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Callback Parameters:	status – Type: int, Range: [0 to 255]
Returns:	undefined

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.

BrickletEnergyMonitor.writeUID(uid[, returnCallback][, errorCallback])¶

Parameters:	uid – Type: int, Range: [0 to 2³² - 1]
Callback Parameters:	undefined
Returns:	undefined

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.

BrickletEnergyMonitor.readUID([returnCallback][, errorCallback])¶

Callback Parameters:	uid – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

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

Constants¶

BrickletEnergyMonitor.DEVICE_IDENTIFIER¶

This constant is used to identify a Energy Monitor Bricklet.

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

BrickletEnergyMonitor.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Energy Monitor Bricklet.