public class BrickletEnergyMonitor extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletEnergyMonitor.EnergyData |
class |
BrickletEnergyMonitor.EnergyDataCallbackConfiguration |
static interface |
BrickletEnergyMonitor.EnergyDataListener
This listener is triggered periodically according to the configuration set by
setEnergyDataCallbackConfiguration(long, boolean) . |
class |
BrickletEnergyMonitor.SPITFPErrorCount |
class |
BrickletEnergyMonitor.TransformerCalibration |
class |
BrickletEnergyMonitor.TransformerStatus |
class |
BrickletEnergyMonitor.WaveformLowLevel |
Device.Identity
Constructor and Description |
---|
BrickletEnergyMonitor(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and 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, see
setBootloaderMode(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 by
setEnergyDataCallbackConfiguration(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 by
setStatusLEDConfig(int) |
BrickletEnergyMonitor.TransformerCalibration |
getTransformerCalibration()
Returns the transformer calibration as set by
setTransformerCalibration(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 (see
getEnergyData() ) 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 the
BrickletEnergyMonitor.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 for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_ENERGY_DATA
public static final byte FUNCTION_RESET_ENERGY
public static final byte FUNCTION_GET_WAVEFORM_LOW_LEVEL
public static final byte FUNCTION_GET_TRANSFORMER_STATUS
public static final byte FUNCTION_SET_TRANSFORMER_CALIBRATION
public static final byte FUNCTION_GET_TRANSFORMER_CALIBRATION
public static final byte FUNCTION_CALIBRATE_OFFSET
public static final byte FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ENERGY_DATA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletEnergyMonitor(String uid, IPConnection ipcon)
public BrickletEnergyMonitor.EnergyData getEnergyData() throws TinkerforgeException
TinkerforgeException
public void resetEnergy() throws TinkerforgeException
getEnergyData()
) back to 0Wh.TinkerforgeException
public BrickletEnergyMonitor.WaveformLowLevel getWaveformLowLevel() throws TinkerforgeException
TinkerforgeException
public BrickletEnergyMonitor.TransformerStatus getTransformerStatus() throws TinkerforgeException
TinkerforgeException
public void setTransformerCalibration(int voltageRatio, int currentRatio, int phaseShift) throws TinkerforgeException
TinkerforgeException
public BrickletEnergyMonitor.TransformerCalibration getTransformerCalibration() throws TinkerforgeException
setTransformerCalibration(int, int, int)
.TinkerforgeException
public void calibrateOffset() throws TinkerforgeException
TinkerforgeException
public void setEnergyDataCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletEnergyMonitor.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.TinkerforgeException
public BrickletEnergyMonitor.EnergyDataCallbackConfiguration getEnergyDataCallbackConfiguration() throws TinkerforgeException
setEnergyDataCallbackConfiguration(long, boolean)
.TinkerforgeException
public BrickletEnergyMonitor.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public int[] getWaveform() throws TinkerforgeException
TinkerforgeException
public void addEnergyDataListener(BrickletEnergyMonitor.EnergyDataListener listener)
public void removeEnergyDataListener(BrickletEnergyMonitor.EnergyDataListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.