Shell - Energy Monitor Bricklet¶

Simple¶

Download (example-simple.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Energy Monitor Bricklet

# Get current energy data
tinkerforge call energy-monitor-bricklet $uid get-energy-data

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Energy Monitor Bricklet

# Handle incoming energy data callbacks
tinkerforge dispatch energy-monitor-bricklet $uid energy-data &

# Set period for energy data callback to 1s (1000ms)
tinkerforge call energy-monitor-bricklet $uid set-energy-data-callback-configuration 1000 false

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call energy-monitor-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Energy Monitor Bricklet. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the Energy Monitor Bricklet and exits

tinkerforge dispatch energy-monitor-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Energy Monitor Bricklet. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the Energy Monitor Bricklet and exits

tinkerforge call energy-monitor-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch energy-monitor-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call energy-monitor-bricklet <uid> get-energy-data¶

Output:

voltage – Type: Int, Unit: 1/100 V, Range: [-231 to 231 - 1] current – Type: Int, Unit: 1/100 A, Range: [-231 to 231 - 1] energy – Type: Int, Unit: 1/100 Wh, Range: [-231 to 231 - 1] real-power – Type: Int, Unit: 1/100 W, Range: [-231 to 231 - 1] apparent-power – Type: Int, Unit: 1/100 VA, Range: [-231 to 231 - 1] reactive-power – Type: Int, Unit: 1/100 var, Range: [-231 to 231 - 1] power-factor – Type: Int, Unit: 1/1000, Range: [0 to 216 - 1] frequency – Type: Int, Unit: 1/100 Hz, Range: [0 to 216 - 1]

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.

tinkerforge call energy-monitor-bricklet <uid> reset-energy¶

Output:	no output

Sets the energy value (see get-energy-data) back to 0Wh.

tinkerforge call energy-monitor-bricklet <uid> get-waveform¶

Output:	waveform – Type: Int Array, 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.

tinkerforge call energy-monitor-bricklet <uid> get-transformer-status¶

Output:	voltage-transformer-connected – Type: Bool current-transformer-connected – Type: Bool

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

tinkerforge call energy-monitor-bricklet <uid> set-transformer-calibration <voltage-ratio> <current-ratio> <phase-shift>¶

Parameters:	<voltage-ratio> – Type: Int, Range: [0 to 216 - 1], Default: 1923 <current-ratio> – Type: Int, Range: [0 to 216 - 1], Default: 3000 <phase-shift> – Type: Int, Range: [0], Default: 0
Output:	no output

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.

tinkerforge call energy-monitor-bricklet <uid> get-transformer-calibration¶

Output:	voltage-ratio – Type: Int, Range: [0 to 216 - 1], Default: 1923 current-ratio – Type: Int, Range: [0 to 216 - 1], Default: 3000 phase-shift – Type: Int, Range: [0], Default: 0

Returns the transformer calibration as set by set-transformer-calibration.

tinkerforge call energy-monitor-bricklet <uid> calibrate-offset¶

Output:	no output

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¶

tinkerforge call energy-monitor-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, 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.

tinkerforge call energy-monitor-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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 symbols are available for this function:

For <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call energy-monitor-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call energy-monitor-bricklet <uid> get-chip-temperature¶

Output:	temperature – Type: Int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

tinkerforge call energy-monitor-bricklet <uid> reset¶

Output:	no output

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!

tinkerforge call energy-monitor-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, 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] firmware-version – Type: Int Array, 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] device-identifier – 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', '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. 

Callback Configuration Functions¶

tinkerforge call energy-monitor-bricklet <uid> set-energy-data-callback-configuration <period> <value-has-to-change>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 <value-has-to-change> – Type: Bool, Default: false
Output:	no output

The period is the period with which the 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.

tinkerforge call energy-monitor-bricklet <uid> get-energy-data-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-energy-data-callback-configuration.

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch energy-monitor-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch energy-monitor-bricklet <uid> energy-data¶

Output:

voltage – Type: Int, Unit: 1/100 V, Range: [-231 to 231 - 1] current – Type: Int, Unit: 1/100 A, Range: [-231 to 231 - 1] energy – Type: Int, Unit: 1/100 Wh, Range: [-231 to 231 - 1] real-power – Type: Int, Unit: 1/100 W, Range: [-231 to 231 - 1] apparent-power – Type: Int, Unit: 1/100 VA, Range: [-231 to 231 - 1] reactive-power – Type: Int, Unit: 1/100 var, Range: [-231 to 231 - 1] power-factor – Type: Int, Unit: 1/1000, Range: [0 to 216 - 1] frequency – Type: Int, Unit: 1/100 Hz, Range: [0 to 216 - 1]

This callback is triggered periodically according to the configuration set by set-energy-data-callback-configuration.

The parameters are the same as get-energy-data.

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.

tinkerforge call energy-monitor-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

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 symbols are available for this function:

For <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call energy-monitor-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call energy-monitor-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

Sets the firmware pointer for write-firmware. 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.

tinkerforge call energy-monitor-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer 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.

tinkerforge call energy-monitor-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

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.

tinkerforge call energy-monitor-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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