MQTT - Energy Monitor Bricklet¶

Simple¶

Download (example-simple.txt)

1
2
3
4
5
6

# Change XYZ to the UID of your Energy Monitor Bricklet

setup:
    # Get current energy data
    subscribe to tinkerforge/response/energy_monitor_bricklet/XYZ/get_energy_data
    publish '' to tinkerforge/request/energy_monitor_bricklet/XYZ/get_energy_data

Callback¶

Download (example-callback.txt)

1
2
3
4
5
6
7
8
9

# Change XYZ to the UID of your Energy Monitor Bricklet

setup:
    # Handle incoming energy data callbacks
    subscribe to tinkerforge/callback/energy_monitor_bricklet/XYZ/energy_data
    publish '{"register": true}' to tinkerforge/register/energy_monitor_bricklet/XYZ/energy_data # Register energy_data callback

    # Set period for energy data callback to 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false}' to tinkerforge/request/energy_monitor_bricklet/XYZ/set_energy_data_callback_configuration

Basic Functions¶

request/energy_monitor_bricklet/<UID>/get_energy_data¶

Request:

empty payload

Response:

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.

request/energy_monitor_bricklet/<UID>/reset_energy¶

Request:	empty payload
Response:	no response

Sets the energy value (see request/energy_monitor_bricklet/<UID>/get_energy_data) back to 0Wh.

request/energy_monitor_bricklet/<UID>/get_waveform¶

Request:	empty payload
Response:	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.

request/energy_monitor_bricklet/<UID>/get_transformer_status¶

Request:	empty payload
Response:	voltage_transformer_connected – Type: bool current_transformer_connected – Type: bool

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

request/energy_monitor_bricklet/<UID>/set_transformer_calibration¶

Request:	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
Response:	no response

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.

request/energy_monitor_bricklet/<UID>/get_transformer_calibration¶

Request:	empty payload
Response:	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 request/energy_monitor_bricklet/<UID>/set_transformer_calibration.

request/energy_monitor_bricklet/<UID>/calibrate_offset¶

Request:	empty payload
Response:	no response

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¶

request/energy_monitor_bricklet/<UID>/get_spitfp_error_count¶

Request:	empty payload
Response:	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.

request/energy_monitor_bricklet/<UID>/set_status_led_config¶

Request:	config – Type: int, Range: See symbols, Default: 3
Response:	no response

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:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/energy_monitor_bricklet/<UID>/get_status_led_config¶

Request:	empty payload
Response:	config – Type: int, Range: See symbols, Default: 3

Returns the configuration as set by request/energy_monitor_bricklet/<UID>/set_status_led_config

The following symbols are available for this function:

For config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/energy_monitor_bricklet/<UID>/get_chip_temperature¶

Request:	empty payload
Response:	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.

request/energy_monitor_bricklet/<UID>/reset¶

Request:	empty payload
Response:	no response

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!

request/energy_monitor_bricklet/<UID>/get_identity¶

Request:

empty payload

Response:

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, ...], 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, ...], 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] _display_name – Type: string

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. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Energy Monitor's name in a human readable form.

Callback Configuration Functions¶

request/energy_monitor_bricklet/<UID>/set_energy_data_callback_configuration¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Response:	no response

The period is the period with which the register/energy_monitor_bricklet/<UID>/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.

request/energy_monitor_bricklet/<UID>/get_energy_data_callback_configuration¶

Request:	empty payload
Response:	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 request/energy_monitor_bricklet/<UID>/set_energy_data_callback_configuration.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

register/energy_monitor_bricklet/<UID>/energy_data¶

Register Request:

register – Type: bool

Callback Response:

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]

A callback can be registered for this event by publishing to the .../register/energy_monitor_bricklet/<UID>/energy_data[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/energy_monitor_bricklet/<UID>/energy_data[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically according to the configuration set by request/energy_monitor_bricklet/<UID>/set_energy_data_callback_configuration.

The callback payload members are the same as request/energy_monitor_bricklet/<UID>/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.

request/energy_monitor_bricklet/<UID>/set_bootloader_mode¶

Request:	mode – Type: int, Range: See symbols
Response:	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" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

For status:

• "ok" = 0
• "invalid_mode" = 1
• "no_change" = 2
• "entry_function_not_present" = 3
• "device_identifier_incorrect" = 4
• "crc_mismatch" = 5

request/energy_monitor_bricklet/<UID>/get_bootloader_mode¶

Request:	empty payload
Response:	mode – Type: int, Range: See symbols

Returns the current bootloader mode, see request/energy_monitor_bricklet/<UID>/set_bootloader_mode.

The following symbols are available for this function:

For mode:

• "bootloader" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

request/energy_monitor_bricklet/<UID>/set_write_firmware_pointer¶

Request:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Response:	no response

Sets the firmware pointer for request/energy_monitor_bricklet/<UID>/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.

request/energy_monitor_bricklet/<UID>/write_firmware¶

Request:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Response:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by request/energy_monitor_bricklet/<UID>/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.

request/energy_monitor_bricklet/<UID>/write_uid¶

Request:	uid – Type: int, Range: [0 to 232 - 1]
Response:	no response

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.

request/energy_monitor_bricklet/<UID>/read_uid¶

Request:	empty payload
Response:	uid – Type: int, Range: [0 to 232 - 1]

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