#include <yocto_pwmpowersource.h>

Inheritance diagram for YPwmPowerSource:

Public Member Functions
virtual int	_invokeValueCallback (string value)

Y_POWERMODE_enum	get_powerMode (void)

YPwmPowerSource *	next (void)

YPwmPowerSource *	nextPwmPowerSource (void)

Y_POWERMODE_enum	powerMode (void)

virtual int	registerValueCallback (YPwmPowerSourceValueCallback callback)

int	set_powerMode (Y_POWERMODE_enum newval)

int	setPowerMode (Y_POWERMODE_enum newval)

	~YPwmPowerSource ()

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

static YPwmPowerSource *	FindPwmPowerSource (string func)

static YPwmPowerSource *	First (void)

static YPwmPowerSource *	FirstPwmPowerSource (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_POWERMODE_enum	POWERMODE_EXT_V = Y_POWERMODE_EXT_V

static const Y_POWERMODE_enum	POWERMODE_INVALID = Y_POWERMODE_INVALID

static const Y_POWERMODE_enum	POWERMODE_OPNDRN = Y_POWERMODE_OPNDRN

static const Y_POWERMODE_enum	POWERMODE_USB_3V = Y_POWERMODE_USB_3V

static const Y_POWERMODE_enum	POWERMODE_USB_5V = Y_POWERMODE_USB_5V

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)

	YPwmPowerSource (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
Y_POWERMODE_enum	_powerMode

YPwmPowerSourceValueCallback	_valueCallbackPwmPowerSource

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
YPwmPowerSource *	yFindPwmPowerSource (const string &func)

YPwmPowerSource *	yFirstPwmPowerSource (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

YPwmPowerSource Class: PwmPowerSource function interface

The Yoctopuce application programming interface allows you to configure the voltage source used by all PWM on the same device.

Definition at line 74 of file yocto_pwmpowersource.h.

Constructor & Destructor Documentation

YPwmPowerSource::YPwmPowerSource ( const string & func )

protected

Definition at line 51 of file yocto_pwmpowersource.cpp.

YPwmPowerSource::~YPwmPowerSource ( )

Definition at line 60 of file yocto_pwmpowersource.cpp.

Member Function Documentation

int YPwmPowerSource::_invokeValueCallback ( string value )

virtual

Reimplemented from YFunction.

Definition at line 217 of file yocto_pwmpowersource.cpp.

int YPwmPowerSource::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YFunction.

Definition at line 68 of file yocto_pwmpowersource.cpp.

static YPwmPowerSource* YPwmPowerSource::Find ( string func )

inlinestatic

Definition at line 184 of file yocto_pwmpowersource.h.

YPwmPowerSource * YPwmPowerSource::FindPwmPowerSource ( string func )

static

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

Returns: a YPwmPowerSource object allowing you to drive the voltage source.

Definition at line 166 of file yocto_pwmpowersource.cpp.

static YPwmPowerSource* YPwmPowerSource::First ( void )

inlinestatic

Definition at line 208 of file yocto_pwmpowersource.h.

YPwmPowerSource * YPwmPowerSource::FirstPwmPowerSource ( void )

static

Starts the enumeration of Voltage sources currently accessible. Use the method YPwmPowerSource.nextPwmPowerSource() to iterate on next Voltage sources.

Returns: a pointer to a YPwmPowerSource object, corresponding to the first source currently online, or a NULL pointer if there are none.

Definition at line 237 of file yocto_pwmpowersource.cpp.

Y_POWERMODE_enum YPwmPowerSource::get_powerMode ( void )

Returns the selected power source for the PWM on the same device.

Returns: a value among Y_POWERMODE_USB_5V, Y_POWERMODE_USB_3V, Y_POWERMODE_EXT_V and Y_POWERMODE_OPNDRN corresponding to the selected power source for the PWM on the same device

On failure, throws an exception or returns Y_POWERMODE_INVALID.

Definition at line 85 of file yocto_pwmpowersource.cpp.

YPwmPowerSource* YPwmPowerSource::next ( void )

inline

Definition at line 195 of file yocto_pwmpowersource.h.

YPwmPowerSource * YPwmPowerSource::nextPwmPowerSource ( void )

Continues the enumeration of Voltage sources started using yFirstPwmPowerSource().

Returns: a pointer to a YPwmPowerSource object, corresponding to a voltage source currently online, or a NULL pointer if there are no more Voltage sources to enumerate.

Definition at line 227 of file yocto_pwmpowersource.cpp.

Y_POWERMODE_enum YPwmPowerSource::powerMode ( void )

inline

Definition at line 115 of file yocto_pwmpowersource.h.

int YPwmPowerSource::registerValueCallback ( YPwmPowerSourceValueCallback 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 198 of file yocto_pwmpowersource.cpp.

int YPwmPowerSource::set_powerMode ( Y_POWERMODE_enum newval )

Changes the PWM power source. PWM can use isolated 5V from USB, isolated 3V from USB or voltage from an external power source. The PWM can also work in open drain mode. In that mode, the PWM actively pulls the line down. Warning: this setting is common to all PWM on the same device. If you change that parameter, all PWM located on the same device are affected. If you want the change to be kept after a device reboot, make sure to call the matching module saveToFlash().

Parameters

newval : a value among Y_POWERMODE_USB_5V, Y_POWERMODE_USB_3V, Y_POWERMODE_EXT_V and Y_POWERMODE_OPNDRN corresponding to the PWM power source

Returns: YAPI_SUCCESS if the call succeeds.

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

Definition at line 123 of file yocto_pwmpowersource.cpp.

int YPwmPowerSource::setPowerMode ( Y_POWERMODE_enum newval )

inline

Definition at line 135 of file yocto_pwmpowersource.h.

Friends And Related Function Documentation

YPwmPowerSource* yFindPwmPowerSource ( const string & func )

friend

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

Returns: a YPwmPowerSource object allowing you to drive the voltage source.

Definition at line 245 of file yocto_pwmpowersource.h.

YPwmPowerSource* yFirstPwmPowerSource ( void )

friend

Starts the enumeration of Voltage sources currently accessible. Use the method YPwmPowerSource.nextPwmPowerSource() to iterate on next Voltage sources.

Returns: a pointer to a YPwmPowerSource object, corresponding to the first source currently online, or a NULL pointer if there are none.

Definition at line 256 of file yocto_pwmpowersource.h.

Member Data Documentation

Y_POWERMODE_enum YPwmPowerSource::_powerMode

protected

Definition at line 82 of file yocto_pwmpowersource.h.

YPwmPowerSourceValueCallback YPwmPowerSource::_valueCallbackPwmPowerSource

protected

Definition at line 83 of file yocto_pwmpowersource.h.

const Y_POWERMODE_enum YPwmPowerSource::POWERMODE_EXT_V = Y_POWERMODE_EXT_V

static

Definition at line 101 of file yocto_pwmpowersource.h.

const Y_POWERMODE_enum YPwmPowerSource::POWERMODE_INVALID = Y_POWERMODE_INVALID

static

Definition at line 103 of file yocto_pwmpowersource.h.

const Y_POWERMODE_enum YPwmPowerSource::POWERMODE_OPNDRN = Y_POWERMODE_OPNDRN

static

Definition at line 102 of file yocto_pwmpowersource.h.

const Y_POWERMODE_enum YPwmPowerSource::POWERMODE_USB_3V = Y_POWERMODE_USB_3V

static

Definition at line 100 of file yocto_pwmpowersource.h.

const Y_POWERMODE_enum YPwmPowerSource::POWERMODE_USB_5V = Y_POWERMODE_USB_5V

static

Definition at line 99 of file yocto_pwmpowersource.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