#include <yocto_power.h>

Inheritance diagram for YPower:

Public Member Functions
virtual int	_invokeTimedReportCallback (YMeasure value)

virtual int	_invokeValueCallback (string value)

double	cosPhi (void)

double	get_cosPhi (void)

double	get_meter (void)

int	get_meterTimer (void)

double	meter (void)

int	meterTimer (void)

YPower *	next (void)

YPower *	nextPower (void)

virtual int	registerTimedReportCallback (YPowerTimedReportCallback callback)

virtual int	registerValueCallback (YPowerValueCallback callback)

virtual int	reset (void)

int	set_meter (double newval)

int	setMeter (double newval)

	~YPower ()

Public Member Functions inherited from YSensor
virtual double	_applyCalibration (double rawValue)

virtual double	_decodeAvg (int dw)

virtual YMeasure	_decodeTimedReport (double timestamp, vector< int > report)

virtual double	_decodeVal (int w)

virtual string	_encodeCalibrationPoints (vector< double > rawValues, vector< double > refValues)

virtual int	_parserHelper (void)

Y_ADVMODE_enum	advMode (void)

virtual int	calibrateFromPoints (vector< double > rawValues, vector< double > refValues)

string	calibrationParam (void)

double	currentRawValue (void)

double	currentValue (void)

Y_ADVMODE_enum	get_advMode (void)

string	get_calibrationParam (void)

double	get_currentRawValue (void)

double	get_currentValue (void)

virtual YDataLogger *	get_dataLogger (void)

double	get_highestValue (void)

string	get_logFrequency (void)

double	get_lowestValue (void)

virtual YDataSet	get_recordedData (s64 startTime, s64 endTime)

string	get_reportFrequency (void)

double	get_resolution (void)

int	get_sensorState (void)

string	get_unit (void)

double	highestValue (void)

virtual bool	isSensorReady (void)

virtual int	loadCalibrationPoints (vector< double > &rawValues, vector< double > &refValues)

string	logFrequency (void)

double	lowestValue (void)

YSensor *	next (void)

YSensor *	nextSensor (void)

virtual int	registerTimedReportCallback (YSensorTimedReportCallback callback)

virtual int	registerValueCallback (YSensorValueCallback callback)

string	reportFrequency (void)

double	resolution (void)

int	sensorState (void)

int	set_advMode (Y_ADVMODE_enum newval)

int	set_calibrationParam (const string &newval)

int	set_highestValue (double newval)

int	set_logFrequency (const string &newval)

int	set_lowestValue (double newval)

int	set_reportFrequency (const string &newval)

int	set_resolution (double newval)

int	setAdvMode (Y_ADVMODE_enum newval)

int	setCalibrationParam (const string &newval)

int	setHighestValue (double newval)

int	setLogFrequency (const string &newval)

int	setLowestValue (double newval)

int	setReportFrequency (const string &newval)

int	setResolution (double newval)

virtual int	startDataLogger (void)

virtual int	stopDataLogger (void)

string	unit (void)

	~YSensor ()

Public Member Functions inherited from YFunction
void	_clearDataStreamCache ()

string	_decode_json_string (const string &json)

string	_download (const string &url)

YDataStream *	_findDataStream (YDataSet &dataset, const string &def)

string	_get_json_path (const string &json, const string &path)

vector< string >	_json_get_array (const string &json)

string	_json_get_key (const string &json, const string &data)

string	_json_get_string (const string &json)

int	_parseEx (yJsonStateMachine &j)

string	_parseString (yJsonStateMachine &j)

string	_request (const string &request)

string	_requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context)

void	_throw (YRETCODE errType, string errMsg)

YRETCODE	_upload (const string &path, const string &content)

YRETCODE	_uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context)

string	advertisedValue (void)

void	clearCache ()

string	describe (void)

string	errMessage (void)

string	errorMessage (void)

YRETCODE	errorType (void)

YRETCODE	errType (void)

YFUN_DESCR	functionDescriptor (void)

string	get_advertisedValue (void)

string	get_errorMessage (void)

YRETCODE	get_errorType (void)

virtual string	get_friendlyName (void)

YFUN_DESCR	get_functionDescriptor (void)

string	get_functionId (void)

string	get_hardwareId (void)

string	get_hubSerial ()

string	get_logicalName (void)

YModule *	get_module (void)

void *	get_userData (void)

bool	isOnline (void)

YRETCODE	load (int msValidity)

virtual string	loadAttribute (string attrName)

string	logicalName (void)

YModule *	module (void)

virtual int	muteValueCallbacks (void)

YFunction *	next (void)

YFunction *	nextFunction (void)

virtual int	registerValueCallback (YFunctionValueCallback callback)

int	set_advertisedValue (const string &newval)

int	set_logicalName (const string &newval)

void	set_userData (void *data)

int	setAdvertisedValue (const string &newval)

int	setLogicalName (const string &newval)

void	setUserData (void *data)

virtual int	unmuteValueCallbacks (void)

void *	userData (void)

virtual	~YFunction ()

Static Public Member Functions
static YPower *	Find (string func)

static YPower *	FindPower (string func)

static YPower *	First (void)

static YPower *	FirstPower (void)

Static Public Member Functions inherited from YSensor
static YSensor *	Find (string func)

static YSensor *	FindSensor (string func)

static YSensor *	First (void)

static YSensor *	FirstSensor (void)

Static Public Member Functions inherited from YFunction
static void	_ClearCache (void)

static YFunction *	Find (string func)

static YFunction *	FindFunction (string func)

static YFunction *	First (void)

static YFunction *	FirstFunction (void)

Static Public Attributes
static const double	COSPHI_INVALID = YAPI_INVALID_DOUBLE

static const double	METER_INVALID = YAPI_INVALID_DOUBLE

static const int	METERTIMER_INVALID = YAPI_INVALID_UINT

Static Public Attributes inherited from YSensor
static const Y_ADVMODE_enum	ADVMODE_IMMEDIATE = Y_ADVMODE_IMMEDIATE

static const Y_ADVMODE_enum	ADVMODE_INVALID = Y_ADVMODE_INVALID

static const Y_ADVMODE_enum	ADVMODE_PERIOD_AVG = Y_ADVMODE_PERIOD_AVG

static const Y_ADVMODE_enum	ADVMODE_PERIOD_MAX = Y_ADVMODE_PERIOD_MAX

static const Y_ADVMODE_enum	ADVMODE_PERIOD_MIN = Y_ADVMODE_PERIOD_MIN

static const string	CALIBRATIONPARAM_INVALID = YAPI_INVALID_STRING

static const double	CURRENTRAWVALUE_INVALID = YAPI_INVALID_DOUBLE

static const double	CURRENTVALUE_INVALID = YAPI_INVALID_DOUBLE

static const double	HIGHESTVALUE_INVALID = YAPI_INVALID_DOUBLE

static const string	LOGFREQUENCY_INVALID = YAPI_INVALID_STRING

static const double	LOWESTVALUE_INVALID = YAPI_INVALID_DOUBLE

static const string	REPORTFREQUENCY_INVALID = YAPI_INVALID_STRING

static const double	RESOLUTION_INVALID = YAPI_INVALID_DOUBLE

static const int	SENSORSTATE_INVALID = YAPI_INVALID_INT

static const string	UNIT_INVALID = YAPI_INVALID_STRING

Static Public Attributes inherited from YFunction
static const string	ADVERTISEDVALUE_INVALID = YAPI_INVALID_STRING

static const string	FRIENDLYNAME_INVALID = YAPI_INVALID_STRING

static const YFUN_DESCR	FUNCTIONDESCRIPTOR_INVALID = Y_FUNCTIONDESCRIPTOR_INVALID

static const string	FUNCTIONID_INVALID = YAPI_INVALID_STRING

static const string	HARDWAREID_INVALID = YAPI_INVALID_STRING

static const string	LOGICALNAME_INVALID = YAPI_INVALID_STRING

Protected Member Functions
virtual int	_parseAttr (YJSONObject *json_val)

	YPower (const string &func)

Protected Member Functions inherited from YSensor
	YSensor (const string &func)

Protected Member Functions inherited from YFunction
YRETCODE	_buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg)

string	_escapeAttr (const string &changeval)

YRETCODE	_getDescriptor (YFUN_DESCR &fundescr, string &errMsg)

YRETCODE	_getDevice (YDevice *&dev, string &errMsg)

YRETCODE	_load_unsafe (int msValidity)

YRETCODE	_nextFunction (string &hwId)

int	_parse (YJSONObject *j)

YRETCODE	_setAttr (string attrname, string newvalue)

	YFunction (const string &func)

Protected Attributes
double	_cosPhi

double	_meter

int	_meterTimer

YPowerTimedReportCallback	_timedReportCallbackPower

YPowerValueCallback	_valueCallbackPower

Protected Attributes inherited from YSensor
Y_ADVMODE_enum	_advMode

yCalibrationHandler	_calhdl

string	_calibrationParam

vector< int >	_calpar

vector< double >	_calraw

vector< double >	_calref

int	_caltyp

double	_currentRawValue

double	_currentValue

double	_decexp

double	_highestValue

double	_iresol

bool	_isScal

bool	_isScal32

string	_logFrequency

double	_lowestValue

double	_offset

double	_prevTimedReport

string	_reportFrequency

double	_resolution

double	_scale

int	_sensorState

YSensorTimedReportCallback	_timedReportCallbackSensor

string	_unit

YSensorValueCallback	_valueCallbackSensor

Protected Attributes inherited from YFunction
string	_advertisedValue

u64	_cacheExpiration

string	_className

std::map< string, YDataStream * >	_dataStreams

string	_func

YFUN_DESCR	_fundescr

string	_funId

string	_hwId

string	_lastErrorMsg

YRETCODE	_lastErrorType

string	_logicalName

string	_serial

yCRITICAL_SECTION	_this_cs

void *	_userData

YFunctionValueCallback	_valueCallbackFunction

Friends
YPower *	yFindPower (const string &func)

YPower *	yFirstPower (void)

Additional Inherited Members
Static Protected Member Functions inherited from YFunction
static void	_AddToCache (const string &classname, const string &func, YFunction *obj)

static YFunction *	_FindFromCache (const string &classname, const string &func)

static void	_UpdateTimedReportCallbackList (YFunction *func, bool add)

static void	_UpdateValueCallbackList (YFunction *func, bool add)

Static Protected Attributes inherited from YFunction
static std::map< string, YFunction * >	_cache

Detailed Description

YPower Class: Power function interface

The Yoctopuce class YPower allows you to read and configure Yoctopuce power sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, to access the autonomous datalogger. This class adds the ability to access the energy counter and the power factor.

Definition at line 71 of file yocto_power.h.

Constructor & Destructor Documentation

YPower::YPower ( const string & func )

protected

Definition at line 51 of file yocto_power.cpp.

YPower::~YPower ( )

Definition at line 63 of file yocto_power.cpp.

Member Function Documentation

int YPower::_invokeTimedReportCallback ( YMeasure value )

virtual

Reimplemented from YSensor.

Definition at line 307 of file yocto_power.cpp.

int YPower::_invokeValueCallback ( string value )

virtual

Reimplemented from YSensor.

Definition at line 273 of file yocto_power.cpp.

int YPower::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YSensor.

Definition at line 73 of file yocto_power.cpp.

double YPower::cosPhi ( void )

inline

Definition at line 114 of file yocto_power.h.

static YPower* YPower::Find ( string func )

inlinestatic

Definition at line 218 of file yocto_power.h.

YPower * YPower::FindPower ( string func )

static

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

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

Definition at line 222 of file yocto_power.cpp.

static YPower* YPower::First ( void )

inlinestatic

Definition at line 242 of file yocto_power.h.

YPower * YPower::FirstPower ( void )

static

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.

Definition at line 339 of file yocto_power.cpp.

double YPower::get_cosPhi ( void )

Returns the power factor (the ratio between the real power consumed, measured in W, and the apparent power provided, measured in VA).

Returns: a floating point number corresponding to the power factor (the ratio between the real power consumed, measured in W, and the apparent power provided, measured in VA)

On failure, throws an exception or returns Y_COSPHI_INVALID.

Definition at line 97 of file yocto_power.cpp.

double YPower::get_meter ( void )

Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time. 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

On failure, throws an exception or returns Y_METER_INVALID.

Definition at line 144 of file yocto_power.cpp.

int YPower::get_meterTimer ( void )

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

On failure, throws an exception or returns Y_METERTIMER_INVALID.

Definition at line 173 of file yocto_power.cpp.

double YPower::meter ( void )

inline

Definition at line 132 of file yocto_power.h.

int YPower::meterTimer ( void )

inline

Definition at line 144 of file yocto_power.h.

YPower* YPower::next ( void )

inline

Definition at line 229 of file yocto_power.h.

YPower * YPower::nextPower ( void )

Continues the enumeration of electrical power sensors started using yFirstPower().

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.

Definition at line 329 of file yocto_power.cpp.

int YPower::registerTimedReportCallback ( YPowerTimedReportCallback callback )

virtual

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.

Definition at line 294 of file yocto_power.cpp.

int YPower::registerValueCallback ( YPowerValueCallback callback )

virtual

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.

Definition at line 254 of file yocto_power.cpp.

int YPower::reset ( void )

virtual

Resets the energy counter.

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 324 of file yocto_power.cpp.

int YPower::set_meter ( double newval )

Definition at line 119 of file yocto_power.cpp.

int YPower::setMeter ( double newval )

inline

Definition at line 118 of file yocto_power.h.

Friends And Related Function Documentation

YPower* yFindPower ( const string & func )

friend

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

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

Definition at line 279 of file yocto_power.h.

YPower* yFirstPower ( void )

friend

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.

Definition at line 290 of file yocto_power.h.

Member Data Documentation

double YPower::_cosPhi

protected

Definition at line 79 of file yocto_power.h.

double YPower::_meter

protected

Definition at line 80 of file yocto_power.h.

int YPower::_meterTimer

protected

Definition at line 81 of file yocto_power.h.

YPowerTimedReportCallback YPower::_timedReportCallbackPower

protected

Definition at line 83 of file yocto_power.h.

YPowerValueCallback YPower::_valueCallbackPower

protected

Definition at line 82 of file yocto_power.h.

const double YPower::COSPHI_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 99 of file yocto_power.h.

const double YPower::METER_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 100 of file yocto_power.h.

const int YPower::METERTIMER_INVALID = YAPI_INVALID_UINT

static

Definition at line 101 of file yocto_power.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation