Package com.tinkerforge
Class BrickletEnergyMonitor
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletEnergyMonitor
-
public class BrickletEnergyMonitor extends Device
Measures Voltage, Current, Energy, Real/Apparent/Reactive Power, Power Factor and Frequency
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletEnergyMonitor.EnergyData
class
BrickletEnergyMonitor.EnergyDataCallbackConfiguration
static interface
BrickletEnergyMonitor.EnergyDataListener
This listener is triggered periodically according to the configuration set bysetEnergyDataCallbackConfiguration(long, boolean)
.class
BrickletEnergyMonitor.SPITFPErrorCount
class
BrickletEnergyMonitor.TransformerCalibration
class
BrickletEnergyMonitor.TransformerStatus
class
BrickletEnergyMonitor.WaveformLowLevel
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletEnergyMonitor(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addEnergyDataListener(BrickletEnergyMonitor.EnergyDataListener listener)
Adds a EnergyData listener.void
calibrateOffset()
Calling this function will start an offset calibration.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.BrickletEnergyMonitor.EnergyData
getEnergyData()
Returns all of the measurements that are done by the Energy Monitor Bricklet.BrickletEnergyMonitor.EnergyDataCallbackConfiguration
getEnergyDataCallbackConfiguration()
Returns the listener configuration as set bysetEnergyDataCallbackConfiguration(long, boolean)
.Device.Identity
getIdentity()
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.BrickletEnergyMonitor.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
BrickletEnergyMonitor.TransformerCalibration
getTransformerCalibration()
Returns the transformer calibration as set bysetTransformerCalibration(int, int, int)
.BrickletEnergyMonitor.TransformerStatus
getTransformerStatus()
Returns *true* if a voltage/current transformer is connected to the Bricklet.int[]
getWaveform()
Returns a snapshot of the voltage and current waveform.BrickletEnergyMonitor.WaveformLowLevel
getWaveformLowLevel()
Returns a snapshot of the voltage and current waveform.long
readUID()
Returns the current UID as an integer.void
removeEnergyDataListener(BrickletEnergyMonitor.EnergyDataListener listener)
Removes a EnergyData listener.void
reset()
Calling this function will reset the Bricklet.void
resetEnergy()
Sets the energy value (seegetEnergyData()
) back to 0Wh.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setEnergyDataCallbackConfiguration(long period, boolean valueHasToChange)
The period is the period with which theBrickletEnergyMonitor.EnergyDataListener
listener is triggered periodically.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setTransformerCalibration(int voltageRatio, int currentRatio, int phaseShift)
Sets the transformer ratio for the voltage and current transformer in 1/100 form.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_ENERGY_DATA
public static final byte FUNCTION_GET_ENERGY_DATA
- See Also:
- Constant Field Values
-
FUNCTION_RESET_ENERGY
public static final byte FUNCTION_RESET_ENERGY
- See Also:
- Constant Field Values
-
FUNCTION_GET_WAVEFORM_LOW_LEVEL
public static final byte FUNCTION_GET_WAVEFORM_LOW_LEVEL
- See Also:
- Constant Field Values
-
FUNCTION_GET_TRANSFORMER_STATUS
public static final byte FUNCTION_GET_TRANSFORMER_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_SET_TRANSFORMER_CALIBRATION
public static final byte FUNCTION_SET_TRANSFORMER_CALIBRATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_TRANSFORMER_CALIBRATION
public static final byte FUNCTION_GET_TRANSFORMER_CALIBRATION
- See Also:
- Constant Field Values
-
FUNCTION_CALIBRATE_OFFSET
public static final byte FUNCTION_CALIBRATE_OFFSET
- See Also:
- Constant Field Values
-
FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_ENERGY_DATA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ENERGY_DATA_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletEnergyMonitor
public BrickletEnergyMonitor(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getEnergyData
public BrickletEnergyMonitor.EnergyData getEnergyData() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
resetEnergy
public void resetEnergy() throws TinkerforgeException
Sets the energy value (seegetEnergyData()
) back to 0Wh.- Throws:
TinkerforgeException
-
getWaveformLowLevel
public BrickletEnergyMonitor.WaveformLowLevel getWaveformLowLevel() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getTransformerStatus
public BrickletEnergyMonitor.TransformerStatus getTransformerStatus() throws TinkerforgeException
Returns *true* if a voltage/current transformer is connected to the Bricklet.- Throws:
TinkerforgeException
-
setTransformerCalibration
public void setTransformerCalibration(int voltageRatio, int currentRatio, int phaseShift) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getTransformerCalibration
public BrickletEnergyMonitor.TransformerCalibration getTransformerCalibration() throws TinkerforgeException
Returns the transformer calibration as set bysetTransformerCalibration(int, int, int)
.- Throws:
TinkerforgeException
-
calibrateOffset
public void calibrateOffset() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setEnergyDataCallbackConfiguration
public void setEnergyDataCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
The period is the period with which theBrickletEnergyMonitor.EnergyDataListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value.- Throws:
TinkerforgeException
-
getEnergyDataCallbackConfiguration
public BrickletEnergyMonitor.EnergyDataCallbackConfiguration getEnergyDataCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetEnergyDataCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletEnergyMonitor.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(int[])
. 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.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
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.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
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!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
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|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
getWaveform
public int[] getWaveform() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
addEnergyDataListener
public void addEnergyDataListener(BrickletEnergyMonitor.EnergyDataListener listener)
Adds a EnergyData listener.
-
removeEnergyDataListener
public void removeEnergyDataListener(BrickletEnergyMonitor.EnergyDataListener listener)
Removes a EnergyData listener.
-
-