From 0dc4d90d499d2a712a3a59e9f5bc3a3778b4b2c0 Mon Sep 17 00:00:00 2001 From: Volodymyr Shymanskyy Date: Wed, 1 Feb 2017 23:58:56 +0200 Subject: [PATCH] Initial A6 support. #7 --- TinyGsmClient.h | 2 + TinyGsmClientA6.h | 595 +++++++++++++++++++++++++ examples/BlynkClient/BlynkClient.ino | 1 + examples/FileDownload/FileDownload.ino | 1 + examples/MqttClient/MqttClient.ino | 1 + examples/WebClient/WebClient.ino | 1 + 6 files changed, 601 insertions(+) create mode 100644 TinyGsmClientA6.h diff --git a/TinyGsmClient.h b/TinyGsmClient.h index 7c704d6..a0998f6 100644 --- a/TinyGsmClient.h +++ b/TinyGsmClient.h @@ -11,6 +11,8 @@ #if defined(TINY_GSM_MODEM_SIM800) || defined(TINY_GSM_MODEM_SIM900) #include +#elif defined(TINY_GSM_MODEM_A6) || defined(TINY_GSM_MODEM_A7) + #include #elif defined(TINY_GSM_MODEM_M590) #include #elif defined(TINY_GSM_MODEM_ESP8266) diff --git a/TinyGsmClientA6.h b/TinyGsmClientA6.h new file mode 100644 index 0000000..390c041 --- /dev/null +++ b/TinyGsmClientA6.h @@ -0,0 +1,595 @@ +/** + * @file TinyGsmClientA6.h + * @author Volodymyr Shymanskyy + * @license LGPL-3.0 + * @copyright Copyright (c) 2016 Volodymyr Shymanskyy + * @date Nov 2016 + */ + +#ifndef TinyGsmClientA6_h +#define TinyGsmClientA6_h + +//#define TINY_GSM_DEBUG Serial + +#if !defined(TINY_GSM_RX_BUFFER) + #define TINY_GSM_RX_BUFFER 256 +#endif + +#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 = 3, + REG_DENIED = 2, + REG_OK_HOME = 1, + REG_OK_ROAMING = 5, + REG_UNKNOWN = 4, +}; + + +class TinyGsm +{ + +public: + TinyGsm(Stream& stream) + : stream(stream) + {} + +public: + +class GsmClient : public Client +{ + friend class TinyGsm; + typedef TinyGsmFifo RxFifo; + +public: + GsmClient() {} + + GsmClient(TinyGsm& modem) { + init(&modem); + } + + bool init(TinyGsm* modem) { + at = modem; + mux = -1; + sock_connected = false; + + return true; + } + +public: + virtual int connect(const char *host, uint16_t port) { + TINY_GSM_YIELD(); + rx.clear(); + uint8_t newMux = -1; + sock_connected = at->modemConnect(host, port, &newMux); + if (sock_connected) { + mux = newMux; + at->sockets[mux] = this; + } + 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("+CIPCLOSE="), mux); + sock_connected = false; + at->waitResponse(); + } + + 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()) { + at->maintain(); + } + return rx.size(); + } + + virtual int read(uint8_t *buf, size_t size) { + TINY_GSM_YIELD(); + 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? + if (!rx.size()) { + at->maintain(); + //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 sock_connected; + } + virtual operator bool() { return connected(); } +private: + TinyGsm* at; + uint8_t mux; + bool sock_connected; + RxFifo rx; +}; + +public: + + /* + * Basic functions + */ + bool begin() { + return init(); + } + + bool init() { + if (!autoBaud()) { + return false; + } + sendAT(GF("&FZE0")); // Factory + Reset + Echo Off + if (waitResponse() != 1) { + return false; + } + sendAT(GF("+CMEE=0")); + waitResponse(); + + getSimStatus(); + return true; + } + + bool autoBaud(unsigned long timeout = 10000L) { + for (unsigned long start = millis(); millis() - start < timeout; ) { + sendAT(GF("E0")); + if (waitResponse(200) == 1) { + delay(100); + return true; + } + delay(100); + } + return false; + } + + void maintain() { + //while (stream.available()) { + waitResponse(10, NULL, NULL); + //} + } + + bool factoryDefault() { + sendAT(GF("&FZE0&W")); // Factory + Reset + Echo Off + Write + waitResponse(); + sendAT(GF("&W")); // Write configuration + return waitResponse() == 1; + } + + /* + * Power functions + */ + + bool restart() { + if (!autoBaud()) { + return false; + } + sendAT(GF("+RST=1")); + delay(3000); + return init(); + } + + /* + * SIM card & Networ Operator functions + */ + + bool simUnlock(const char *pin) { + sendAT(GF("+CPIN=\""), pin, GF("\"")); + return waitResponse() == 1; + } + + String getSimCCID() { + sendAT(GF("+CCID")); + if (waitResponse(GF(GSM_NL "+ICCID:")) != 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; + } + + int getSignalQuality() { + sendAT(GF("+CSQ")); + if (waitResponse(GF(GSM_NL "+CSQ:")) != 1) { + return 99; + } + int res = stream.readStringUntil(',').toInt(); + waitResponse(); + return res; + } + + bool callAnswer() { + sendAT(GF("A")); + return waitResponse() == 1; + } + + bool callNumber(const String& number) { + sendAT(GF("D"), number); + return waitResponse() == 1; + } + + bool callHangup(const String& number) { + sendAT(GF("H"), number); + return waitResponse() == 1; + } + + bool sendSMS(const String& number, const String& text) { + sendAT(GF("+CMGF=1")); + waitResponse(); + sendAT(GF("+CMGS=\""), number, GF("\"")); + if (waitResponse(GF(">")) != 1) { + return false; + } + stream.print(text); + stream.write((char)0x1A); + return waitResponse(60000L) == 1; + } + + 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")); + 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?")); + if (waitResponse(GF(GSM_NL "+CREG:")) != 1) { + return REG_UNKNOWN; + } + streamSkipUntil(','); // Skip format (0) + int status = stream.readStringUntil('\n').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; + } + + bool waitForNetwork(unsigned long timeout = 60000L) { + for (unsigned long start = millis(); millis() - start < timeout; ) { + RegStatus s = getRegistrationStatus(); + if (s == REG_OK_HOME || s == REG_OK_ROAMING) { + return true; + } else if (s == REG_UNREGISTERED) { + return false; + } + delay(1000); + } + return false; + } + + /* + * GPRS functions + */ + bool gprsConnect(const char* apn, const char* user, const char* pwd) { + gprsDisconnect(); + + sendAT(GF("+CGDCONT=1,\"IP\",\""), apn, '"'); + waitResponse(); + + sendAT(GF("+CSTT=\""), apn, GF("\",\""), user, GF("\",\""), pwd, GF("\"")); + if (waitResponse(60000L) != 1) { + return false; + } + + /*sendAT(GF("+CIICR")); + if (waitResponse(60000L) != 1) { + return false; + }*/ + + sendAT(GF("+CGACT=1,1")); + waitResponse(60000L); + + sendAT(GF("+CGATT=1")); + if (waitResponse(60000L) != 1) + return false; + + // TODO: wait AT+CGATT? + + sendAT(GF("+CIPMUX=1")); + if (waitResponse() != 1) { + return false; + } + + /*sendAT(GF("+CIFSR")); + String data; + if (waitResponse(10000L, data) != 1) { + data.replace(GSM_NL, ""); + return false; + }*/ + + return true; + } + + bool gprsDisconnect() { + sendAT(GF("+CIPSHUT")); + return waitResponse(60000L) == 1; + } + + /* + * Phone Call functions + */ + + /* + * Messaging functions + */ + + void sendUSSD() { + } + + void sendSMS() { + } + + /* + * Location functions + */ + void getLocation() { + } + + /* + * Battery functions + */ + +private: + int modemConnect(const char* host, uint16_t port, uint8_t* mux) { + sendAT(GF("+CIPSTART="), GF("\"TCP"), GF("\",\""), host, GF("\","), port); + + if (waitResponse(75000L, GF(GSM_NL "+CIPNUM:")) != 1) { + return -1; + } + int newMux = stream.readStringUntil('\n').toInt(); + + int rsp = waitResponse(75000L, + GF("CONNECT OK" GSM_NL), + GF("CONNECT FAIL" GSM_NL), + GF("ALREADY CONNECT" GSM_NL)); + if (waitResponse() != 1) { + return -1; + } + *mux = newMux; + + return (1 == rsp); + } + + int modemSend2(const void* buff, size_t len, uint8_t mux) { + streamWrite(GF("AT+CIPSEND="), mux, ",", len, ","); + stream.write((uint8_t*)buff, len); + stream.print(GSM_NL); + stream.flush(); + + if (waitResponse(10000L, GF(GSM_NL "OK"), GF(GSM_NL "FAIL")) != 1) { + return -1; + } + return len; + } + + int modemSend(const void* buff, size_t len, uint8_t mux) { + sendAT(GF("+CIPSEND="), mux, ",", len); + if (waitResponse(10000L, GF(GSM_NL ">")) != 1) { + return -1; + } + stream.write((uint8_t*)buff, len); + stream.flush(); + if (waitResponse(10000L, GFP(GSM_OK), GF(GSM_NL "FAIL")) != 1) { + return -1; + } + return len; + } + + + bool modemGetConnected(uint8_t mux) { + sendAT(GF("+CIPSTATUS")); + int res = waitResponse(GF(",\"CONNECTED\""), GF(",\"CLOSED\""), GF(",\"CLOSING\""), GF(",\"INITIAL\"")); + waitResponse(); + return 1 == res; + } + + /* Utilities */ + template + void streamWrite(T last) { + stream.print(last); + } + + template + void streamWrite(T head, Args... tail) { + stream.print(head); + streamWrite(tail...); + } + + int streamRead() { return stream.read(); } + + bool streamSkipUntil(char c) { //TODO: timeout + while (true) { + while (!stream.available()) {} + if (stream.read() == c) + return true; + } + return false; + } + + template + void sendAT(Args... cmd) { + streamWrite("AT", cmd..., GSM_NL); + 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 = streamRead(); + 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("+CIPRCV:"))) { + int mux = stream.readStringUntil(',').toInt(); + int len = stream.readStringUntil(',').toInt(); + if (len > sockets[mux]->rx.free()) { + DBG("### Buffer overflow: ", len, "->", sockets[mux]->rx.free()); + } else { + DBG("### Got: ", len, "->", sockets[mux]->rx.free()); + } + while (len--) { + while (!stream.available()) {} + sockets[mux]->rx.put(stream.read()); + } + data = ""; + return index; + } else if (data.endsWith(GF("+TCPCLOSED:"))) { + int mux = stream.readStringUntil(',').toInt(); + stream.readStringUntil('\n'); + sockets[mux]->sock_connected = false; + data = ""; + } + } + } 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); + } + +private: + Stream& stream; + GsmClient* sockets[2]; +}; + +typedef TinyGsm::GsmClient TinyGsmClient; + +#endif diff --git a/examples/BlynkClient/BlynkClient.ino b/examples/BlynkClient/BlynkClient.ino index 9efa713..9de5419 100644 --- a/examples/BlynkClient/BlynkClient.ino +++ b/examples/BlynkClient/BlynkClient.ino @@ -31,6 +31,7 @@ // Select your modem: #define TINY_GSM_MODEM_SIM800 //#define TINY_GSM_MODEM_SIM900 +//#define TINY_GSM_MODEM_A6 //#define TINY_GSM_MODEM_M590 #include diff --git a/examples/FileDownload/FileDownload.ino b/examples/FileDownload/FileDownload.ino index 4b88be2..781047a 100644 --- a/examples/FileDownload/FileDownload.ino +++ b/examples/FileDownload/FileDownload.ino @@ -15,6 +15,7 @@ // Select your modem: #define TINY_GSM_MODEM_SIM800 //#define TINY_GSM_MODEM_SIM900 +//#define TINY_GSM_MODEM_A6 //#define TINY_GSM_MODEM_M590 // Increase RX buffer diff --git a/examples/MqttClient/MqttClient.ino b/examples/MqttClient/MqttClient.ino index 51a8f16..bd0d507 100644 --- a/examples/MqttClient/MqttClient.ino +++ b/examples/MqttClient/MqttClient.ino @@ -28,6 +28,7 @@ // Select your modem: #define TINY_GSM_MODEM_SIM800 //#define TINY_GSM_MODEM_SIM900 +//#define TINY_GSM_MODEM_A6 //#define TINY_GSM_MODEM_M590 #include diff --git a/examples/WebClient/WebClient.ino b/examples/WebClient/WebClient.ino index 09c2cec..0c78f55 100644 --- a/examples/WebClient/WebClient.ino +++ b/examples/WebClient/WebClient.ino @@ -11,6 +11,7 @@ // Select your modem: #define TINY_GSM_MODEM_SIM800 //#define TINY_GSM_MODEM_SIM900 +//#define TINY_GSM_MODEM_A6 //#define TINY_GSM_MODEM_M590 #include