#include <yocto_hubport.h>

Inheritance diagram for YHubPort:

Public Member Functions
virtual int	_invokeValueCallback (string value)

int	baudRate (void)

Y_ENABLED_enum	enabled (void)

int	get_baudRate (void)

Y_ENABLED_enum	get_enabled (void)

Y_PORTSTATE_enum	get_portState (void)

YHubPort *	next (void)

YHubPort *	nextHubPort (void)

Y_PORTSTATE_enum	portState (void)

virtual int	registerValueCallback (YHubPortValueCallback callback)

int	set_enabled (Y_ENABLED_enum newval)

int	setEnabled (Y_ENABLED_enum newval)

	~YHubPort ()

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

static YHubPort *	FindHubPort (string func)

static YHubPort *	First (void)

static YHubPort *	FirstHubPort (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 int	BAUDRATE_INVALID = YAPI_INVALID_UINT

static const Y_ENABLED_enum	ENABLED_FALSE = Y_ENABLED_FALSE

static const Y_ENABLED_enum	ENABLED_INVALID = Y_ENABLED_INVALID

static const Y_ENABLED_enum	ENABLED_TRUE = Y_ENABLED_TRUE

static const Y_PORTSTATE_enum	PORTSTATE_INVALID = Y_PORTSTATE_INVALID

static const Y_PORTSTATE_enum	PORTSTATE_OFF = Y_PORTSTATE_OFF

static const Y_PORTSTATE_enum	PORTSTATE_ON = Y_PORTSTATE_ON

static const Y_PORTSTATE_enum	PORTSTATE_OVRLD = Y_PORTSTATE_OVRLD

static const Y_PORTSTATE_enum	PORTSTATE_PROG = Y_PORTSTATE_PROG

static const Y_PORTSTATE_enum	PORTSTATE_RUN = Y_PORTSTATE_RUN

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)

	YHubPort (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
int	_baudRate

Y_ENABLED_enum	_enabled

Y_PORTSTATE_enum	_portState

YHubPortValueCallback	_valueCallbackHubPort

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
YHubPort *	yFindHubPort (const string &func)

YHubPort *	yFirstHubPort (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

YHubPort Class: Yocto-hub port interface

YHubPort objects provide control over the power supply for every YoctoHub port and provide information about the device connected to it. The logical name of a YHubPort is always automatically set to the unique serial number of the Yoctopuce device connected to it.

Definition at line 89 of file yocto_hubport.h.

Constructor & Destructor Documentation

YHubPort::YHubPort ( const string & func )

protected

Definition at line 51 of file yocto_hubport.cpp.

YHubPort::~YHubPort ( )

Definition at line 62 of file yocto_hubport.cpp.

Member Function Documentation

int YHubPort::_invokeValueCallback ( string value )

virtual

Reimplemented from YFunction.

Definition at line 280 of file yocto_hubport.cpp.

int YHubPort::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YFunction.

Definition at line 70 of file yocto_hubport.cpp.

int YHubPort::baudRate ( void )

inline

Definition at line 178 of file yocto_hubport.h.

Y_ENABLED_enum YHubPort::enabled ( void )

inline

Definition at line 137 of file yocto_hubport.h.

static YHubPort* YHubPort::Find ( string func )

inlinestatic

Definition at line 227 of file yocto_hubport.h.

YHubPort * YHubPort::FindHubPort ( string func )

static

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

Returns: a YHubPort object allowing you to drive the Yocto-hub port.

Definition at line 229 of file yocto_hubport.cpp.

static YHubPort* YHubPort::First ( void )

inlinestatic

Definition at line 251 of file yocto_hubport.h.

YHubPort * YHubPort::FirstHubPort ( void )

static

Starts the enumeration of Yocto-hub ports currently accessible. Use the method YHubPort.nextHubPort() to iterate on next Yocto-hub ports.

Returns: a pointer to a YHubPort object, corresponding to the first Yocto-hub port currently online, or a NULL pointer if there are none.

Definition at line 300 of file yocto_hubport.cpp.

int YHubPort::get_baudRate ( void )

Returns the current baud rate used by this Yocto-hub port, in kbps. The default value is 1000 kbps, but a slower rate may be used if communication problems are encountered.

Returns: an integer corresponding to the current baud rate used by this Yocto-hub port, in kbps

On failure, throws an exception or returns Y_BAUDRATE_INVALID.

Definition at line 180 of file yocto_hubport.cpp.

Y_ENABLED_enum YHubPort::get_enabled ( void )

Returns true if the Yocto-hub port is powered, false otherwise.

Returns: either Y_ENABLED_FALSE or Y_ENABLED_TRUE, according to true if the Yocto-hub port is powered, false otherwise

On failure, throws an exception or returns Y_ENABLED_INVALID.

Definition at line 93 of file yocto_hubport.cpp.

Y_PORTSTATE_enum YHubPort::get_portState ( void )

Returns the current state of the Yocto-hub port.

Returns: a value among Y_PORTSTATE_OFF, Y_PORTSTATE_OVRLD, Y_PORTSTATE_ON, Y_PORTSTATE_RUN and Y_PORTSTATE_PROG corresponding to the current state of the Yocto-hub port

On failure, throws an exception or returns Y_PORTSTATE_INVALID.

Definition at line 149 of file yocto_hubport.cpp.

YHubPort* YHubPort::next ( void )

inline

Definition at line 238 of file yocto_hubport.h.

YHubPort * YHubPort::nextHubPort ( void )

Continues the enumeration of Yocto-hub ports started using yFirstHubPort().

Returns: a pointer to a YHubPort object, corresponding to a Yocto-hub port currently online, or a NULL pointer if there are no more Yocto-hub ports to enumerate.

Definition at line 290 of file yocto_hubport.cpp.

Y_PORTSTATE_enum YHubPort::portState ( void )

inline

Definition at line 164 of file yocto_hubport.h.

int YHubPort::registerValueCallback ( YHubPortValueCallback 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 261 of file yocto_hubport.cpp.

int YHubPort::set_enabled ( Y_ENABLED_enum newval )

Changes the activation of the Yocto-hub port. If the port is enabled, the connected module is powered. Otherwise, port power is shut down.

Parameters

newval : either Y_ENABLED_FALSE or Y_ENABLED_TRUE, according to the activation of the Yocto-hub port

Returns: YAPI_SUCCESS if the call succeeds.

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

Definition at line 125 of file yocto_hubport.cpp.

int YHubPort::setEnabled ( Y_ENABLED_enum newval )

inline

Definition at line 151 of file yocto_hubport.h.

Friends And Related Function Documentation

YHubPort* yFindHubPort ( const string & func )

friend

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

Returns: a YHubPort object allowing you to drive the Yocto-hub port.

Definition at line 288 of file yocto_hubport.h.

YHubPort* yFirstHubPort ( void )

friend

Starts the enumeration of Yocto-hub ports currently accessible. Use the method YHubPort.nextHubPort() to iterate on next Yocto-hub ports.

Returns: a pointer to a YHubPort object, corresponding to the first Yocto-hub port currently online, or a NULL pointer if there are none.

Definition at line 299 of file yocto_hubport.h.

Member Data Documentation

int YHubPort::_baudRate

protected

Definition at line 99 of file yocto_hubport.h.

Y_ENABLED_enum YHubPort::_enabled

protected

Definition at line 97 of file yocto_hubport.h.

Y_PORTSTATE_enum YHubPort::_portState

protected

Definition at line 98 of file yocto_hubport.h.

YHubPortValueCallback YHubPort::_valueCallbackHubPort

protected

Definition at line 100 of file yocto_hubport.h.

const int YHubPort::BAUDRATE_INVALID = YAPI_INVALID_UINT

static

Definition at line 125 of file yocto_hubport.h.

const Y_ENABLED_enum YHubPort::ENABLED_FALSE = Y_ENABLED_FALSE

static

Definition at line 116 of file yocto_hubport.h.

const Y_ENABLED_enum YHubPort::ENABLED_INVALID = Y_ENABLED_INVALID

static

Definition at line 118 of file yocto_hubport.h.

const Y_ENABLED_enum YHubPort::ENABLED_TRUE = Y_ENABLED_TRUE

static

Definition at line 117 of file yocto_hubport.h.

const Y_PORTSTATE_enum YHubPort::PORTSTATE_INVALID = Y_PORTSTATE_INVALID

static

Definition at line 124 of file yocto_hubport.h.

const Y_PORTSTATE_enum YHubPort::PORTSTATE_OFF = Y_PORTSTATE_OFF

static

Definition at line 119 of file yocto_hubport.h.

const Y_PORTSTATE_enum YHubPort::PORTSTATE_ON = Y_PORTSTATE_ON

static

Definition at line 121 of file yocto_hubport.h.

const Y_PORTSTATE_enum YHubPort::PORTSTATE_OVRLD = Y_PORTSTATE_OVRLD

static

Definition at line 120 of file yocto_hubport.h.

const Y_PORTSTATE_enum YHubPort::PORTSTATE_PROG = Y_PORTSTATE_PROG

static

Definition at line 123 of file yocto_hubport.h.

const Y_PORTSTATE_enum YHubPort::PORTSTATE_RUN = Y_PORTSTATE_RUN

static

Definition at line 122 of file yocto_hubport.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