Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/drv/at/ATIf.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Michael J. Spencer 1:f5ac63519541 1
Michael J. Spencer 1:f5ac63519541 2 /*
Michael J. Spencer 1:f5ac63519541 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Michael J. Spencer 1:f5ac63519541 4
Michael J. Spencer 1:f5ac63519541 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Michael J. Spencer 1:f5ac63519541 6 of this software and associated documentation files (the "Software"), to deal
Michael J. Spencer 1:f5ac63519541 7 in the Software without restriction, including without limitation the rights
Michael J. Spencer 1:f5ac63519541 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Michael J. Spencer 1:f5ac63519541 9 copies of the Software, and to permit persons to whom the Software is
Michael J. Spencer 1:f5ac63519541 10 furnished to do so, subject to the following conditions:
Michael J. Spencer 1:f5ac63519541 11
Michael J. Spencer 1:f5ac63519541 12 The above copyright notice and this permission notice shall be included in
Michael J. Spencer 1:f5ac63519541 13 all copies or substantial portions of the Software.
Michael J. Spencer 1:f5ac63519541 14
Michael J. Spencer 1:f5ac63519541 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Michael J. Spencer 1:f5ac63519541 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Michael J. Spencer 1:f5ac63519541 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Michael J. Spencer 1:f5ac63519541 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Michael J. Spencer 1:f5ac63519541 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Michael J. Spencer 1:f5ac63519541 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Michael J. Spencer 1:f5ac63519541 21 THE SOFTWARE.
Michael J. Spencer 1:f5ac63519541 22 */
Michael J. Spencer 1:f5ac63519541 23
Michael J. Spencer 1:f5ac63519541 24 #ifndef ATIF_H
Michael J. Spencer 1:f5ac63519541 25 #define ATIF_H
Michael J. Spencer 1:f5ac63519541 26
Michael J. Spencer 1:f5ac63519541 27 #include "netCfg.h"
Michael J. Spencer 1:f5ac63519541 28
Michael J. Spencer 1:f5ac63519541 29 #include "mbed.h"
Michael J. Spencer 1:f5ac63519541 30 #include "drv/serial/buf/SerialBuf.h"
Michael J. Spencer 1:f5ac63519541 31 #include <list>
Michael J. Spencer 1:f5ac63519541 32 using std::list;
Michael J. Spencer 1:f5ac63519541 33
Michael J. Spencer 1:f5ac63519541 34 //class Serial; //Pb w forward decl
Michael J. Spencer 1:f5ac63519541 35
Michael J. Spencer 1:f5ac63519541 36 enum ATErr
Michael J. Spencer 1:f5ac63519541 37 {
Michael J. Spencer 1:f5ac63519541 38 __AT_MIN = -0xFFFF,
Michael J. Spencer 1:f5ac63519541 39 AT_CLOSED,
Michael J. Spencer 1:f5ac63519541 40 AT_NOANSWER,
Michael J. Spencer 1:f5ac63519541 41 AT_ERROR,
Michael J. Spencer 1:f5ac63519541 42 AT_TIMEOUT,
Michael J. Spencer 1:f5ac63519541 43 AT_BUSY,
Michael J. Spencer 1:f5ac63519541 44 AT_PARSE,
Michael J. Spencer 1:f5ac63519541 45 AT_INCOMPLETE,
Michael J. Spencer 1:f5ac63519541 46 AT_OK = 0
Michael J. Spencer 1:f5ac63519541 47 };
Michael J. Spencer 1:f5ac63519541 48
Michael J. Spencer 1:f5ac63519541 49 class ATIf : public SerialBuf
Michael J. Spencer 1:f5ac63519541 50 {
Michael J. Spencer 1:f5ac63519541 51 public:
Michael J. Spencer 1:f5ac63519541 52
Michael J. Spencer 1:f5ac63519541 53 ATIf();
Michael J. Spencer 1:f5ac63519541 54 virtual ~ATIf();
Michael J. Spencer 1:f5ac63519541 55
Michael J. Spencer 1:f5ac63519541 56 #if 0
Michael J. Spencer 1:f5ac63519541 57 template<class T>
Michael J. Spencer 1:f5ac63519541 58 //void attachSignal( const char* sigName, T* pItem, bool (T::*pMethod)(ATIf*, bool, bool*) ); //Attach Signal ("Unsollicited response code" in Telit_AT_Reference_Guide.pdf) to an handler fn
Michael J. Spencer 1:f5ac63519541 59 //Linker bug : Must be defined here :(
Michael J. Spencer 1:f5ac63519541 60 void attachSignal( const char* sigName, T* pItem, bool (T::*pMethod)(ATIf*, bool, bool*) ) //Attach Signal ("Unsollicited response code" in Telit_AT_Reference_Guide.pdf) to an handler fn
Michael J. Spencer 1:f5ac63519541 61 {
Michael J. Spencer 1:f5ac63519541 62 ATSigHandler sig(sigName, (ATSigHandler::CDummy*)pItem, (bool (ATSigHandler::CDummy::*)(ATIf*, bool, bool*))pMethod);
Michael J. Spencer 1:f5ac63519541 63 m_signals.push_back(sig);
Michael J. Spencer 1:f5ac63519541 64 }
Michael J. Spencer 1:f5ac63519541 65 void detachSignal( const char* sigName );
Michael J. Spencer 1:f5ac63519541 66 #endif
Michael J. Spencer 1:f5ac63519541 67
Michael J. Spencer 1:f5ac63519541 68 ATErr open(Serial* pSerial); //Deactivate echo, etc
Michael J. Spencer 1:f5ac63519541 69 #if NET_USB_SERIAL
Michael J. Spencer 1:f5ac63519541 70 ATErr open(UsbSerial* pUsbSerial); //Deactivate echo, etc
Michael J. Spencer 1:f5ac63519541 71 #endif
Michael J. Spencer 1:f5ac63519541 72 ATErr close(); //Release port
Michael J. Spencer 1:f5ac63519541 73
Michael J. Spencer 1:f5ac63519541 74 int printf(const char* format, ... );
Michael J. Spencer 1:f5ac63519541 75 int scanf(const char* format, ... );
Michael J. Spencer 1:f5ac63519541 76 void setTimeout(int timeout); //used by scanf
Michael J. Spencer 1:f5ac63519541 77 void setLineMode(bool lineMode); //Switch btw line & raw fns
Michael J. Spencer 1:f5ac63519541 78 //void setSignals(bool signalsEnable);
Michael J. Spencer 1:f5ac63519541 79 ATErr flushBuffer(); //Discard input buffer
Michael J. Spencer 1:f5ac63519541 80 ATErr flushLine(int timeout); //Discard input buffer until CRLF is encountered
Michael J. Spencer 1:f5ac63519541 81
Michael J. Spencer 1:f5ac63519541 82 protected:
Michael J. Spencer 1:f5ac63519541 83 //virtual bool onRead(); //Inherited from SerialBuf, return true if data is incomplete
Michael J. Spencer 1:f5ac63519541 84 ATErr rawOpen(Serial* pSerial, int baudrate); //Simple open function for similar non-conforming protocols
Michael J. Spencer 1:f5ac63519541 85
Michael J. Spencer 1:f5ac63519541 86 public:
Michael J. Spencer 1:f5ac63519541 87 /* ATErr command(const char* cmd, char* result, int resultLen, int timeout); */ //Kinda useless
Michael J. Spencer 1:f5ac63519541 88 ATErr write(const char* cmd, bool lineMode = false);
Michael J. Spencer 1:f5ac63519541 89 ATErr read(char* result, int resultMaxLen, int timeout, bool lineMode = false, int resultMinLen = 0);
Michael J. Spencer 1:f5ac63519541 90 bool isOpen();
Michael J. Spencer 1:f5ac63519541 91 ATErr checkOK(); //Helper fn to quickly check that OK has been returned
Michael J. Spencer 1:f5ac63519541 92
Michael J. Spencer 1:f5ac63519541 93 private:
Michael J. Spencer 1:f5ac63519541 94 int readLine(char* line, int maxLen, int timeout); //Read a single line from serial port
Michael J. Spencer 1:f5ac63519541 95 int writeLine(const char* line); //Write a single line to serial port
Michael J. Spencer 1:f5ac63519541 96
Michael J. Spencer 1:f5ac63519541 97 int readRaw(char* str, int maxLen, int timeout = 0, int minLen = 0); //Read from serial port in buf
Michael J. Spencer 1:f5ac63519541 98 int writeRaw(const char* str); //Write directly to serial port
Michael J. Spencer 1:f5ac63519541 99
Michael J. Spencer 1:f5ac63519541 100 volatile int m_readTimeout;
Michael J. Spencer 1:f5ac63519541 101 volatile bool m_lineMode;
Michael J. Spencer 1:f5ac63519541 102 //bool m_signalsEnable;
Michael J. Spencer 1:f5ac63519541 103 bool m_isOpen;
Michael J. Spencer 1:f5ac63519541 104
Michael J. Spencer 1:f5ac63519541 105 char* m_tmpBuf;
Michael J. Spencer 1:f5ac63519541 106
Michael J. Spencer 1:f5ac63519541 107 #if 0
Michael J. Spencer 1:f5ac63519541 108 class ATSigHandler
Michael J. Spencer 1:f5ac63519541 109 {
Michael J. Spencer 1:f5ac63519541 110 class CDummy;
Michael J. Spencer 1:f5ac63519541 111 public:
Michael J. Spencer 1:f5ac63519541 112 ATSigHandler(const char* name, CDummy* cbObj, bool (CDummy::*cbMeth)(ATIf* pIf, bool beg, bool* pMoreData)) : m_cbObj(cbObj), m_cbMeth(cbMeth), m_name(name)
Michael J. Spencer 1:f5ac63519541 113 {}
Michael J. Spencer 1:f5ac63519541 114 protected:
Michael J. Spencer 1:f5ac63519541 115 CDummy* m_cbObj;
Michael J. Spencer 1:f5ac63519541 116 bool (CDummy::*m_cbMeth)(ATIf* pIf, bool beg, bool* pMoreData); //*pMoreData set to true if needs to read next line, beg = true if beginning of new code
Michael J. Spencer 1:f5ac63519541 117 const char* m_name;
Michael J. Spencer 1:f5ac63519541 118
Michael J. Spencer 1:f5ac63519541 119 friend class ATIf;
Michael J. Spencer 1:f5ac63519541 120 };
Michael J. Spencer 1:f5ac63519541 121
Michael J. Spencer 1:f5ac63519541 122 volatile ATSigHandler* m_pCurrentSignal; //Signal that asked more data
Michael J. Spencer 1:f5ac63519541 123
Michael J. Spencer 1:f5ac63519541 124 bool handleSignal(); //Returns true if signal has been handled
Michael J. Spencer 1:f5ac63519541 125 list<ATSigHandler> m_signals;
Michael J. Spencer 1:f5ac63519541 126 #endif
Michael J. Spencer 1:f5ac63519541 127
Michael J. Spencer 1:f5ac63519541 128 };
Michael J. Spencer 1:f5ac63519541 129
Michael J. Spencer 1:f5ac63519541 130 #endif