Tinkerforge::BrickletEnergyMonitor - Measures Voltage, Current, Energy, Real/Apparent/Reactive Power, Power Factor and Frequency
This constant is used to identify a Energy Monitor Bricklet.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a Energy Monitor Bricklet.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ENERGY_DATA callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
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.
Sets the energy value (see :func:`Get Energy Data`) back to 0Wh.
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.
Returns *true* if a voltage/current transformer is connected to the Bricklet.
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.
Returns the transformer calibration as set by :func:`Set Transformer Calibration`.
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 period is the period with which the :cb:`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.
Returns the callback configuration as set by :func:`Set Energy Data Callback Configuration`.
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.
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.
Returns the current bootloader mode, see :func:`Set Bootloader Mode`.
Sets the firmware pointer for :func:`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).
Writes 64 Bytes of firmware at the position as written by :func:`Set Write Firmware Pointer` before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
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.
Returns the configuration as set by :func:`Set Status LED Config`
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.
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!
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.
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.
The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.