yocto_powersupply.h File Reference

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

Include dependency graph for yocto_powersupply.h:

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

Go to the source code of this file.

Classes
class	YPowerSupply

Macros
#define	_Y_POWEROUTPUT_ENUM
#define	_Y_VOLTAGESENSE_ENUM
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_CURRENTATSTARTUP_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_CURRENTLIMIT_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_INPUTVOLTAGE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_LDOTEMPERATURE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_MEASUREDCURRENT_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_MEASUREDVOLTAGE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_VINT_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_VOLTAGEATSTARTUP_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_VOLTAGESETPOINT_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_VOLTAGETRANSITION_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YPowerSupplyValueCallback) (YPowerSupply *func, const string &functionValue)

Enumerations
enum	Y_POWEROUTPUT_enum { Y_POWEROUTPUT_OFF = 0, Y_POWEROUTPUT_ON = 1, Y_POWEROUTPUT_INVALID = -1 }
enum	Y_VOLTAGESENSE_enum { Y_VOLTAGESENSE_INT = 0, Y_VOLTAGESENSE_EXT = 1, Y_VOLTAGESENSE_INVALID = -1 }

Functions
YPowerSupply *	yFindPowerSupply (const string &func)
YPowerSupply *	yFirstPowerSupply (void)

Macro Definition Documentation

#define _Y_POWEROUTPUT_ENUM

Definition at line 56 of file yocto_powersupply.h.

#define _Y_VOLTAGESENSE_ENUM

Definition at line 64 of file yocto_powersupply.h.

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 81 of file yocto_powersupply.h.

#define Y_CURRENTATSTARTUP_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 80 of file yocto_powersupply.h.

#define Y_CURRENTLIMIT_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 72 of file yocto_powersupply.h.

#define Y_INPUTVOLTAGE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 75 of file yocto_powersupply.h.

#define Y_LDOTEMPERATURE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 77 of file yocto_powersupply.h.

#define Y_MEASUREDCURRENT_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 74 of file yocto_powersupply.h.

#define Y_MEASUREDVOLTAGE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 73 of file yocto_powersupply.h.

#define Y_VINT_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 76 of file yocto_powersupply.h.

#define Y_VOLTAGEATSTARTUP_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 79 of file yocto_powersupply.h.

#define Y_VOLTAGESETPOINT_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 71 of file yocto_powersupply.h.

#define Y_VOLTAGETRANSITION_INVALID   (YAPI_INVALID_STRING)

Definition at line 78 of file yocto_powersupply.h.

Typedef Documentation

typedef void(* YPowerSupplyValueCallback) (YPowerSupply *func, const string &functionValue)

Definition at line 54 of file yocto_powersupply.h.

Enumeration Type Documentation

enum Y_POWEROUTPUT_enum

Enumerator
Y_POWEROUTPUT_OFF
Y_POWEROUTPUT_ON
Y_POWEROUTPUT_INVALID

Definition at line 57 of file yocto_powersupply.h.

enum Y_VOLTAGESENSE_enum

Enumerator
Y_VOLTAGESENSE_INT
Y_VOLTAGESENSE_EXT
Y_VOLTAGESENSE_INVALID

Definition at line 65 of file yocto_powersupply.h.

Function Documentation

YPowerSupply* yFindPowerSupply ( const string &  func )

inline

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

Returns

a YPowerSupply object allowing you to drive the regulated power supply.

Definition at line 495 of file yocto_powersupply.h.

YPowerSupply* yFirstPowerSupply ( void  )

inline

Starts the enumeration of regulated power supplies currently accessible. Use the method YPowerSupply.nextPowerSupply() to iterate on next regulated power supplies.

Returns

a pointer to a YPowerSupply object, corresponding to the first regulated power supply currently online, or a NULL pointer if there are none.

Definition at line 506 of file yocto_powersupply.h.