diff --git a/extras/AT Command Manuals/Sequans Monarch AT Commands Manual.pdf b/extras/AT Command Manuals/Sequans Monarch AT Commands Manual.pdf new file mode 100644 index 0000000..84c8f7c Binary files /dev/null and b/extras/AT Command Manuals/Sequans Monarch AT Commands Manual.pdf differ diff --git a/src/TinyGsmClient.h b/src/TinyGsmClient.h index 0ba7ca3..2e4218e 100644 --- a/src/TinyGsmClient.h +++ b/src/TinyGsmClient.h @@ -96,6 +96,15 @@ typedef TinyGsmXBee::GsmClient TinyGsmClient; typedef TinyGsmXBee::GsmClientSecure TinyGsmClientSecure; +#elif defined(TINY_GSM_MODEM_SEQUANS_MONARCH) + #define TINY_GSM_MODEM_HAS_GPRS + #define TINY_GSM_MODEM_HAS_SSL + #include + typedef TinyGsmSequansMonarch TinyGsm; + typedef TinyGsmSequansMonarch::GsmClient TinyGsmClient; + typedef TinyGsmSequansMonarch::GsmClientSecure TinyGsmClientSecure; + + #else #error "Please define GSM modem model" #endif diff --git a/src/TinyGsmClientSequansMonarch.h b/src/TinyGsmClientSequansMonarch.h new file mode 100644 index 0000000..02cd12b --- /dev/null +++ b/src/TinyGsmClientSequansMonarch.h @@ -0,0 +1,830 @@ +/** + * @file TinyGsmClientSequansMonarch.h + * @author Michael Krumpus + * @license LGPL-3.0 + * @copyright Copyright (c) 2019 Michael Krumpus + * @date Jan 2019 + */ + +#ifndef TinyGsmClientSequansMonarch_h +#define TinyGsmClientSequansMonarch_h + +//#define TINY_GSM_DEBUG Serial +//#define TINY_GSM_USE_HEX + +#if !defined(TINY_GSM_RX_BUFFER) + #define TINY_GSM_RX_BUFFER 64 +#endif + +#define TINY_GSM_MUX_COUNT 5 + +#include + +#define GSM_NL "\r\n" +static const char GSM_OK[] TINY_GSM_PROGMEM = "OK" GSM_NL; +static const char GSM_ERROR[] TINY_GSM_PROGMEM = "ERROR" GSM_NL; + +enum SimStatus { + SIM_ERROR = 0, + SIM_READY = 1, + SIM_LOCKED = 2, +}; + +enum RegStatus { + REG_UNREGISTERED = 0, + REG_SEARCHING = 2, + REG_DENIED = 3, + REG_OK_HOME = 1, + REG_OK_ROAMING = 5, + REG_UNKNOWN = 4, +}; + +#define NUM_SOCKETS 6 + +enum SocketStatus { + SOCK_CLOSED = 0, + SOCK_ACTIVE_DATA = 1, + SOCK_SUSPENDED = 2, + SOCK_SUSPENDED_PENDING_DATA = 3, + SOCK_LISTENING = 4, + SOCK_INCOMING = 5, + SOCK_OPENING = 6, +}; + + +class TinyGsmSequansMonarch +{ + +public: + +class GsmClient : public Client +{ + friend class TinyGsmSequansMonarch; + typedef TinyGsmFifo RxFifo; + +public: + GsmClient() {} + + GsmClient(TinyGsmSequansMonarch& modem, uint8_t mux = 1) { + init(&modem, mux); + } + + bool init(TinyGsmSequansMonarch* modem, uint8_t mux = 1) { + this->at = modem; + this->mux = mux; + sock_available = 0; + prev_check = 0; + sock_connected = false; + got_data = false; + + at->sockets[mux] = this; + + return true; + } + +public: + virtual int connect(const char *host, uint16_t port) { + if (sock_connected) stop(); + TINY_GSM_YIELD(); + rx.clear(); + sock_connected = at->modemConnect(host, port, mux); + return sock_connected; + } + + virtual int connect(IPAddress ip, uint16_t port) { + String host; host.reserve(16); + host += ip[0]; + host += "."; + host += ip[1]; + host += "."; + host += ip[2]; + host += "."; + host += ip[3]; + return connect(host.c_str(), port); + } + + virtual void stop() { + TINY_GSM_YIELD(); + at->sendAT(GF("+SQNSH="), mux); + sock_connected = false; + at->waitResponse(); + rx.clear(); + } + + virtual size_t write(const uint8_t *buf, size_t size) { + TINY_GSM_YIELD(); + at->maintain(); + return at->modemSend(buf, size, mux); + } + + virtual size_t write(uint8_t c) { + return write(&c, 1); + } + + virtual int available() { + TINY_GSM_YIELD(); + if (!rx.size()) { + // Workaround: sometimes unsolicited SQNSSRING notifications do not arrive. + if (millis() - prev_check > 500) { + got_data = true; + prev_check = millis(); + } + at->maintain(); + } + return rx.size() + sock_available; + } + + virtual int read(uint8_t *buf, size_t size) { + TINY_GSM_YIELD(); + at->maintain(); + size_t cnt = 0; + while (cnt < size) { + size_t chunk = TinyGsmMin(size-cnt, rx.size()); + if (chunk > 0) { + rx.get(buf, chunk); + buf += chunk; + cnt += chunk; + continue; + } + // TODO: Read directly into user buffer? + at->maintain(); + if (sock_available > 0) { + int n = at->modemRead(rx.free(), mux); + if (n == 0) break; + } else { + break; + } + } + return cnt; + } + + virtual int read() { + uint8_t c; + if (read(&c, 1) == 1) { + return c; + } + return -1; + } + + virtual int peek() { return -1; } //TODO + virtual void flush() { + at->stream.flush(); + } + + virtual uint8_t connected() { + if (available()) { + return true; + } + return got_data || sock_connected; + } + virtual operator bool() { return connected(); } + + /* + * Extended API + */ + + String remoteIP() TINY_GSM_ATTR_NOT_IMPLEMENTED; + +private: + TinyGsmSequansMonarch* at; + uint8_t mux; + uint16_t sock_available; + uint32_t prev_check; + bool sock_connected; + bool got_data; + RxFifo rx; +}; + +class GsmClientSecure : public GsmClient +{ +public: + GsmClientSecure() {} + + GsmClientSecure(TinyGsmSequansMonarch& modem, uint8_t mux = 1) + : GsmClient(modem, mux) + {} + +protected: + bool strictSSL = false; + +public: + virtual int connect(const char *host, uint16_t port) { + if (sock_connected) stop(); + TINY_GSM_YIELD(); + rx.clear(); + + // configure security profile 1 with parameters: + if (strictSSL) { + // require minimum of TLS 1.2 (3) + // only support cipher suite 0x3D: TLS_RSA_WITH_AES_256_CBC_SHA256 + // verify server certificate against imported CA certs 0 and enforce validity period (3) + at->sendAT(GF("+SQNSPCFG=1,3,\"0x3D\",3,0,,,\"\",\"\"")); + } else { + // use TLS 1.0 or higher (1) + // support wider variety of cipher suites + // do not verify server certificate (0) + at->sendAT(GF("+SQNSPCFG=1,1,\"0x2F;0x35;0x3C;0x3D\",0,,,,\"\",\"\"")); + } + if (at->waitResponse() != 1) { + DBG("failed to configure security profile"); + return false; + } + + sock_connected = at->modemConnect(host, port, mux, true); + return sock_connected; + } + + void setStrictSSL(bool strict) { + strictSSL = strict; + } + +}; + +public: + + TinyGsmSequansMonarch(Stream& stream) + : stream(stream) + { + memset(sockets, 0, sizeof(sockets)); + } + + /* + * Basic functions + */ + bool begin() { + return init(); + } + + bool init() { + DBG(GF("### TinyGSM Version:"), TINYGSM_VERSION); + if (!testAT()) { + return false; + } + sendAT(GF("E0")); // Echo Off + if (waitResponse() != 1) { + return false; + } + getSimStatus(); + return true; + } + + void setBaud(unsigned long baud) { + sendAT(GF("+IPR="), baud); + } + + bool testAT(unsigned long timeout = 10000L) { + for (unsigned long start = millis(); millis() - start < timeout; ) { + sendAT(GF("")); + if (waitResponse(200) == 1) { + delay(100); + return true; + } + delay(100); + } + return false; + } + + void maintain() { + for (int mux = 0; mux < TINY_GSM_MUX_COUNT; mux++) { + GsmClient* sock = sockets[mux]; + if (sock && sock->got_data) { + sock->got_data = false; + sock->sock_available = modemGetAvailable(mux); + } + } + + while (stream.available()) { + waitResponse(10, NULL, NULL); + } + } + + bool factoryDefault() { + sendAT(GF("&FZE0&W")); // Factory + Reset + Echo Off + Write + waitResponse(); + sendAT(GF("+IPR=0")); // Auto-baud + waitResponse(); + sendAT(GF("+IFC=0,0")); // No Flow Control + waitResponse(); + sendAT(GF("+ICF=3,3")); // 8 data 0 parity 1 stop + waitResponse(); + sendAT(GF("+CSCLK=0")); // Disable Slow Clock + waitResponse(); + sendAT(GF("&W")); // Write configuration + return waitResponse() == 1; + } + + String getModemInfo() { + sendAT(GF("I")); + String res; + if (waitResponse(1000L, res) != 1) { + return ""; + } + res.replace(GSM_NL "OK" GSM_NL, ""); + res.replace(GSM_NL, " "); + res.trim(); + return res; + } + + bool hasSSL() { + return true; + } + + /* + * Power functions + */ + + bool restart() { + if (!testAT()) { + return false; + } + + sendAT(GF("+CFUN=0")); + if (waitResponse(10000L) != 1) { + return false; + } + + sendAT(GF("+CFUN=1,1")); + if (waitResponse(60000L, GF("+SYSSTART")) != 1) { + return false; + } + delay(1000); + return init(); + } + + bool poweroff() { + sendAT(GF("+SQNSSHDN")); + return waitResponse(); + } + + bool radioOff() { + sendAT(GF("+CFUN=0")); + if (waitResponse(10000L) != 1) { + return false; + } + delay(3000); + return true; + } + + /* + During sleep, the SIM800 module has its serial communication disabled. In order to reestablish communication + pull the DRT-pin of the SIM800 module LOW for at least 50ms. Then use this function to disable sleep mode. + The DTR-pin can then be released again. + */ + bool sleepEnable(bool enable = true) { + sendAT(GF("+CSCLK="), enable); + return waitResponse() == 1; + } + + /* + * SIM card functions + */ + + bool simUnlock(const char *pin) { + sendAT(GF("+CPIN=\""), pin, GF("\"")); + return waitResponse() == 1; + } + + String getSimCCID() { + sendAT(GF("+SQNCCID")); + if (waitResponse(GF(GSM_NL "+SQNCCID:")) != 1) { + return ""; + } + String res = stream.readStringUntil('\n'); + waitResponse(); + res.trim(); + return res; + } + + String getIMEI() { + sendAT(GF("+GSN")); + if (waitResponse(GF(GSM_NL)) != 1) { + return ""; + } + String res = stream.readStringUntil('\n'); + waitResponse(); + res.trim(); + return res; + } + + SimStatus getSimStatus(unsigned long timeout = 10000L) { + for (unsigned long start = millis(); millis() - start < timeout; ) { + sendAT(GF("+CPIN?")); + if (waitResponse(GF(GSM_NL "+CPIN:")) != 1) { + delay(1000); + continue; + } + int status = waitResponse(GF("READY"), GF("SIM PIN"), GF("SIM PUK"), GF("NOT INSERTED")); + waitResponse(); + switch (status) { + case 2: + case 3: return SIM_LOCKED; + case 1: return SIM_READY; + default: return SIM_ERROR; + } + } + return SIM_ERROR; + } + + RegStatus getRegistrationStatus() { + //sendAT(GF("+CREG?")); + sendAT(GF("+CEREG?")); + if (waitResponse(GF(GSM_NL "+CEREG:")) != 1) { + return REG_UNKNOWN; + } + streamSkipUntil(','); // Skip format (0) + int status = stream.readStringUntil(',').toInt(); + waitResponse(); + return (RegStatus)status; + } + + String getOperator() { + sendAT(GF("+COPS?")); + if (waitResponse(GF(GSM_NL "+COPS:")) != 1) { + return ""; + } + streamSkipUntil('"'); // Skip mode and format + String res = stream.readStringUntil('"'); + waitResponse(); + return res; + } + + /* + * Generic network functions + */ + + int getSignalQuality() { + sendAT(GF("+CSQ")); + if (waitResponse(GF(GSM_NL "+CSQ:")) != 1) { + return 99; + } + int res = stream.readStringUntil(',').toInt(); + waitResponse(); + return res; + } + + bool isNetworkConnected() { + RegStatus s = getRegistrationStatus(); + if (s == REG_OK_HOME || s == REG_OK_ROAMING) { + DBG(F("connected with status:"), s); + return true; + } else { + return false; + } + } + + bool waitForNetwork(unsigned long timeout = 60000L) { + for (unsigned long start = millis(); millis() - start < timeout; ) { + if (isNetworkConnected()) { + return true; + } + delay(250); + } + return false; + } + + /* + * GPRS functions + */ + bool gprsConnect(const char* apn, const char* user = NULL, const char* pwd = NULL) { + gprsDisconnect(); + + // Define the PDP context + sendAT(GF("+CGDCONT=3,\"IPV4V6\",\""), apn, '"'); + waitResponse(); + + if (user && strlen(user) > 0) { + sendAT(GF("+CGAUTH=3,1,\""), user, GF("\",\""), pwd, GF("\"")); + waitResponse(); + } + + // Activate the PDP context + sendAT(GF("+CGACT=1,3")); + waitResponse(60000L); + + // Attach to GPRS + sendAT(GF("+CGATT=1")); + if (waitResponse(60000L) != 1) + return false; + + return true; + } + + bool gprsDisconnect() { + sendAT(GF("+CGATT=0")); + if (waitResponse(60000L) != 1) + return false; + + return true; + } + + + bool isGprsConnected() { + sendAT(GF("+CGATT?")); + if (waitResponse(GF(GSM_NL "+CGATT:")) != 1) { + return false; + } + int res = stream.readStringUntil('\n').toInt(); + waitResponse(); + if (res != 1) + return false; + + return true; + } + + String getLocalIP() { + sendAT(GF("+CGPADDR=3")); + + if (waitResponse(10000L, GF("+CGPADDR: 3,\"")) != 1) { + return ""; + } + String res = stream.readStringUntil('\"'); + waitResponse(); + return res; + } + + IPAddress localIP() { + return TinyGsmIpFromString(getLocalIP()); + } + + /* + * Phone Call functions + */ + + bool setGsmBusy(bool busy = true) TINY_GSM_ATTR_NOT_AVAILABLE; + + bool callAnswer() TINY_GSM_ATTR_NOT_IMPLEMENTED; + + bool callNumber(const String& number) TINY_GSM_ATTR_NOT_IMPLEMENTED; + + bool callHangup() TINY_GSM_ATTR_NOT_IMPLEMENTED; + + String sendUSSD(const String& code) TINY_GSM_ATTR_NOT_IMPLEMENTED; + + bool sendSMS(const String& number, const String& text) { + sendAT(GF("+CMGF=1")); + waitResponse(); + //Set GSM 7 bit default alphabet (3GPP TS 23.038) + sendAT(GF("+CSCS=\"GSM\"")); + waitResponse(); + + sendAT(GF("+CMGS=\""), number, GF("\"")); + if (waitResponse(GF(">")) != 1) { + return false; + } + stream.print(text); + stream.write((char)0x1A); + stream.flush(); + return waitResponse(60000L) == 1; + } + + bool sendSMS_UTF16(const String& number, const void* text, size_t len) TINY_GSM_ATTR_NOT_IMPLEMENTED; + + /* + * Location functions + */ + String getGsmLocation() TINY_GSM_ATTR_NOT_AVAILABLE; + + /* + * Battery functions + */ + uint16_t getBattVoltage() TINY_GSM_ATTR_NOT_AVAILABLE; + + int getBattPercent() TINY_GSM_ATTR_NOT_AVAILABLE; + +protected: + + bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool ssl = false) { + int rsp; + + if (ssl) { + // enable SSl and use security profile 1 + sendAT(GF("+SQNSSCFG="), mux, GF(",1,1")); + if (waitResponse() != 1) { + DBG("failed to configure secure socket"); + return false; + } + } + + sendAT(GF("+SQNSCFG="), mux, GF(",3,300,90,600,50")); + waitResponse(); + + sendAT(GF("+SQNSCFGEXT="), mux, GF(",1,0,0,0,0")); + waitResponse(); + + sendAT(GF("+SQNSD="), mux, ",0,", port, ',', GF("\""), host, GF("\""), ",0,0,1"); + rsp = waitResponse(75000L, + GF("OK" GSM_NL), + GF("NO CARRIER" GSM_NL) + ); + + // creation of socket failed immediately. + if (rsp != 1) return rsp; + + // wait until we get a good status + unsigned long timeout = 5000; + unsigned long startMillis = millis(); + bool connected = false; + while (!connected) { + connected = modemGetConnected(mux); + if (connected) { + delay(50); + break; + } + delay(100); // socket may be in opening state + if (millis() - startMillis < timeout) { + break; + } + } + return connected; + } + + + int modemSend(const void* buff, size_t len, uint8_t mux) { + sendAT(GF("+SQNSSENDEXT="), mux, ',', len); + if (waitResponse(5000, GF(GSM_NL "> ")) != 1) { + return 0; + } + stream.write((uint8_t*)buff, len); + stream.flush(); + if (waitResponse() != 1) { + DBG("no OK after send"); + return 0; + } + return len; + } + + + size_t modemRead(size_t size, uint8_t mux) { + sendAT(GF("+SQNSRECV="), mux, ',', size); + if (waitResponse(GF("+SQNSRECV: ")) != 1) { + return 0; + } + streamSkipUntil(','); // Skip mux + size_t len = stream.readStringUntil('\n').toInt(); + for (size_t i=0; irx.put(c); + } + waitResponse(); + sockets[mux]->sock_available = modemGetAvailable(mux); + return len; + } + + size_t modemGetAvailable(uint8_t mux) { + sendAT(GF("+SQNSI="), mux); + size_t result = 0; + if (waitResponse(GF("+SQNSI:")) == 1) { + streamSkipUntil(','); // Skip mux + streamSkipUntil(','); // Skip sent + streamSkipUntil(','); // Skip received + result = stream.readStringUntil(',').toInt(); + waitResponse(); + } + if (!result) { + sockets[mux]->sock_connected = modemGetConnected(mux); + } + return result; + } + + bool modemGetConnected(uint8_t mux) { + sendAT(GF("+SQNSS")); + uint8_t m = 0; + uint8_t status = 0; + + while (true) { + if (waitResponse(GFP(GSM_OK), GF(GSM_NL "+SQNSS: ")) != 2) { + break; + }; + m = stream.readStringUntil(',').toInt(); + if (m == mux) { + status = stream.readStringUntil(',').toInt(); + } + streamSkipUntil('\n'); // Skip + } + + return ((status != SOCK_CLOSED) && (status != SOCK_INCOMING) && (status != SOCK_OPENING)); + } + +public: + + /* Utilities */ + + bool commandMode(int retries = 2) { + streamWrite(GF("+++")); // enter command mode + return true; + } + + template + void streamWrite(T last) { + stream.print(last); + } + + template + void streamWrite(T head, Args... tail) { + stream.print(head); + streamWrite(tail...); + } + + bool streamSkipUntil(char c) { //TODO: timeout + while (true) { + while (!stream.available()) { TINY_GSM_YIELD(); } + if (stream.read() == c) + return true; + } + return false; + } + + template + void sendAT(Args... cmd) { + streamWrite("AT", cmd..., '\r'); + stream.flush(); + TINY_GSM_YIELD(); + DBG("### AT:", cmd...); + } + + // TODO: Optimize this! + uint8_t waitResponse(uint32_t timeout, String& data, + GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), + GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL) + { + /*String r1s(r1); r1s.trim(); + String r2s(r2); r2s.trim(); + String r3s(r3); r3s.trim(); + String r4s(r4); r4s.trim(); + String r5s(r5); r5s.trim(); + DBG("### ..:", r1s, ",", r2s, ",", r3s, ",", r4s, ",", r5s);*/ + data.reserve(64); + int index = 0; + unsigned long startMillis = millis(); + do { + TINY_GSM_YIELD(); + while (stream.available() > 0) { + int a = stream.read(); + if (a <= 0) continue; // Skip 0x00 bytes, just in case + data += (char)a; + if (r1 && data.endsWith(r1)) { + index = 1; + goto finish; + } else if (r2 && data.endsWith(r2)) { + index = 2; + goto finish; + } else if (r3 && data.endsWith(r3)) { + index = 3; + goto finish; + } else if (r4 && data.endsWith(r4)) { + index = 4; + goto finish; + } else if (r5 && data.endsWith(r5)) { + index = 5; + goto finish; + } else if (data.endsWith(GF(GSM_NL "+SQNSRING:"))) { + int mux = stream.readStringUntil(',').toInt(); + if (mux >= 0 && mux < TINY_GSM_MUX_COUNT && sockets[mux]) { + sockets[mux]->got_data = true; + } + stream.readStringUntil('\n'); + data = ""; + } else if (data.endsWith(GF("SQNSH: "))) { + int mux = stream.readStringUntil('\n').toInt(); + if (mux >= 0 && mux < TINY_GSM_MUX_COUNT && sockets[mux]) { + sockets[mux]->sock_connected = false; + } + data = ""; + DBG("### Closed: ", mux); + } + } + } while (millis() - startMillis < timeout); +finish: + if (!index) { + data.trim(); + if (data.length()) { + DBG("### Unhandled:", data); + } + data = ""; + } + return index; + } + + uint8_t waitResponse(uint32_t timeout, + GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), + GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL) + { + String data; + return waitResponse(timeout, data, r1, r2, r3, r4, r5); + } + + uint8_t waitResponse(GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), + GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL) + { + return waitResponse(1000, r1, r2, r3, r4, r5); + } + +public: + Stream& stream; + +protected: + GsmClient* sockets[TINY_GSM_MUX_COUNT]; +}; + +#endif diff --git a/src/TinyGsmClientUBLOX.h b/src/TinyGsmClientUBLOX.h index 9fefc3d..c54c60c 100644 --- a/src/TinyGsmClientUBLOX.h +++ b/src/TinyGsmClientUBLOX.h @@ -62,10 +62,8 @@ public: sock_connected = false; got_data = false; - // at->sockets[mux] = this; - // ^^ TODO: attach the socket here at init? Or later at connect? - // Currently done inconsistently between modems - + // Don't attach the socket here because we won't know the mux channel number + // until the u-blox assigns it upon opening the socket return true; } @@ -93,8 +91,8 @@ public: // sock_connected = at->modemConnect(host, port, mux); sock_connected = at->modemConnect(host, port, &mux); at->sockets[mux] = this; - // ^^ TODO: attach the socket after attempting connection or above at init? - // Currently done inconsistently between modems + // Attach the socket after attempting connection because u-blox will assign + // whatever mux number is next regardless of the number requested. at->maintain(); return sock_connected; } diff --git a/src/TinyGsmCommon.h b/src/TinyGsmCommon.h index 7d0db43..68bf900 100644 --- a/src/TinyGsmCommon.h +++ b/src/TinyGsmCommon.h @@ -35,7 +35,7 @@ #endif #if !defined(TINY_GSM_RX_BUFFER) - #define TINY_GSM_RX_BUFFER 256 + #define TINY_GSM_RX_BUFFER 64 #endif #define TINY_GSM_ATTR_NOT_AVAILABLE __attribute__((error("Not available on this modem type"))) @@ -203,8 +203,6 @@ String TinyGsmDecodeHex16bit(String &instr) { } - - class TinyGsmModem {