/********************************************************************* * * $Id: yocto_spiport.h 59978 2024-03-18 15:04:46Z mvuilleu $ * * 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 #include #include "yocto_api.h" #ifdef YOCTOLIB_NAMESPACE namespace YOCTOLIB_NAMESPACE { #endif //--- (generated code: YSpiPort return codes) //--- (end of generated code: YSpiPort return codes) //--- (generated code: YSpiPort yapiwrapper) //--- (end of generated code: YSpiPort yapiwrapper) //--- (generated code: 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_TTL1V8 = 7, Y_VOLTAGELEVEL_SDI12 = 8, 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_SHIFTSAMPLING_ENUM #define _Y_SHIFTSAMPLING_ENUM typedef enum { Y_SHIFTSAMPLING_OFF = 0, Y_SHIFTSAMPLING_ON = 1, Y_SHIFTSAMPLING_INVALID = -1, } Y_SHIFTSAMPLING_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_JOBMAXTASK_INVALID (YAPI_INVALID_UINT) #define Y_JOBMAXSIZE_INVALID (YAPI_INVALID_UINT) #define Y_COMMAND_INVALID (YAPI_INVALID_STRING) #define Y_PROTOCOL_INVALID (YAPI_INVALID_STRING) #define Y_SPIMODE_INVALID (YAPI_INVALID_STRING) //--- (end of generated code: YSpiPort definitions) //--- (generated code: YSpiSnoopingRecord definitions) //--- (end of generated code: YSpiSnoopingRecord definitions) //--- (generated code: YSpiSnoopingRecord declaration) /** * YSpiSnoopingRecord Class: Intercepted SPI message description, returned by spiPort.snoopMessages method * * */ class YOCTO_CLASS_EXPORT YSpiSnoopingRecord { #ifdef __BORLANDC__ #pragma option push -w-8022 #endif //--- (end of generated code: YSpiSnoopingRecord declaration) //--- (generated code: YSpiSnoopingRecord attributes) // Attributes (function value cache) int _tim; int _pos; int _dir; string _msg; //--- (end of generated code: YSpiSnoopingRecord attributes) //--- (generated code: YSpiSnoopingRecord constructor) //--- (end of generated code: YSpiSnoopingRecord constructor) //--- (generated code: YSpiSnoopingRecord initialization) //--- (end of generated code: YSpiSnoopingRecord initialization) public: YSpiSnoopingRecord(const string& json); virtual ~YSpiSnoopingRecord(){}; //--- (generated code: YSpiSnoopingRecord accessors declaration) /** * Returns the elapsed time, in ms, since the beginning of the preceding message. * * @return the elapsed time, in ms, since the beginning of the preceding message. */ virtual int get_time(void); /** * Returns the absolute position of the message end. * * @return the absolute position of the message end. */ virtual int get_pos(void); /** * Returns the message direction (RX=0, TX=1). * * @return the message direction (RX=0, TX=1). */ virtual int get_direction(void); /** * Returns the message content. * * @return the message content. */ virtual string get_message(void); #ifdef __BORLANDC__ #pragma option pop #endif //--- (end of generated code: YSpiSnoopingRecord accessors declaration) }; //--- (generated code: YSpiPort declaration) /** * YSpiPort Class: SPI port control interface, available for instance in the Yocto-SPI * * The YSpiPort class allows you to fully drive a Yoctopuce SPI port. * It can be used to send and receive data, and to configure communication * parameters (baud rate, bit count, parity, flow control and protocol). * Note that Yoctopuce SPI ports are not exposed as virtual COM ports. * They are meant to be used in the same way as all Yoctopuce devices. */ class YOCTO_CLASS_EXPORT YSpiPort: public YFunction { #ifdef __BORLANDC__ #pragma option push -w-8022 #endif //--- (end of generated code: YSpiPort declaration) protected: //--- (generated code: YSpiPort attributes) // Attributes (function value cache) int _rxCount; int _txCount; int _errCount; int _rxMsgCount; int _txMsgCount; string _lastMsg; string _currentJob; string _startupJob; int _jobMaxTask; int _jobMaxSize; string _command; string _protocol; Y_VOLTAGELEVEL_enum _voltageLevel; string _spiMode; Y_SSPOLARITY_enum _ssPolarity; Y_SHIFTSAMPLING_enum _shiftSampling; YSpiPortValueCallback _valueCallbackSpiPort; int _rxptr; string _rxbuff; int _rxbuffptr; int _eventPos; 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 generated code: YSpiPort attributes) public: virtual ~YSpiPort(); //--- (generated code: 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 int JOBMAXTASK_INVALID = YAPI_INVALID_UINT; static const int JOBMAXSIZE_INVALID = YAPI_INVALID_UINT; static const string COMMAND_INVALID; static const string PROTOCOL_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_TTL1V8 = Y_VOLTAGELEVEL_TTL1V8; static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_SDI12 = Y_VOLTAGELEVEL_SDI12; static const Y_VOLTAGELEVEL_enum VOLTAGELEVEL_INVALID = Y_VOLTAGELEVEL_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_SHIFTSAMPLING_enum SHIFTSAMPLING_OFF = Y_SHIFTSAMPLING_OFF; static const Y_SHIFTSAMPLING_enum SHIFTSAMPLING_ON = Y_SHIFTSAMPLING_ON; static const Y_SHIFTSAMPLING_enum SHIFTSAMPLING_INVALID = Y_SHIFTSAMPLING_INVALID; /** * Returns the total number of bytes received since last reset. * * @return an integer corresponding to the total number of bytes received since last reset * * On failure, throws an exception or returns YSpiPort::RXCOUNT_INVALID. */ int get_rxCount(void); inline int rxCount(void) { return this->get_rxCount(); } /** * Returns the total number of bytes transmitted since last reset. * * @return an integer corresponding to the total number of bytes transmitted since last reset * * On failure, throws an exception or returns YSpiPort::TXCOUNT_INVALID. */ int get_txCount(void); inline int txCount(void) { return this->get_txCount(); } /** * Returns the total number of communication errors detected since last reset. * * @return an integer corresponding to the total number of communication errors detected since last reset * * On failure, throws an exception or returns YSpiPort::ERRCOUNT_INVALID. */ int get_errCount(void); inline int errCount(void) { return this->get_errCount(); } /** * Returns the total number of messages received since last reset. * * @return an integer corresponding to the total number of messages received since last reset * * On failure, throws an exception or returns YSpiPort::RXMSGCOUNT_INVALID. */ int get_rxMsgCount(void); inline int rxMsgCount(void) { return this->get_rxMsgCount(); } /** * Returns the total number of messages send since last reset. * * @return an integer corresponding to the total number of messages send since last reset * * On failure, throws an exception or returns YSpiPort::TXMSGCOUNT_INVALID. */ int get_txMsgCount(void); inline int txMsgCount(void) { return this->get_txMsgCount(); } /** * Returns the latest message fully received (for Line and Frame protocols). * * @return a string corresponding to the latest message fully received (for Line and Frame protocols) * * On failure, throws an exception or returns YSpiPort::LASTMSG_INVALID. */ string get_lastMsg(void); inline string lastMsg(void) { return this->get_lastMsg(); } /** * Returns the name of the job file currently in use. * * @return a string corresponding to the name of the job file currently in use * * On failure, throws an exception or returns YSpiPort::CURRENTJOB_INVALID. */ string get_currentJob(void); inline string currentJob(void) { return this->get_currentJob(); } /** * Selects a job file to run immediately. If an empty string is * given as argument, stops running current job file. * * @param newval : a string * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_currentJob(const string& newval); inline int setCurrentJob(const string& newval) { return this->set_currentJob(newval); } /** * Returns the job file to use when the device is powered on. * * @return a string corresponding to the job file to use when the device is powered on * * On failure, throws an exception or returns YSpiPort::STARTUPJOB_INVALID. */ string get_startupJob(void); inline string startupJob(void) { return this->get_startupJob(); } /** * Changes the job to use when the device is powered on. * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @param newval : a string corresponding to the job to use when the device is powered on * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_startupJob(const string& newval); inline int setStartupJob(const string& newval) { return this->set_startupJob(newval); } /** * Returns the maximum number of tasks in a job that the device can handle. * * @return an integer corresponding to the maximum number of tasks in a job that the device can handle * * On failure, throws an exception or returns YSpiPort::JOBMAXTASK_INVALID. */ int get_jobMaxTask(void); inline int jobMaxTask(void) { return this->get_jobMaxTask(); } /** * Returns maximum size allowed for job files. * * @return an integer corresponding to maximum size allowed for job files * * On failure, throws an exception or returns YSpiPort::JOBMAXSIZE_INVALID. */ int get_jobMaxSize(void); inline int jobMaxSize(void) { return this->get_jobMaxSize(); } 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); } /** * Returns the type of protocol used over the serial line, as a string. * Possible values are "Line" for ASCII messages separated by CR and/or LF, * "Frame:[timeout]ms" for binary messages separated by a delay time, * "Char" for a continuous ASCII stream or * "Byte" for a continuous binary stream. * * @return a string corresponding to the type of protocol used over the serial line, as a string * * On failure, throws an exception or returns YSpiPort::PROTOCOL_INVALID. */ string get_protocol(void); inline string protocol(void) { return this->get_protocol(); } /** * Changes the type of protocol used over the serial line. * Possible values are "Line" for ASCII messages separated by CR and/or LF, * "Frame:[timeout]ms" for binary messages separated by a delay time, * "Char" for a continuous ASCII stream or * "Byte" for a continuous binary stream. * The suffix "/[wait]ms" can be added to reduce the transmit rate so that there * is always at lest the specified number of milliseconds between each bytes sent. * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @param newval : a string corresponding to the type of protocol used over the serial line * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_protocol(const string& newval); inline int setProtocol(const string& newval) { return this->set_protocol(newval); } /** * Returns the voltage level used on the serial line. * * @return a value among YSpiPort::VOLTAGELEVEL_OFF, YSpiPort::VOLTAGELEVEL_TTL3V, * YSpiPort::VOLTAGELEVEL_TTL3VR, YSpiPort::VOLTAGELEVEL_TTL5V, YSpiPort::VOLTAGELEVEL_TTL5VR, * YSpiPort::VOLTAGELEVEL_RS232, YSpiPort::VOLTAGELEVEL_RS485, YSpiPort::VOLTAGELEVEL_TTL1V8 and * YSpiPort::VOLTAGELEVEL_SDI12 corresponding to the voltage level used on the serial line * * On failure, throws an exception or returns YSpiPort::VOLTAGELEVEL_INVALID. */ Y_VOLTAGELEVEL_enum get_voltageLevel(void); inline Y_VOLTAGELEVEL_enum voltageLevel(void) { return this->get_voltageLevel(); } /** * Changes the voltage type used on the serial line. Valid * values will depend on the Yoctopuce device model featuring * the serial port feature. Check your device documentation * to find out which values are valid for that specific model. * Trying to set an invalid value will have no effect. * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @param newval : a value among YSpiPort::VOLTAGELEVEL_OFF, YSpiPort::VOLTAGELEVEL_TTL3V, * YSpiPort::VOLTAGELEVEL_TTL3VR, YSpiPort::VOLTAGELEVEL_TTL5V, YSpiPort::VOLTAGELEVEL_TTL5VR, * YSpiPort::VOLTAGELEVEL_RS232, YSpiPort::VOLTAGELEVEL_RS485, YSpiPort::VOLTAGELEVEL_TTL1V8 and * YSpiPort::VOLTAGELEVEL_SDI12 corresponding to the voltage type used on the serial line * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_voltageLevel(Y_VOLTAGELEVEL_enum newval); inline int setVoltageLevel(Y_VOLTAGELEVEL_enum newval) { return this->set_voltageLevel(newval); } /** * Returns the SPI port communication parameters, as a string such as * "125000,0,msb". The string includes the baud rate, the SPI mode (between * 0 and 3) and the bit order. * * @return a string corresponding to the SPI port communication parameters, as a string such as * "125000,0,msb" * * On failure, throws an exception or returns YSpiPort::SPIMODE_INVALID. */ string get_spiMode(void); inline string spiMode(void) { return this->get_spiMode(); } /** * Changes the SPI port communication parameters, with a string such as * "125000,0,msb". The string includes the baud rate, the SPI mode (between * 0 and 3) and the bit order. * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @param newval : a string corresponding to the SPI port communication parameters, with a string such as * "125000,0,msb" * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_spiMode(const string& newval); inline int setSpiMode(const string& newval) { return this->set_spiMode(newval); } /** * Returns the SS line polarity. * * @return either YSpiPort::SSPOLARITY_ACTIVE_LOW or YSpiPort::SSPOLARITY_ACTIVE_HIGH, according to the * SS line polarity * * On failure, throws an exception or returns YSpiPort::SSPOLARITY_INVALID. */ Y_SSPOLARITY_enum get_ssPolarity(void); inline Y_SSPOLARITY_enum ssPolarity(void) { return this->get_ssPolarity(); } /** * Changes the SS line polarity. * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @param newval : either YSpiPort::SSPOLARITY_ACTIVE_LOW or YSpiPort::SSPOLARITY_ACTIVE_HIGH, according * to the SS line polarity * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_ssPolarity(Y_SSPOLARITY_enum newval); inline int setSsPolarity(Y_SSPOLARITY_enum newval) { return this->set_ssPolarity(newval); } /** * Returns true when the SDI line phase is shifted with regards to the SDO line. * * @return either YSpiPort::SHIFTSAMPLING_OFF or YSpiPort::SHIFTSAMPLING_ON, according to true when the * SDI line phase is shifted with regards to the SDO line * * On failure, throws an exception or returns YSpiPort::SHIFTSAMPLING_INVALID. */ Y_SHIFTSAMPLING_enum get_shiftSampling(void); inline Y_SHIFTSAMPLING_enum shiftSampling(void) { return this->get_shiftSampling(); } /** * Changes the SDI line sampling shift. When disabled, SDI line is * sampled in the middle of data output time. When enabled, SDI line is * samples at the end of data output time. * Remember to call the saveToFlash() method of the module if the * modification must be kept. * * @param newval : either YSpiPort::SHIFTSAMPLING_OFF or YSpiPort::SHIFTSAMPLING_ON, according to the * SDI line sampling shift * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ int set_shiftSampling(Y_SHIFTSAMPLING_enum newval); inline int setShiftSampling(Y_SHIFTSAMPLING_enum newval) { return this->set_shiftSampling(newval); } /** * Retrieves an SPI 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 SPI port is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method isOnline() to test if the SPI port is * indeed online at a given time. In case of ambiguity when looking for * an SPI 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. * * @param func : a string that uniquely characterizes the SPI port, for instance * YSPIMK01.spiPort. * * @return a YSpiPort object allowing you to drive the SPI port. */ static YSpiPort* FindSpiPort(string func); /** * Registers the callback function that is invoked on every change of advertised value. * The callback is invoked only during the execution of ySleep or yHandleEvents. * This provides control over the time when the callback is triggered. For good responsiveness, remember to call * one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument. * * @param callback : the callback function to call, or a NULL pointer. The callback function should take two * arguments: the function object of which the value has changed, and the character string describing * the new advertised value. * @noreturn */ virtual int registerValueCallback(YSpiPortValueCallback callback); using YFunction::registerValueCallback; virtual int _invokeValueCallback(string value); virtual int sendCommand(string text); /** * Reads a single line (or message) from the receive buffer, starting at current stream position. * This function is intended to be used when the serial port is configured for a message protocol, * such as 'Line' mode or frame protocols. * * If data at current stream position is not available anymore in the receive buffer, * the function returns the oldest available line and moves the stream position just after. * If no new full line is received, the function returns an empty line. * * @return a string with a single line of text * * On failure, throws an exception or returns a negative error code. */ virtual string readLine(void); /** * Searches for incoming messages in the serial port receive buffer matching a given pattern, * starting at current position. This function will only compare and return printable characters * in the message strings. Binary protocols are handled as hexadecimal strings. * * The search returns all messages matching the expression provided as argument in the buffer. * If no matching message is found, the search waits for one up to the specified maximum timeout * (in milliseconds). * * @param pattern : a limited regular expression describing the expected message format, * or an empty string if all messages should be returned (no filtering). * When using binary protocols, the format applies to the hexadecimal * representation of the message. * @param maxWait : the maximum number of milliseconds to wait for a message if none is found * in the receive buffer. * * @return an array of strings containing the messages found, if any. * Binary messages are converted to hexadecimal representation. * * On failure, throws an exception or returns an empty array. */ virtual vector readMessages(string pattern,int maxWait); /** * Changes the current internal stream position to the specified value. This function * does not affect the device, it only changes the value stored in the API object * for the next read operations. * * @param absPos : the absolute position index for next read operations. * * @return nothing. */ virtual int read_seek(int absPos); /** * Returns the current absolute stream position pointer of the API object. * * @return the absolute position index for next read operations. */ virtual int read_tell(void); /** * Returns the number of bytes available to read in the input buffer starting from the * current absolute stream position pointer of the API object. * * @return the number of bytes available to read */ virtual int read_avail(void); virtual int end_tell(void); /** * Sends a text line query to the serial port, and reads the reply, if any. * This function is intended to be used when the serial port is configured for 'Line' protocol. * * @param query : the line query to send (without CR/LF) * @param maxWait : the maximum number of milliseconds to wait for a reply. * * @return the next text line received after sending the text query, as a string. * Additional lines can be obtained by calling readLine or readMessages. * * On failure, throws an exception or returns an empty string. */ virtual string queryLine(string query,int maxWait); /** * Sends a binary message to the serial port, and reads the reply, if any. * This function is intended to be used when the serial port is configured for * Frame-based protocol. * * @param hexString : the message to send, coded in hexadecimal * @param maxWait : the maximum number of milliseconds to wait for a reply. * * @return the next frame received after sending the message, as a hex string. * Additional frames can be obtained by calling readHex or readMessages. * * On failure, throws an exception or returns an empty string. */ virtual string queryHex(string hexString,int maxWait); /** * Saves the job definition string (JSON data) into a job file. * The job file can be later enabled using selectJob(). * * @param jobfile : name of the job file to save on the device filesystem * @param jsonDef : a string containing a JSON definition of the job * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int uploadJob(string jobfile,string jsonDef); /** * Load and start processing the specified job file. The file must have * been previously created using the user interface or uploaded on the * device filesystem using the uploadJob() function. * * @param jobfile : name of the job file (on the device filesystem) * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int selectJob(string jobfile); /** * Clears the serial port buffer and resets counters to zero. * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int reset(void); /** * Sends a single byte to the serial port. * * @param code : the byte to send * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int writeByte(int code); /** * Sends an ASCII string to the serial port, as is. * * @param text : the text string to send * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int writeStr(string text); /** * Sends a binary buffer to the serial port, as is. * * @param buff : the binary buffer to send * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int writeBin(string buff); /** * Sends a byte sequence (provided as a list of bytes) to the serial port. * * @param byteList : a list of byte codes * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int writeArray(vector byteList); /** * Sends a byte sequence (provided as a hexadecimal string) to the serial port. * * @param hexString : a string of hexadecimal byte codes * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int writeHex(string hexString); /** * Sends an ASCII string to the serial port, followed by a line break (CR LF). * * @param text : the text string to send * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int writeLine(string text); /** * Reads one byte from the receive buffer, starting at current stream position. * If data at current stream position is not available anymore in the receive buffer, * or if there is no data available yet, the function returns YAPI::NO_MORE_DATA. * * @return the next byte * * On failure, throws an exception or returns a negative error code. */ virtual int readByte(void); /** * Reads data from the receive buffer as a string, starting at current stream position. * If data at current stream position is not available anymore in the receive buffer, the * function performs a short read. * * @param nChars : the maximum number of characters to read * * @return a string with receive buffer contents * * On failure, throws an exception or returns a negative error code. */ virtual string readStr(int nChars); /** * Reads data from the receive buffer as a binary buffer, starting at current stream position. * If data at current stream position is not available anymore in the receive buffer, the * function performs a short read. * * @param nChars : the maximum number of bytes to read * * @return a binary object with receive buffer contents * * On failure, throws an exception or returns a negative error code. */ virtual string readBin(int nChars); /** * Reads data from the receive buffer as a list of bytes, starting at current stream position. * If data at current stream position is not available anymore in the receive buffer, the * function performs a short read. * * @param nChars : the maximum number of bytes to read * * @return a sequence of bytes with receive buffer contents * * On failure, throws an exception or returns an empty array. */ virtual vector readArray(int nChars); /** * Reads data from the receive buffer as a hexadecimal string, starting at current stream position. * If data at current stream position is not available anymore in the receive buffer, the * function performs a short read. * * @param nBytes : the maximum number of bytes to read * * @return a string with receive buffer contents, encoded in hexadecimal * * On failure, throws an exception or returns a negative error code. */ virtual string readHex(int nBytes); /** * Manually sets the state of the SS line. This function has no effect when * the SS line is handled automatically. * * @param val : 1 to turn SS active, 0 to release SS. * * @return YAPI::SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ virtual int set_SS(int val); /** * Retrieves messages (both direction) in the SPI port buffer, starting at current position. * * If no message is found, the search waits for one up to the specified maximum timeout * (in milliseconds). * * @param maxWait : the maximum number of milliseconds to wait for a message if none is found * in the receive buffer. * @param maxMsg : the maximum number of messages to be returned by the function; up to 254. * * @return an array of YSpiSnoopingRecord objects containing the messages found, if any. * * On failure, throws an exception or returns an empty array. */ virtual vector snoopMessagesEx(int maxWait,int maxMsg); /** * Retrieves messages (both direction) in the SPI port buffer, starting at current position. * * If no message is found, the search waits for one up to the specified maximum timeout * (in milliseconds). * * @param maxWait : the maximum number of milliseconds to wait for a message if none is found * in the receive buffer. * * @return an array of YSpiSnoopingRecord objects containing the messages found, if any. * * On failure, throws an exception or returns an empty array. */ virtual vector snoopMessages(int maxWait); inline static YSpiPort *Find(string func) { return YSpiPort::FindSpiPort(func); } /** * Continues the enumeration of SPI ports started using yFirstSpiPort(). * Caution: You can't make any assumption about the returned SPI ports order. * If you want to find a specific an SPI port, use SpiPort.findSpiPort() * and a hardwareID or a logical name. * * @return a pointer to a YSpiPort object, corresponding to * an SPI port currently online, or a NULL pointer * if there are no more SPI ports to enumerate. */ YSpiPort *nextSpiPort(void); inline YSpiPort *next(void) { return this->nextSpiPort();} /** * Starts the enumeration of SPI ports currently accessible. * Use the method YSpiPort::nextSpiPort() to iterate on * next SPI ports. * * @return a pointer to a YSpiPort object, corresponding to * the first SPI port currently online, or a NULL pointer * if there are none. */ static YSpiPort *FirstSpiPort(void); inline static YSpiPort *First(void) { return YSpiPort::FirstSpiPort();} #ifdef __BORLANDC__ #pragma option pop #endif //--- (end of generated code: YSpiPort accessors declaration) }; //--- (generated code: YSpiPort functions declaration) /** * Retrieves an SPI 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 SPI port is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method isOnline() to test if the SPI port is * indeed online at a given time. In case of ambiguity when looking for * an SPI 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. * * @param func : a string that uniquely characterizes the SPI port, for instance * YSPIMK01.spiPort. * * @return a YSpiPort object allowing you to drive the SPI port. */ inline YSpiPort *yFindSpiPort(const string& func) { return YSpiPort::FindSpiPort(func);} /** * Starts the enumeration of SPI ports currently accessible. * Use the method YSpiPort::nextSpiPort() to iterate on * next SPI ports. * * @return a pointer to a YSpiPort object, corresponding to * the first SPI port currently online, or a NULL pointer * if there are none. */ inline YSpiPort *yFirstSpiPort(void) { return YSpiPort::FirstSpiPort();} //--- (end of generated code: YSpiPort functions declaration) #ifdef YOCTOLIB_NAMESPACE // end of namespace definition } #endif #endif