#include <yocto_poweroutput.h>

Inheritance diagram for YPowerOutput:

Public Member Functions
virtual int	_invokeValueCallback (string value)

Y_VOLTAGE_enum	get_voltage (void)

YPowerOutput *	next (void)

YPowerOutput *	nextPowerOutput (void)

virtual int	registerValueCallback (YPowerOutputValueCallback callback)

int	set_voltage (Y_VOLTAGE_enum newval)

int	setVoltage (Y_VOLTAGE_enum newval)

Y_VOLTAGE_enum	voltage (void)

	~YPowerOutput ()

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)

virtual int	_parserHelper (void)

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 YPowerOutput *	Find (string func)

static YPowerOutput *	FindPowerOutput (string func)

static YPowerOutput *	First (void)

static YPowerOutput *	FirstPowerOutput (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 Y_VOLTAGE_enum	VOLTAGE_INVALID = Y_VOLTAGE_INVALID

static const Y_VOLTAGE_enum	VOLTAGE_OFF = Y_VOLTAGE_OFF

static const Y_VOLTAGE_enum	VOLTAGE_OUT3V3 = Y_VOLTAGE_OUT3V3

static const Y_VOLTAGE_enum	VOLTAGE_OUT5V = Y_VOLTAGE_OUT5V

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)

	YPowerOutput (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
YPowerOutputValueCallback	_valueCallbackPowerOutput

Y_VOLTAGE_enum	_voltage

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
YPowerOutput *	yFindPowerOutput (const string &func)

YPowerOutput *	yFirstPowerOutput (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

YPowerOutput Class: External power supply control interface

Yoctopuce application programming interface allows you to control the power ouput featured on some devices such as the Yocto-Serial.

Definition at line 73 of file yocto_poweroutput.h.

Constructor & Destructor Documentation

YPowerOutput::YPowerOutput ( const string & func )

protected

Definition at line 51 of file yocto_poweroutput.cpp.

YPowerOutput::~YPowerOutput ( )

Definition at line 60 of file yocto_poweroutput.cpp.

Member Function Documentation

int YPowerOutput::_invokeValueCallback ( string value )

virtual

Reimplemented from YFunction.

Definition at line 214 of file yocto_poweroutput.cpp.

int YPowerOutput::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YFunction.

Definition at line 68 of file yocto_poweroutput.cpp.

static YPowerOutput* YPowerOutput::Find ( string func )

inlinestatic

Definition at line 179 of file yocto_poweroutput.h.

YPowerOutput * YPowerOutput::FindPowerOutput ( string func )

static

Retrieves a dual power ouput control 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 power ouput control is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPowerOutput.isOnline() to test if the power ouput control is indeed online at a given time. In case of ambiguity when looking for a dual power ouput control 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 power ouput control

Returns: a YPowerOutput object allowing you to drive the power ouput control.

Definition at line 163 of file yocto_poweroutput.cpp.

static YPowerOutput* YPowerOutput::First ( void )

inlinestatic

Definition at line 203 of file yocto_poweroutput.h.

YPowerOutput * YPowerOutput::FirstPowerOutput ( void )

static

Starts the enumeration of dual power ouput controls currently accessible. Use the method YPowerOutput.nextPowerOutput() to iterate on next dual power ouput controls.

Returns: a pointer to a YPowerOutput object, corresponding to the first dual power ouput control currently online, or a NULL pointer if there are none.

Definition at line 234 of file yocto_poweroutput.cpp.

Y_VOLTAGE_enum YPowerOutput::get_voltage ( void )

Returns the voltage on the power output featured by the module.

Returns: a value among Y_VOLTAGE_OFF, Y_VOLTAGE_OUT3V3 and Y_VOLTAGE_OUT5V corresponding to the voltage on the power output featured by the module

On failure, throws an exception or returns Y_VOLTAGE_INVALID.

Definition at line 85 of file yocto_poweroutput.cpp.

YPowerOutput* YPowerOutput::next ( void )

inline

Definition at line 190 of file yocto_poweroutput.h.

YPowerOutput * YPowerOutput::nextPowerOutput ( void )

Continues the enumeration of dual power ouput controls started using yFirstPowerOutput().

Returns: a pointer to a YPowerOutput object, corresponding to a dual power ouput control currently online, or a NULL pointer if there are no more dual power ouput controls to enumerate.

Definition at line 224 of file yocto_poweroutput.cpp.

int YPowerOutput::registerValueCallback ( YPowerOutputValueCallback 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 195 of file yocto_poweroutput.cpp.

int YPowerOutput::set_voltage ( Y_VOLTAGE_enum newval )

Changes the voltage on the power output provided by the module. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters

newval : a value among Y_VOLTAGE_OFF, Y_VOLTAGE_OUT3V3 and Y_VOLTAGE_OUT5V corresponding to the voltage on the power output provided by the module

Returns: YAPI_SUCCESS if the call succeeds.

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

Definition at line 120 of file yocto_poweroutput.cpp.

int YPowerOutput::setVoltage ( Y_VOLTAGE_enum newval )

inline

Definition at line 130 of file yocto_poweroutput.h.

Y_VOLTAGE_enum YPowerOutput::voltage ( void )

inline

Definition at line 113 of file yocto_poweroutput.h.

Friends And Related Function Documentation

YPowerOutput* yFindPowerOutput ( const string & func )

friend

Retrieves a dual power ouput control 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 power ouput control is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPowerOutput.isOnline() to test if the power ouput control is indeed online at a given time. In case of ambiguity when looking for a dual power ouput control 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 power ouput control

Returns: a YPowerOutput object allowing you to drive the power ouput control.

Definition at line 240 of file yocto_poweroutput.h.

YPowerOutput* yFirstPowerOutput ( void )

friend

Starts the enumeration of dual power ouput controls currently accessible. Use the method YPowerOutput.nextPowerOutput() to iterate on next dual power ouput controls.

Returns: a pointer to a YPowerOutput object, corresponding to the first dual power ouput control currently online, or a NULL pointer if there are none.

Definition at line 251 of file yocto_poweroutput.h.

Member Data Documentation

YPowerOutputValueCallback YPowerOutput::_valueCallbackPowerOutput

protected

Definition at line 82 of file yocto_poweroutput.h.

Y_VOLTAGE_enum YPowerOutput::_voltage

protected

Definition at line 81 of file yocto_poweroutput.h.

const Y_VOLTAGE_enum YPowerOutput::VOLTAGE_INVALID = Y_VOLTAGE_INVALID

static

Definition at line 101 of file yocto_poweroutput.h.

const Y_VOLTAGE_enum YPowerOutput::VOLTAGE_OFF = Y_VOLTAGE_OFF

static

Definition at line 98 of file yocto_poweroutput.h.

const Y_VOLTAGE_enum YPowerOutput::VOLTAGE_OUT3V3 = Y_VOLTAGE_OUT3V3

static

Definition at line 99 of file yocto_poweroutput.h.

const Y_VOLTAGE_enum YPowerOutput::VOLTAGE_OUT5V = Y_VOLTAGE_OUT5V

static

Definition at line 100 of file yocto_poweroutput.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