yocto_digitalio.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_digitalio.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YDigitalIO

Macros
#define	_Y_OUTPUTVOLTAGE_ENUM
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_PORTDIAGS_INVALID   (YAPI_INVALID_UINT)
#define	Y_PORTDIRECTION_INVALID   (YAPI_INVALID_UINT)
#define	Y_PORTOPENDRAIN_INVALID   (YAPI_INVALID_UINT)
#define	Y_PORTPOLARITY_INVALID   (YAPI_INVALID_UINT)
#define	Y_PORTSIZE_INVALID   (YAPI_INVALID_UINT)
#define	Y_PORTSTATE_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YDigitalIOValueCallback) (YDigitalIO *func, const string &functionValue)

Enumerations
enum	Y_OUTPUTVOLTAGE_enum { Y_OUTPUTVOLTAGE_USB_5V = 0, Y_OUTPUTVOLTAGE_USB_3V = 1, Y_OUTPUTVOLTAGE_EXT_V = 2, Y_OUTPUTVOLTAGE_INVALID = -1 }

Functions
YDigitalIO *	yFindDigitalIO (const string &func)
YDigitalIO *	yFirstDigitalIO (void)

Macro Definition Documentation

#define _Y_OUTPUTVOLTAGE_ENUM

Definition at line 56 of file yocto_digitalio.h.

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 70 of file yocto_digitalio.h.

#define Y_PORTDIAGS_INVALID   (YAPI_INVALID_UINT)

Definition at line 68 of file yocto_digitalio.h.

#define Y_PORTDIRECTION_INVALID   (YAPI_INVALID_UINT)

Definition at line 65 of file yocto_digitalio.h.

#define Y_PORTOPENDRAIN_INVALID   (YAPI_INVALID_UINT)

Definition at line 66 of file yocto_digitalio.h.

#define Y_PORTPOLARITY_INVALID   (YAPI_INVALID_UINT)

Definition at line 67 of file yocto_digitalio.h.

#define Y_PORTSIZE_INVALID   (YAPI_INVALID_UINT)

Definition at line 69 of file yocto_digitalio.h.

#define Y_PORTSTATE_INVALID   (YAPI_INVALID_UINT)

Definition at line 64 of file yocto_digitalio.h.

Typedef Documentation

typedef void(* YDigitalIOValueCallback) (YDigitalIO *func, const string &functionValue)

Definition at line 54 of file yocto_digitalio.h.

Enumeration Type Documentation

enum Y_OUTPUTVOLTAGE_enum

Enumerator
Y_OUTPUTVOLTAGE_USB_5V
Y_OUTPUTVOLTAGE_USB_3V
Y_OUTPUTVOLTAGE_EXT_V
Y_OUTPUTVOLTAGE_INVALID

Definition at line 57 of file yocto_digitalio.h.

Function Documentation

YDigitalIO* yFindDigitalIO ( const string &  func )

inline

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

Returns

a YDigitalIO object allowing you to drive the digital IO port.

Definition at line 549 of file yocto_digitalio.h.

YDigitalIO* yFirstDigitalIO ( void  )

inline

Starts the enumeration of digital IO ports currently accessible. Use the method YDigitalIO.nextDigitalIO() to iterate on next digital IO ports.

Returns

a pointer to a YDigitalIO object, corresponding to the first digital IO port currently online, or a NULL pointer if there are none.

Definition at line 560 of file yocto_digitalio.h.