yocto_serialport.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_serialport.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindSerialPort(), the high-level API for SerialPort 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_SERIALPORT_H
#define YOCTO_SERIALPORT_H

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

//--- (generated code: YSerialPort return codes)
//--- (end of generated code: YSerialPort return codes)
//--- (generated code: YSerialPort definitions)
class YSerialPort; // forward declaration

typedef void (*YSerialPortValueCallback)(YSerialPort *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
#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_SERIALMODE_INVALID            (YAPI_INVALID_STRING)
//--- (end of generated code: YSerialPort definitions)


//--- (generated code: YSnoopingRecord definitions)
//--- (end of generated code: YSnoopingRecord definitions)

//--- (generated code: YSnoopingRecord declaration)
class YOCTO_CLASS_EXPORT YSnoopingRecord {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of generated code: YSnoopingRecord declaration)
    //--- (generated code: YSnoopingRecord attributes)
    // Attributes (function value cache)
    int             _tim;
    int             _dir;
    string          _msg;
    //--- (end of generated code: YSnoopingRecord attributes)
    //--- (generated code: YSnoopingRecord constructor)

    //--- (end of generated code: YSnoopingRecord constructor)
    //--- (generated code: YSnoopingRecord initialization)
    //--- (end of generated code: YSnoopingRecord initialization)

public:
    YSnoopingRecord(const string& json);
    //--- (generated code: YSnoopingRecord accessors declaration)


    virtual int         get_time(void);

    virtual int         get_direction(void);

    virtual string      get_message(void);

#ifdef __BORLANDC__
#pragma option pop
#endif
    //--- (end of generated code: YSnoopingRecord accessors declaration)
};





//--- (generated code: YSerialPort declaration)
class YOCTO_CLASS_EXPORT YSerialPort: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of generated code: YSerialPort declaration)
protected:
    //--- (generated code: YSerialPort 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          _serialMode;
    YSerialPortValueCallback _valueCallbackSerialPort;
    int             _rxptr;
    string          _rxbuff;
    int             _rxbuffptr;

    friend YSerialPort *yFindSerialPort(const string& func);
    friend YSerialPort *yFirstSerialPort(void);

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

    // Constructor is protected, use yFindSerialPort factory function to instantiate
    YSerialPort(const string& func);
    //--- (end of generated code: YSerialPort attributes)

public:
    ~YSerialPort();
    //--- (generated code: YSerialPort 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 SERIALMODE_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_serialMode(void);

    inline string       serialMode(void)
    { return this->get_serialMode(); }

    int             set_serialMode(const string& newval);
    inline int      setSerialMode(const string& newval)
    { return this->set_serialMode(newval); }

    static YSerialPort* FindSerialPort(string func);

    virtual int         registerValueCallback(YSerialPortValueCallback 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_RTS(int val);

    virtual int         get_CTS(void);

    virtual vector<YSnoopingRecord> snoopMessages(int maxWait);

    virtual int         writeMODBUS(string hexString);

    virtual vector<int> queryMODBUS(int slaveNo,vector<int> pduBytes);

    virtual vector<int> modbusReadBits(int slaveNo,int pduAddr,int nBits);

    virtual vector<int> modbusReadInputBits(int slaveNo,int pduAddr,int nBits);

    virtual vector<int> modbusReadRegisters(int slaveNo,int pduAddr,int nWords);

    virtual vector<int> modbusReadInputRegisters(int slaveNo,int pduAddr,int nWords);

    virtual int         modbusWriteBit(int slaveNo,int pduAddr,int value);

    virtual int         modbusWriteBits(int slaveNo,int pduAddr,vector<int> bits);

    virtual int         modbusWriteRegister(int slaveNo,int pduAddr,int value);

    virtual int         modbusWriteRegisters(int slaveNo,int pduAddr,vector<int> values);

    virtual vector<int> modbusWriteAndReadRegisters(int slaveNo,int pduWriteAddr,vector<int> values,int pduReadAddr,int nReadWords);


    inline static YSerialPort* Find(string func)
    { return YSerialPort::FindSerialPort(func); }

           YSerialPort     *nextSerialPort(void);
    inline YSerialPort     *next(void)
    { return this->nextSerialPort();}

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

//--- (generated code: YSerialPort functions declaration)

inline YSerialPort* yFindSerialPort(const string& func)
{ return YSerialPort::FindSerialPort(func);}
inline YSerialPort* yFirstSerialPort(void)
{ return YSerialPort::FirstSerialPort();}

//--- (end of generated code: YSerialPort functions declaration)

#endif