com.yoctopuce.YoctoAPI

Class YPower

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YSensor

com.yoctopuce.YoctoAPI.YPower

public class YPower
extends YSensor

YPower Class: electrical power sensor control interface, available for instance in the Yocto-Watt The YPower class allows you to read and configure Yoctopuce electrical power sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, and to access the autonomous datalogger. This class adds the ability to access the energy counter and the power factor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YPower.TimedReportCallback TimedReportCallback for Power
static interface	YPower.UpdateCallback Deprecated UpdateCallback for Power

Field Summary

Fields

Modifier and Type	Field and Description
protected double	_cosPhi
protected double	_deliveredEnergyMeter
protected double	_meter
protected int	_meterTimer
protected double	_powerFactor
protected double	_receivedEnergyMeter
protected YPower.TimedReportCallback	_timedReportCallbackPower
protected YPower.UpdateCallback	_valueCallbackPower
static double	COSPHI_INVALID invalid cosPhi value
static double	DELIVEREDENERGYMETER_INVALID invalid deliveredEnergyMeter value
static double	METER_INVALID invalid meter value
static int	METERTIMER_INVALID invalid meterTimer value
static double	POWERFACTOR_INVALID invalid powerFactor value
static double	RECEIVEDENERGYMETER_INVALID invalid receivedEnergyMeter value

Fields inherited from class com.yoctopuce.YoctoAPI.YSensor

_advMode, _cal, _calibrationParam, _currentRawValue, _currentValue, _highestValue, _iresol, _logFrequency, _lowestValue, _prevTR, _reportFrequency, _resolution, _sensorState, _timedReportCallbackSensor, _unit, _valueCallbackSensor, ADVMODE_IMMEDIATE, ADVMODE_INVALID, ADVMODE_PERIOD_AVG, ADVMODE_PERIOD_MAX, ADVMODE_PERIOD_MIN, CALIBRATIONPARAM_INVALID, CURRENTRAWVALUE_INVALID, CURRENTVALUE_INVALID, HIGHESTVALUE_INVALID, LOGFREQUENCY_INVALID, LOWESTVALUE_INVALID, REPORTFREQUENCY_INVALID, RESOLUTION_INVALID, SENSORSTATE_INVALID, UNIT_INVALID

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YPower(String func)
protected	YPower(YAPIContext ctx, String func)

Method Summary

Modifier and Type	Method and Description
int	_invokeTimedReportCallback(YMeasure value)
int	_invokeValueCallback(String value)
protected void	_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
static YPower	FindPower(String func) Retrieves a electrical power sensor for a given identifier.
static YPower	FindPowerInContext(YAPIContext yctx, String func) Retrieves a electrical power sensor for a given identifier in a YAPI context.
static YPower	FirstPower() Starts the enumeration of electrical power sensors currently accessible.
static YPower	FirstPowerInContext(YAPIContext yctx) Starts the enumeration of electrical power sensors currently accessible.
double	get_cosPhi() Returns the Displacement Power factor (DPF), i.e.
double	get_deliveredEnergyMeter() Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when positive.
double	get_meter() Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time.
int	get_meterTimer() Returns the elapsed time since last energy counter reset, in seconds.
double	get_powerFactor() Returns the power factor (PF), i.e.
double	get_receivedEnergyMeter() Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when negative.
double	getCosPhi() Returns the Displacement Power factor (DPF), i.e.
double	getDeliveredEnergyMeter() Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when positive.
double	getMeter() Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time.
int	getMeterTimer() Returns the elapsed time since last energy counter reset, in seconds.
double	getPowerFactor() Returns the power factor (PF), i.e.
double	getReceivedEnergyMeter() Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when negative.
YPower	nextPower() Continues the enumeration of electrical power sensors started using yFirstPower().
int	registerTimedReportCallback(YPower.TimedReportCallback callback) Registers the callback function that is invoked on every periodic timed notification.
int	registerValueCallback(YPower.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	reset() Resets the energy counters.
int	set_meter(double newval)

Methods inherited from class com.yoctopuce.YoctoAPI.YSensor

_applyCalibration, _decodeAvg, _decodeTimedReport, _decodeVal, _encodeCalibrationPoints, _parseCalibStr, _parserHelper, calibrateFromPoints, FindSensor, FindSensorInContext, FirstSensor, FirstSensorInContext, get_advMode, get_calibrationParam, get_currentRawValue, get_currentValue, get_dataLogger, get_highestValue, get_logFrequency, get_lowestValue, get_recordedData, get_reportFrequency, get_resolution, get_sensorState, get_unit, getAdvMode, getCurrentRawValue, getCurrentValue, getHighestValue, getLogFrequency, getLowestValue, getReportFrequency, getResolution, getSensorState, getUnit, isSensorReady, loadCalibrationPoints, nextSensor, registerTimedReportCallback, registerValueCallback, set_advMode, set_calibrationParam, set_highestValue, set_logFrequency, set_lowestValue, set_reportFrequency, set_resolution, setAdvMode, setHighestValue, setLogFrequency, setLowestValue, setReportFrequency, setResolution, startDataLogger, stopDataLogger

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _is_valid_pass, _json_get_array, _json_get_key, _json_get_string, _parse, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

POWERFACTOR_INVALID

public static final double POWERFACTOR_INVALID

invalid powerFactor value

See Also:

Constant Field Values

COSPHI_INVALID

public static final double COSPHI_INVALID

invalid cosPhi value

See Also:

Constant Field Values

METER_INVALID

public static final double METER_INVALID

invalid meter value

See Also:

Constant Field Values

DELIVEREDENERGYMETER_INVALID

public static final double DELIVEREDENERGYMETER_INVALID

invalid deliveredEnergyMeter value

See Also:

Constant Field Values

RECEIVEDENERGYMETER_INVALID

public static final double RECEIVEDENERGYMETER_INVALID

invalid receivedEnergyMeter value

See Also:

Constant Field Values

METERTIMER_INVALID

public static final int METERTIMER_INVALID

invalid meterTimer value

See Also:

Constant Field Values

_powerFactor

protected double _powerFactor

_cosPhi

protected double _cosPhi

_meter

protected double _meter

_deliveredEnergyMeter

protected double _deliveredEnergyMeter

_receivedEnergyMeter

protected double _receivedEnergyMeter

_meterTimer

protected int _meterTimer

_valueCallbackPower

protected YPower.UpdateCallback _valueCallbackPower

_timedReportCallbackPower

protected YPower.TimedReportCallback _timedReportCallbackPower

Constructor Detail

YPower

protected YPower(YAPIContext ctx,
                 String func)

Parameters:

func - : functionid

YPower

protected YPower(String func)

Parameters:

func - : functionid

Method Detail

_parseAttr

protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception

Overrides:

_parseAttr in class YSensor

Throws:

Exception

get_powerFactor

public double get_powerFactor()
                       throws YAPI_Exception

Returns the power factor (PF), i.e. ratio between the active power consumed (in W) and the apparent power provided (VA).

Returns:

a floating point number corresponding to the power factor (PF), i.e

Throws:

YAPI_Exception - on error

getPowerFactor

public double getPowerFactor()
                      throws YAPI_Exception

Returns the power factor (PF), i.e. ratio between the active power consumed (in W) and the apparent power provided (VA).

Returns:

a floating point number corresponding to the power factor (PF), i.e

Throws:

YAPI_Exception - on error

get_cosPhi

public double get_cosPhi()
                  throws YAPI_Exception

Returns the Displacement Power factor (DPF), i.e. cosine of the phase shift between the voltage and current fundamentals. On the Yocto-Watt (V1), the value returned by this method correponds to the power factor as this device is cannot estimate the true DPF.

Returns:

a floating point number corresponding to the Displacement Power factor (DPF), i.e

Throws:

YAPI_Exception - on error

getCosPhi

public double getCosPhi()
                 throws YAPI_Exception

Returns the Displacement Power factor (DPF), i.e. cosine of the phase shift between the voltage and current fundamentals. On the Yocto-Watt (V1), the value returned by this method correponds to the power factor as this device is cannot estimate the true DPF.

Returns:

a floating point number corresponding to the Displacement Power factor (DPF), i.e

Throws:

YAPI_Exception - on error

set_meter

public int set_meter(double newval)
              throws YAPI_Exception

Throws:

YAPI_Exception

get_meter

public double get_meter()
                 throws YAPI_Exception

Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time. This is the sum of forward and backwad energy transfers, if you are insterested in only one direction, use get_receivedEnergyMeter() or get_deliveredEnergyMeter(). Note that this counter is reset at each start of the device.

Returns:

a floating point number corresponding to the energy counter, maintained by the wattmeter by integrating the power consumption over time

Throws:

YAPI_Exception - on error

getMeter

public double getMeter()
                throws YAPI_Exception

Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time. This is the sum of forward and backwad energy transfers, if you are insterested in only one direction, use get_receivedEnergyMeter() or get_deliveredEnergyMeter(). Note that this counter is reset at each start of the device.

Returns:

a floating point number corresponding to the energy counter, maintained by the wattmeter by integrating the power consumption over time

Throws:

YAPI_Exception - on error

get_deliveredEnergyMeter

public double get_deliveredEnergyMeter()
                                throws YAPI_Exception

Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when positive. Note that this counter is reset at each start of the device.

Returns:

a floating point number corresponding to the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when positive

Throws:

YAPI_Exception - on error

getDeliveredEnergyMeter

public double getDeliveredEnergyMeter()
                               throws YAPI_Exception

Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when positive. Note that this counter is reset at each start of the device.

Returns:

a floating point number corresponding to the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when positive

Throws:

YAPI_Exception - on error

get_receivedEnergyMeter

public double get_receivedEnergyMeter()
                               throws YAPI_Exception

Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when negative. Note that this counter is reset at each start of the device.

Returns:

a floating point number corresponding to the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when negative

Throws:

YAPI_Exception - on error

getReceivedEnergyMeter

public double getReceivedEnergyMeter()
                              throws YAPI_Exception

Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when negative. Note that this counter is reset at each start of the device.

Returns:

a floating point number corresponding to the energy counter, maintained by the wattmeter by integrating the power consumption over time, but only when negative

Throws:

YAPI_Exception - on error

get_meterTimer

public int get_meterTimer()
                   throws YAPI_Exception

Returns the elapsed time since last energy counter reset, in seconds.

Returns:

an integer corresponding to the elapsed time since last energy counter reset, in seconds

Throws:

YAPI_Exception - on error

getMeterTimer

public int getMeterTimer()
                  throws YAPI_Exception

Returns the elapsed time since last energy counter reset, in seconds.

Returns:

an integer corresponding to the elapsed time since last energy counter reset, in seconds

Throws:

YAPI_Exception - on error

FindPower

public static YPower FindPower(String func)

Retrieves a electrical power sensor for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the electrical power sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPower.isOnline() to test if the electrical power sensor is indeed online at a given time. In case of ambiguity when looking for a electrical power sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name. If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters:

func - : a string that uniquely characterizes the electrical power sensor, for instance YWATTMK1.power.

Returns:

a YPower object allowing you to drive the electrical power sensor.

FindPowerInContext

public static YPower FindPowerInContext(YAPIContext yctx,
                                        String func)

Retrieves a electrical power sensor for a given identifier in a YAPI context. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the electrical power sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPower.isOnline() to test if the electrical power sensor is indeed online at a given time. In case of ambiguity when looking for a electrical power sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

Parameters:

yctx - : a YAPI context

func - : a string that uniquely characterizes the electrical power sensor, for instance YWATTMK1.power.

Returns:

a YPower object allowing you to drive the electrical power sensor.

registerValueCallback

public int registerValueCallback(YPower.UpdateCallback callback)

Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a null pointer as argument.

Parameters:

callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.

_invokeValueCallback

public int _invokeValueCallback(String value)

Overrides:

_invokeValueCallback in class YSensor

registerTimedReportCallback

public int registerTimedReportCallback(YPower.TimedReportCallback callback)

Registers the callback function that is invoked on every periodic timed notification. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a null pointer as argument.

Parameters:

callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the function object of which the value has changed, and an YMeasure object describing the new advertised value.

_invokeTimedReportCallback

public int _invokeTimedReportCallback(YMeasure value)

Overrides:

_invokeTimedReportCallback in class YSensor

reset

public int reset()
          throws YAPI_Exception

Resets the energy counters.

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

nextPower

public YPower nextPower()

Continues the enumeration of electrical power sensors started using yFirstPower(). Caution: You can't make any assumption about the returned electrical power sensors order. If you want to find a specific a electrical power sensor, use Power.findPower() and a hardwareID or a logical name.

Returns:

a pointer to a YPower object, corresponding to a electrical power sensor currently online, or a null pointer if there are no more electrical power sensors to enumerate.

FirstPower

public static YPower FirstPower()

Starts the enumeration of electrical power sensors currently accessible. Use the method YPower.nextPower() to iterate on next electrical power sensors.

Returns:

a pointer to a YPower object, corresponding to the first electrical power sensor currently online, or a null pointer if there are none.

FirstPowerInContext

public static YPower FirstPowerInContext(YAPIContext yctx)

Starts the enumeration of electrical power sensors currently accessible. Use the method YPower.nextPower() to iterate on next electrical power sensors.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YPower object, corresponding to the first electrical power sensor currently online, or a null pointer if there are none.