yocto_powersupply.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_powersupply.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindPowerSupply(), the high-level API for PowerSupply functions
 *
 * - - - - - - - - - License information: - - - - - - - - -
 *
 *  Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
 *
 *  Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
 *  non-exclusive license to use, modify, copy and integrate this
 *  file into your software for the sole purpose of interfacing
 *  with Yoctopuce products.
 *
 *  You may reproduce and distribute copies of this file in
 *  source or object form, as long as the sole purpose of this
 *  code is to interface with Yoctopuce products. You must retain
 *  this notice in the distributed source file.
 *
 *  You should refer to Yoctopuce General Terms and Conditions
 *  for additional information regarding your rights and
 *  obligations.
 *
 *  THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT
 *  WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 *  WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
 *  EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
 *  INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
 *  COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
 *  SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
 *  LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
 *  CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
 *  BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
 *  WARRANTY, OR OTHERWISE.
 *
 *********************************************************************/


#ifndef YOCTO_POWERSUPPLY_H
#define YOCTO_POWERSUPPLY_H

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

//--- (YPowerSupply return codes)
//--- (end of YPowerSupply return codes)
//--- (YPowerSupply definitions)
class YPowerSupply; // forward declaration

typedef void (*YPowerSupplyValueCallback)(YPowerSupply *func, const string& functionValue);
#ifndef _Y_POWEROUTPUT_ENUM
#define _Y_POWEROUTPUT_ENUM
typedef enum {
    Y_POWEROUTPUT_OFF = 0,
    Y_POWEROUTPUT_ON = 1,
    Y_POWEROUTPUT_INVALID = -1,
} Y_POWEROUTPUT_enum;
#endif
#ifndef _Y_VOLTAGESENSE_ENUM
#define _Y_VOLTAGESENSE_ENUM
typedef enum {
    Y_VOLTAGESENSE_INT = 0,
    Y_VOLTAGESENSE_EXT = 1,
    Y_VOLTAGESENSE_INVALID = -1,
} Y_VOLTAGESENSE_enum;
#endif
#define Y_VOLTAGESETPOINT_INVALID       (YAPI_INVALID_DOUBLE)
#define Y_CURRENTLIMIT_INVALID          (YAPI_INVALID_DOUBLE)
#define Y_MEASUREDVOLTAGE_INVALID       (YAPI_INVALID_DOUBLE)
#define Y_MEASUREDCURRENT_INVALID       (YAPI_INVALID_DOUBLE)
#define Y_INPUTVOLTAGE_INVALID          (YAPI_INVALID_DOUBLE)
#define Y_VINT_INVALID                  (YAPI_INVALID_DOUBLE)
#define Y_LDOTEMPERATURE_INVALID        (YAPI_INVALID_DOUBLE)
#define Y_VOLTAGETRANSITION_INVALID     (YAPI_INVALID_STRING)
#define Y_VOLTAGEATSTARTUP_INVALID      (YAPI_INVALID_DOUBLE)
#define Y_CURRENTATSTARTUP_INVALID      (YAPI_INVALID_DOUBLE)
#define Y_COMMAND_INVALID               (YAPI_INVALID_STRING)
//--- (end of YPowerSupply definitions)

//--- (YPowerSupply declaration)
class YOCTO_CLASS_EXPORT YPowerSupply: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YPowerSupply declaration)
protected:
    //--- (YPowerSupply attributes)
    // Attributes (function value cache)
    double          _voltageSetPoint;
    double          _currentLimit;
    Y_POWEROUTPUT_enum _powerOutput;
    Y_VOLTAGESENSE_enum _voltageSense;
    double          _measuredVoltage;
    double          _measuredCurrent;
    double          _inputVoltage;
    double          _vInt;
    double          _ldoTemperature;
    string          _voltageTransition;
    double          _voltageAtStartUp;
    double          _currentAtStartUp;
    string          _command;
    YPowerSupplyValueCallback _valueCallbackPowerSupply;

    friend YPowerSupply *yFindPowerSupply(const string& func);
    friend YPowerSupply *yFirstPowerSupply(void);

    // Function-specific method for parsing of JSON output and caching result
    virtual int     _parseAttr(YJSONObject* json_val);

    // Constructor is protected, use yFindPowerSupply factory function to instantiate
    YPowerSupply(const string& func);
    //--- (end of YPowerSupply attributes)

public:
    ~YPowerSupply();
    //--- (YPowerSupply accessors declaration)

    static const double VOLTAGESETPOINT_INVALID;
    static const double CURRENTLIMIT_INVALID;
    static const Y_POWEROUTPUT_enum POWEROUTPUT_OFF = Y_POWEROUTPUT_OFF;
    static const Y_POWEROUTPUT_enum POWEROUTPUT_ON = Y_POWEROUTPUT_ON;
    static const Y_POWEROUTPUT_enum POWEROUTPUT_INVALID = Y_POWEROUTPUT_INVALID;
    static const Y_VOLTAGESENSE_enum VOLTAGESENSE_INT = Y_VOLTAGESENSE_INT;
    static const Y_VOLTAGESENSE_enum VOLTAGESENSE_EXT = Y_VOLTAGESENSE_EXT;
    static const Y_VOLTAGESENSE_enum VOLTAGESENSE_INVALID = Y_VOLTAGESENSE_INVALID;
    static const double MEASUREDVOLTAGE_INVALID;
    static const double MEASUREDCURRENT_INVALID;
    static const double INPUTVOLTAGE_INVALID;
    static const double VINT_INVALID;
    static const double LDOTEMPERATURE_INVALID;
    static const string VOLTAGETRANSITION_INVALID;
    static const double VOLTAGEATSTARTUP_INVALID;
    static const double CURRENTATSTARTUP_INVALID;
    static const string COMMAND_INVALID;

    int             set_voltageSetPoint(double newval);
    inline int      setVoltageSetPoint(double newval)
    { return this->set_voltageSetPoint(newval); }

    double              get_voltageSetPoint(void);

    inline double       voltageSetPoint(void)
    { return this->get_voltageSetPoint(); }

    int             set_currentLimit(double newval);
    inline int      setCurrentLimit(double newval)
    { return this->set_currentLimit(newval); }

    double              get_currentLimit(void);

    inline double       currentLimit(void)
    { return this->get_currentLimit(); }

    Y_POWEROUTPUT_enum  get_powerOutput(void);

    inline Y_POWEROUTPUT_enum powerOutput(void)
    { return this->get_powerOutput(); }

    int             set_powerOutput(Y_POWEROUTPUT_enum newval);
    inline int      setPowerOutput(Y_POWEROUTPUT_enum newval)
    { return this->set_powerOutput(newval); }

    Y_VOLTAGESENSE_enum get_voltageSense(void);

    inline Y_VOLTAGESENSE_enum voltageSense(void)
    { return this->get_voltageSense(); }

    int             set_voltageSense(Y_VOLTAGESENSE_enum newval);
    inline int      setVoltageSense(Y_VOLTAGESENSE_enum newval)
    { return this->set_voltageSense(newval); }

    double              get_measuredVoltage(void);

    inline double       measuredVoltage(void)
    { return this->get_measuredVoltage(); }

    double              get_measuredCurrent(void);

    inline double       measuredCurrent(void)
    { return this->get_measuredCurrent(); }

    double              get_inputVoltage(void);

    inline double       inputVoltage(void)
    { return this->get_inputVoltage(); }

    double              get_vInt(void);

    inline double       vInt(void)
    { return this->get_vInt(); }

    double              get_ldoTemperature(void);

    inline double       ldoTemperature(void)
    { return this->get_ldoTemperature(); }

    string              get_voltageTransition(void);

    inline string       voltageTransition(void)
    { return this->get_voltageTransition(); }

    int             set_voltageTransition(const string& newval);
    inline int      setVoltageTransition(const string& newval)
    { return this->set_voltageTransition(newval); }

    int             set_voltageAtStartUp(double newval);
    inline int      setVoltageAtStartUp(double newval)
    { return this->set_voltageAtStartUp(newval); }

    double              get_voltageAtStartUp(void);

    inline double       voltageAtStartUp(void)
    { return this->get_voltageAtStartUp(); }

    int             set_currentAtStartUp(double newval);
    inline int      setCurrentAtStartUp(double newval)
    { return this->set_currentAtStartUp(newval); }

    double              get_currentAtStartUp(void);

    inline double       currentAtStartUp(void)
    { return this->get_currentAtStartUp(); }

    string              get_command(void);

    inline string       command(void)
    { return this->get_command(); }

    int             set_command(const string& newval);
    inline int      setCommand(const string& newval)
    { return this->set_command(newval); }

    static YPowerSupply* FindPowerSupply(string func);

    virtual int         registerValueCallback(YPowerSupplyValueCallback callback);
    using YFunction::registerValueCallback;

    virtual int         _invokeValueCallback(string value);

    virtual int         voltageMove(double V_target,int ms_duration);


    inline static YPowerSupply* Find(string func)
    { return YPowerSupply::FindPowerSupply(func); }

           YPowerSupply    *nextPowerSupply(void);
    inline YPowerSupply    *next(void)
    { return this->nextPowerSupply();}

           static YPowerSupply* FirstPowerSupply(void);
    inline static YPowerSupply* First(void)
    { return YPowerSupply::FirstPowerSupply();}
#ifdef __BORLANDC__
#pragma option pop
#endif
    //--- (end of YPowerSupply accessors declaration)
};

//--- (YPowerSupply functions declaration)

inline YPowerSupply* yFindPowerSupply(const string& func)
{ return YPowerSupply::FindPowerSupply(func);}
inline YPowerSupply* yFirstPowerSupply(void)
{ return YPowerSupply::FirstPowerSupply();}

//--- (end of YPowerSupply functions declaration)

#endif