yocto_spiport.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_spiport.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindSpiPort(), the high-level API for SpiPort 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_SPIPORT_H
#define YOCTO_SPIPORT_H

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

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

typedef void (*YSpiPortValueCallback)(YSpiPort *func, const string& functionValue);
#ifndef _Y_VOLTAGELEVEL_ENUM
#define _Y_VOLTAGELEVEL_ENUM
typedef enum {
    Y_VOLTAGELEVEL_OFF = 0,
    Y_VOLTAGELEVEL_TTL3V = 1,
    Y_VOLTAGELEVEL_TTL3VR = 2,
    Y_VOLTAGELEVEL_TTL5V = 3,
    Y_VOLTAGELEVEL_TTL5VR = 4,
    Y_VOLTAGELEVEL_RS232 = 5,
    Y_VOLTAGELEVEL_RS485 = 6,
    Y_VOLTAGELEVEL_INVALID = -1,
} Y_VOLTAGELEVEL_enum;
#endif
#ifndef _Y_SSPOLARITY_ENUM
#define _Y_SSPOLARITY_ENUM
typedef enum {
    Y_SSPOLARITY_ACTIVE_LOW = 0,
    Y_SSPOLARITY_ACTIVE_HIGH = 1,
    Y_SSPOLARITY_INVALID = -1,
} Y_SSPOLARITY_enum;
#endif
#ifndef _Y_SHITFTSAMPLING_ENUM
#define _Y_SHITFTSAMPLING_ENUM
typedef enum {
    Y_SHITFTSAMPLING_OFF = 0,
    Y_SHITFTSAMPLING_ON = 1,
    Y_SHITFTSAMPLING_INVALID = -1,
} Y_SHITFTSAMPLING_enum;
#endif
#define Y_RXCOUNT_INVALID               (YAPI_INVALID_UINT)
#define Y_TXCOUNT_INVALID               (YAPI_INVALID_UINT)
#define Y_ERRCOUNT_INVALID              (YAPI_INVALID_UINT)
#define Y_RXMSGCOUNT_INVALID            (YAPI_INVALID_UINT)
#define Y_TXMSGCOUNT_INVALID            (YAPI_INVALID_UINT)
#define Y_LASTMSG_INVALID               (YAPI_INVALID_STRING)
#define Y_CURRENTJOB_INVALID            (YAPI_INVALID_STRING)
#define Y_STARTUPJOB_INVALID            (YAPI_INVALID_STRING)
#define Y_COMMAND_INVALID               (YAPI_INVALID_STRING)
#define Y_PROTOCOL_INVALID              (YAPI_INVALID_STRING)
#define Y_SPIMODE_INVALID               (YAPI_INVALID_STRING)
//--- (end of YSpiPort definitions)

//--- (YSpiPort declaration)
class YOCTO_CLASS_EXPORT YSpiPort: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YSpiPort declaration)
protected:
    //--- (YSpiPort attributes)
    // Attributes (function value cache)
    int             _rxCount;
    int             _txCount;
    int             _errCount;
    int             _rxMsgCount;
    int             _txMsgCount;
    string          _lastMsg;
    string          _currentJob;
    string          _startupJob;
    string          _command;
    Y_VOLTAGELEVEL_enum _voltageLevel;
    string          _protocol;
    string          _spiMode;
    Y_SSPOLARITY_enum _ssPolarity;
    Y_SHITFTSAMPLING_enum _shitftSampling;
    YSpiPortValueCallback _valueCallbackSpiPort;
    int             _rxptr;
    string          _rxbuff;
    int             _rxbuffptr;

    friend YSpiPort *yFindSpiPort(const string& func);
    friend YSpiPort *yFirstSpiPort(void);

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

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

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

    static const int RXCOUNT_INVALID = YAPI_INVALID_UINT;
    static const int TXCOUNT_INVALID = YAPI_INVALID_UINT;
    static const int ERRCOUNT_INVALID = YAPI_INVALID_UINT;
    static const int RXMSGCOUNT_INVALID = YAPI_INVALID_UINT;
    static const int TXMSGCOUNT_INVALID = YAPI_INVALID_UINT;
    static const string LASTMSG_INVALID;
    static const string CURRENTJOB_INVALID;
    static const string STARTUPJOB_INVALID;
    static const string COMMAND_INVALID;
    static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_OFF = Y_VOLTAGELEVEL_OFF;
    static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_TTL3V = Y_VOLTAGELEVEL_TTL3V;
    static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_TTL3VR = Y_VOLTAGELEVEL_TTL3VR;
    static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_TTL5V = Y_VOLTAGELEVEL_TTL5V;
    static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_TTL5VR = Y_VOLTAGELEVEL_TTL5VR;
    static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_RS232 = Y_VOLTAGELEVEL_RS232;
    static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_RS485 = Y_VOLTAGELEVEL_RS485;
    static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_INVALID = Y_VOLTAGELEVEL_INVALID;
    static const string PROTOCOL_INVALID;
    static const string SPIMODE_INVALID;
    static const Y_SSPOLARITY_enum SSPOLARITY_ACTIVE_LOW = Y_SSPOLARITY_ACTIVE_LOW;
    static const Y_SSPOLARITY_enum SSPOLARITY_ACTIVE_HIGH = Y_SSPOLARITY_ACTIVE_HIGH;
    static const Y_SSPOLARITY_enum SSPOLARITY_INVALID = Y_SSPOLARITY_INVALID;
    static const Y_SHITFTSAMPLING_enum SHITFTSAMPLING_OFF = Y_SHITFTSAMPLING_OFF;
    static const Y_SHITFTSAMPLING_enum SHITFTSAMPLING_ON = Y_SHITFTSAMPLING_ON;
    static const Y_SHITFTSAMPLING_enum SHITFTSAMPLING_INVALID = Y_SHITFTSAMPLING_INVALID;

    int                 get_rxCount(void);

    inline int          rxCount(void)
    { return this->get_rxCount(); }

    int                 get_txCount(void);

    inline int          txCount(void)
    { return this->get_txCount(); }

    int                 get_errCount(void);

    inline int          errCount(void)
    { return this->get_errCount(); }

    int                 get_rxMsgCount(void);

    inline int          rxMsgCount(void)
    { return this->get_rxMsgCount(); }

    int                 get_txMsgCount(void);

    inline int          txMsgCount(void)
    { return this->get_txMsgCount(); }

    string              get_lastMsg(void);

    inline string       lastMsg(void)
    { return this->get_lastMsg(); }

    string              get_currentJob(void);

    inline string       currentJob(void)
    { return this->get_currentJob(); }

    int             set_currentJob(const string& newval);
    inline int      setCurrentJob(const string& newval)
    { return this->set_currentJob(newval); }

    string              get_startupJob(void);

    inline string       startupJob(void)
    { return this->get_startupJob(); }

    int             set_startupJob(const string& newval);
    inline int      setStartupJob(const string& newval)
    { return this->set_startupJob(newval); }

    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); }

    Y_VOLTAGELEVEL_enum get_voltageLevel(void);

    inline Y_VOLTAGELEVEL_enum voltageLevel(void)
    { return this->get_voltageLevel(); }

    int             set_voltageLevel(Y_VOLTAGELEVEL_enum newval);
    inline int      setVoltageLevel(Y_VOLTAGELEVEL_enum newval)
    { return this->set_voltageLevel(newval); }

    string              get_protocol(void);

    inline string       protocol(void)
    { return this->get_protocol(); }

    int             set_protocol(const string& newval);
    inline int      setProtocol(const string& newval)
    { return this->set_protocol(newval); }

    string              get_spiMode(void);

    inline string       spiMode(void)
    { return this->get_spiMode(); }

    int             set_spiMode(const string& newval);
    inline int      setSpiMode(const string& newval)
    { return this->set_spiMode(newval); }

    Y_SSPOLARITY_enum   get_ssPolarity(void);

    inline Y_SSPOLARITY_enum ssPolarity(void)
    { return this->get_ssPolarity(); }

    int             set_ssPolarity(Y_SSPOLARITY_enum newval);
    inline int      setSsPolarity(Y_SSPOLARITY_enum newval)
    { return this->set_ssPolarity(newval); }

    Y_SHITFTSAMPLING_enum get_shitftSampling(void);

    inline Y_SHITFTSAMPLING_enum shitftSampling(void)
    { return this->get_shitftSampling(); }

    int             set_shitftSampling(Y_SHITFTSAMPLING_enum newval);
    inline int      setShitftSampling(Y_SHITFTSAMPLING_enum newval)
    { return this->set_shitftSampling(newval); }

    static YSpiPort*    FindSpiPort(string func);

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

    virtual int         _invokeValueCallback(string value);

    virtual int         sendCommand(string text);

    virtual int         reset(void);

    virtual int         writeByte(int code);

    virtual int         writeStr(string text);

    virtual int         writeBin(string buff);

    virtual int         writeArray(vector<int> byteList);

    virtual int         writeHex(string hexString);

    virtual int         writeLine(string text);

    virtual int         readByte(void);

    virtual string      readStr(int nChars);

    virtual string      readBin(int nChars);

    virtual vector<int> readArray(int nChars);

    virtual string      readHex(int nBytes);

    virtual string      readLine(void);

    virtual vector<string> readMessages(string pattern,int maxWait);

    virtual int         read_seek(int absPos);

    virtual int         read_tell(void);

    virtual int         read_avail(void);

    virtual string      queryLine(string query,int maxWait);

    virtual int         uploadJob(string jobfile,string jsonDef);

    virtual int         selectJob(string jobfile);

    virtual int         set_SS(int val);


    inline static YSpiPort* Find(string func)
    { return YSpiPort::FindSpiPort(func); }

           YSpiPort        *nextSpiPort(void);
    inline YSpiPort        *next(void)
    { return this->nextSpiPort();}

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

//--- (YSpiPort functions declaration)

inline YSpiPort* yFindSpiPort(const string& func)
{ return YSpiPort::FindSpiPort(func);}
inline YSpiPort* yFirstSpiPort(void)
{ return YSpiPort::FirstSpiPort();}

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

#endif