You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

987 lines
24 KiB

8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
6 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
8 years ago
7 years ago
7 years ago
8 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
8 years ago
8 years ago
8 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
7 years ago
8 years ago
8 years ago
7 years ago
8 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
7 years ago
  1. /**
  2. * @file TinyGsmClientSIM800.h
  3. * @author Volodymyr Shymanskyy
  4. * @license LGPL-3.0
  5. * @copyright Copyright (c) 2016 Volodymyr Shymanskyy
  6. * @date Nov 2016
  7. */
  8. #ifndef TinyGsmClientSIM800_h
  9. #define TinyGsmClientSIM800_h
  10. //#pragma message("TinyGSM: TinyGsmClientSIM800")
  11. //#define TINY_GSM_DEBUG Serial
  12. //#define TINY_GSM_USE_HEX
  13. #if !defined(TINY_GSM_RX_BUFFER)
  14. #define TINY_GSM_RX_BUFFER 64
  15. #endif
  16. #define TINY_GSM_MUX_COUNT 5
  17. #include <TinyGsmCommon.h>
  18. #define GSM_NL "\r\n"
  19. static const char GSM_OK[] TINY_GSM_PROGMEM = "OK" GSM_NL;
  20. static const char GSM_ERROR[] TINY_GSM_PROGMEM = "ERROR" GSM_NL;
  21. enum SimStatus {
  22. SIM_ERROR = 0,
  23. SIM_READY = 1,
  24. SIM_LOCKED = 2,
  25. };
  26. enum RegStatus {
  27. REG_UNREGISTERED = 0,
  28. REG_SEARCHING = 2,
  29. REG_DENIED = 3,
  30. REG_OK_HOME = 1,
  31. REG_OK_ROAMING = 5,
  32. REG_UNKNOWN = 4,
  33. };
  34. enum TinyGSMDateTimeFormat {
  35. DATE_FULL = 0,
  36. DATE_TIME = 1,
  37. DATE_DATE = 2
  38. };
  39. class TinyGsmSim800
  40. {
  41. public:
  42. class GsmClient : public Client
  43. {
  44. friend class TinyGsmSim800;
  45. typedef TinyGsmFifo<uint8_t, TINY_GSM_RX_BUFFER> RxFifo;
  46. public:
  47. GsmClient() {}
  48. GsmClient(TinyGsmSim800& modem, uint8_t mux = 1) {
  49. init(&modem, mux);
  50. }
  51. bool init(TinyGsmSim800* modem, uint8_t mux = 1) {
  52. this->at = modem;
  53. this->mux = mux;
  54. sock_available = 0;
  55. prev_check = 0;
  56. sock_connected = false;
  57. got_data = false;
  58. at->sockets[mux] = this;
  59. return true;
  60. }
  61. public:
  62. virtual int connect(const char *host, uint16_t port, int timeout_s) {
  63. stop();
  64. TINY_GSM_YIELD();
  65. rx.clear();
  66. sock_connected = at->modemConnect(host, port, mux, false, timeout_s);
  67. return sock_connected;
  68. }
  69. TINY_GSM_CLIENT_CONNECT_OVERLOADS()
  70. virtual void stop(uint32_t maxWaitMs) {
  71. TINY_GSM_CLIENT_DUMP_MODEM_BUFFER()
  72. at->sendAT(GF("+CIPCLOSE="), mux, GF(",1")); // Quick close
  73. sock_connected = false;
  74. at->waitResponse();
  75. }
  76. virtual void stop() { stop(15000L); }
  77. TINY_GSM_CLIENT_WRITE()
  78. TINY_GSM_CLIENT_AVAILABLE_WITH_BUFFER_CHECK()
  79. TINY_GSM_CLIENT_READ_WITH_BUFFER_CHECK()
  80. TINY_GSM_CLIENT_PEEK_FLUSH_CONNECTED()
  81. /*
  82. * Extended API
  83. */
  84. String remoteIP() TINY_GSM_ATTR_NOT_IMPLEMENTED;
  85. private:
  86. TinyGsmSim800* at;
  87. uint8_t mux;
  88. uint16_t sock_available;
  89. uint32_t prev_check;
  90. bool sock_connected;
  91. bool got_data;
  92. RxFifo rx;
  93. };
  94. class GsmClientSecure : public GsmClient
  95. {
  96. public:
  97. GsmClientSecure() {}
  98. GsmClientSecure(TinyGsmSim800& modem, uint8_t mux = 1)
  99. : GsmClient(modem, mux)
  100. {}
  101. public:
  102. virtual int connect(const char *host, uint16_t port, int timeout_s) {
  103. stop();
  104. TINY_GSM_YIELD();
  105. rx.clear();
  106. sock_connected = at->modemConnect(host, port, mux, true, timeout_s);
  107. return sock_connected;
  108. }
  109. };
  110. public:
  111. TinyGsmSim800(Stream& stream)
  112. : stream(stream)
  113. {
  114. memset(sockets, 0, sizeof(sockets));
  115. }
  116. /*
  117. * Basic functions
  118. */
  119. bool begin(const char* pin = NULL) {
  120. return init(pin);
  121. }
  122. bool init(const char* pin = NULL) {
  123. DBG(GF("### TinyGSM Version:"), TINYGSM_VERSION);
  124. if (!testAT()) {
  125. return false;
  126. }
  127. sendAT(GF("&FZ")); // Factory + Reset
  128. waitResponse();
  129. sendAT(GF("E0")); // Echo Off
  130. if (waitResponse() != 1) {
  131. return false;
  132. }
  133. DBG(GF("### Modem:"), getModemName());
  134. getSimStatus();
  135. return true;
  136. }
  137. String getModemName() {
  138. String name = "";
  139. #if defined(TINY_GSM_MODEM_SIM800)
  140. name = "SIMCom SIM800";
  141. #elif defined(TINY_GSM_MODEM_SIM808)
  142. name = "SIMCom SIM808";
  143. #elif defined(TINY_GSM_MODEM_SIM868)
  144. name = "SIMCom SIM868";
  145. #elif defined(TINY_GSM_MODEM_SIM900)
  146. name = "SIMCom SIM900";
  147. #endif
  148. sendAT(GF("+GMM"));
  149. String res2;
  150. if (waitResponse(1000L, res2) != 1) {
  151. return name;
  152. }
  153. res2.replace(GSM_NL "OK" GSM_NL, "");
  154. res2.replace("_", " ");
  155. res2.trim();
  156. name = res2;
  157. DBG("### Modem:", name);
  158. return name;
  159. }
  160. TINY_GSM_MODEM_SET_BAUD_IPR()
  161. TINY_GSM_MODEM_TEST_AT()
  162. TINY_GSM_MODEM_MAINTAIN_CHECK_SOCKS()
  163. bool factoryDefault() {
  164. sendAT(GF("&FZE0&W")); // Factory + Reset + Echo Off + Write
  165. waitResponse();
  166. sendAT(GF("+IPR=0")); // Auto-baud
  167. waitResponse();
  168. sendAT(GF("+IFC=0,0")); // No Flow Control
  169. waitResponse();
  170. sendAT(GF("+ICF=3,3")); // 8 data 0 parity 1 stop
  171. waitResponse();
  172. sendAT(GF("+CSCLK=0")); // Disable Slow Clock
  173. waitResponse();
  174. sendAT(GF("&W")); // Write configuration
  175. return waitResponse() == 1;
  176. }
  177. TINY_GSM_MODEM_GET_INFO_ATI()
  178. bool hasSSL() {
  179. #if defined(TINY_GSM_MODEM_SIM900)
  180. return false;
  181. #else
  182. sendAT(GF("+CIPSSL=?"));
  183. if (waitResponse(GF(GSM_NL "+CIPSSL:")) != 1) {
  184. return false;
  185. }
  186. return waitResponse() == 1;
  187. #endif
  188. }
  189. bool hasWifi() {
  190. return false;
  191. }
  192. bool hasGPRS() {
  193. return true;
  194. }
  195. /*
  196. * Power functions
  197. */
  198. bool restart() {
  199. if (!testAT()) {
  200. return false;
  201. }
  202. //Enable Local Time Stamp for getting network time
  203. // TODO: Find a better place for this
  204. sendAT(GF("+CLTS=1"));
  205. if (waitResponse(10000L) != 1) {
  206. return false;
  207. }
  208. sendAT(GF("&W"));
  209. waitResponse();
  210. sendAT(GF("+CFUN=0"));
  211. if (waitResponse(10000L) != 1) {
  212. return false;
  213. }
  214. sendAT(GF("+CFUN=1,1"));
  215. if (waitResponse(10000L) != 1) {
  216. return false;
  217. }
  218. delay(3000);
  219. return init();
  220. }
  221. bool poweroff() {
  222. sendAT(GF("+CPOWD=1"));
  223. return waitResponse(10000L, GF("NORMAL POWER DOWN")) == 1;
  224. }
  225. bool radioOff() {
  226. sendAT(GF("+CFUN=0"));
  227. if (waitResponse(10000L) != 1) {
  228. return false;
  229. }
  230. delay(3000);
  231. return true;
  232. }
  233. /*
  234. During sleep, the SIM800 module has its serial communication disabled. In order to reestablish communication
  235. pull the DRT-pin of the SIM800 module LOW for at least 50ms. Then use this function to disable sleep mode.
  236. The DTR-pin can then be released again.
  237. */
  238. bool sleepEnable(bool enable = true) {
  239. sendAT(GF("+CSCLK="), enable);
  240. return waitResponse() == 1;
  241. }
  242. /*
  243. * SIM card functions
  244. */
  245. TINY_GSM_MODEM_SIM_UNLOCK_CPIN()
  246. TINY_GSM_MODEM_GET_SIMCCID_CCID()
  247. TINY_GSM_MODEM_GET_IMEI_GSN()
  248. SimStatus getSimStatus(unsigned long timeout_ms = 10000L) {
  249. for (unsigned long start = millis(); millis() - start < timeout_ms; ) {
  250. sendAT(GF("+CPIN?"));
  251. if (waitResponse(GF(GSM_NL "+CPIN:")) != 1) {
  252. delay(1000);
  253. continue;
  254. }
  255. int status = waitResponse(GF("READY"), GF("SIM PIN"), GF("SIM PUK"), GF("NOT INSERTED"), GF("NOT READY"));
  256. waitResponse();
  257. switch (status) {
  258. case 2:
  259. case 3: return SIM_LOCKED;
  260. case 1: return SIM_READY;
  261. default: return SIM_ERROR;
  262. }
  263. }
  264. return SIM_ERROR;
  265. }
  266. TINY_GSM_MODEM_GET_REGISTRATION_XREG(CREG)
  267. TINY_GSM_MODEM_GET_OPERATOR_COPS()
  268. /*
  269. * Generic network functions
  270. */
  271. TINY_GSM_MODEM_GET_CSQ()
  272. bool isNetworkConnected() {
  273. RegStatus s = getRegistrationStatus();
  274. return (s == REG_OK_HOME || s == REG_OK_ROAMING);
  275. }
  276. TINY_GSM_MODEM_WAIT_FOR_NETWORK()
  277. /*
  278. * GPRS functions
  279. */
  280. bool gprsConnect(const char* apn, const char* user = NULL, const char* pwd = NULL) {
  281. gprsDisconnect();
  282. // Set the Bearer for the IP
  283. sendAT(GF("+SAPBR=3,1,\"Contype\",\"GPRS\"")); // Set the connection type to GPRS
  284. waitResponse();
  285. sendAT(GF("+SAPBR=3,1,\"APN\",\""), apn, '"'); // Set the APN
  286. waitResponse();
  287. if (user && strlen(user) > 0) {
  288. sendAT(GF("+SAPBR=3,1,\"USER\",\""), user, '"'); // Set the user name
  289. waitResponse();
  290. }
  291. if (pwd && strlen(pwd) > 0) {
  292. sendAT(GF("+SAPBR=3,1,\"PWD\",\""), pwd, '"'); // Set the password
  293. waitResponse();
  294. }
  295. // Define the PDP context
  296. sendAT(GF("+CGDCONT=1,\"IP\",\""), apn, '"');
  297. waitResponse();
  298. // Activate the PDP context
  299. sendAT(GF("+CGACT=1,1"));
  300. waitResponse(60000L);
  301. // Open the definied GPRS bearer context
  302. sendAT(GF("+SAPBR=1,1"));
  303. waitResponse(85000L);
  304. // Query the GPRS bearer context status
  305. sendAT(GF("+SAPBR=2,1"));
  306. if (waitResponse(30000L) != 1)
  307. return false;
  308. // Attach to GPRS
  309. sendAT(GF("+CGATT=1"));
  310. if (waitResponse(60000L) != 1)
  311. return false;
  312. // TODO: wait AT+CGATT?
  313. // Set to multi-IP
  314. sendAT(GF("+CIPMUX=1"));
  315. if (waitResponse() != 1) {
  316. return false;
  317. }
  318. // Put in "quick send" mode (thus no extra "Send OK")
  319. sendAT(GF("+CIPQSEND=1"));
  320. if (waitResponse() != 1) {
  321. return false;
  322. }
  323. // Set to get data manually
  324. sendAT(GF("+CIPRXGET=1"));
  325. if (waitResponse() != 1) {
  326. return false;
  327. }
  328. // Start Task and Set APN, USER NAME, PASSWORD
  329. sendAT(GF("+CSTT=\""), apn, GF("\",\""), user, GF("\",\""), pwd, GF("\""));
  330. if (waitResponse(60000L) != 1) {
  331. return false;
  332. }
  333. // Bring Up Wireless Connection with GPRS or CSD
  334. sendAT(GF("+CIICR"));
  335. if (waitResponse(60000L) != 1) {
  336. return false;
  337. }
  338. // Get Local IP Address, only assigned after connection
  339. sendAT(GF("+CIFSR;E0"));
  340. if (waitResponse(10000L) != 1) {
  341. return false;
  342. }
  343. // Configure Domain Name Server (DNS)
  344. sendAT(GF("+CDNSCFG=\"8.8.8.8\",\"8.8.4.4\""));
  345. if (waitResponse() != 1) {
  346. return false;
  347. }
  348. return true;
  349. }
  350. bool gprsDisconnect() {
  351. // Shut the TCP/IP connection
  352. // CIPSHUT will close *all* open connections
  353. sendAT(GF("+CIPSHUT"));
  354. if (waitResponse(60000L) != 1)
  355. return false;
  356. sendAT(GF("+CGATT=0")); // Deactivate the bearer context
  357. if (waitResponse(60000L) != 1)
  358. return false;
  359. return true;
  360. }
  361. bool isGprsConnected() {
  362. sendAT(GF("+CGATT?"));
  363. if (waitResponse(GF(GSM_NL "+CGATT:")) != 1) {
  364. return false;
  365. }
  366. int res = stream.readStringUntil('\n').toInt();
  367. waitResponse();
  368. if (res != 1)
  369. return false;
  370. sendAT(GF("+CIFSR;E0")); // Another option is to use AT+CGPADDR=1
  371. if (waitResponse() != 1)
  372. return false;
  373. return true;
  374. }
  375. /*
  376. * IP Address functions
  377. */
  378. String getLocalIP() {
  379. sendAT(GF("+CIFSR;E0"));
  380. String res;
  381. if (waitResponse(10000L, res) != 1) {
  382. return "";
  383. }
  384. res.replace(GSM_NL "OK" GSM_NL, "");
  385. res.replace(GSM_NL, "");
  386. res.trim();
  387. return res;
  388. }
  389. IPAddress localIP() {
  390. return TinyGsmIpFromString(getLocalIP());
  391. }
  392. /*
  393. * Phone Call functions
  394. */
  395. bool setGsmBusy(bool busy = true) {
  396. sendAT(GF("+GSMBUSY="), busy ? 1 : 0);
  397. return waitResponse() == 1;
  398. }
  399. bool callAnswer() {
  400. sendAT(GF("A"));
  401. return waitResponse() == 1;
  402. }
  403. // Returns true on pick-up, false on error/busy
  404. bool callNumber(const String& number) {
  405. if (number == GF("last")) {
  406. sendAT(GF("DL"));
  407. } else {
  408. sendAT(GF("D"), number, ";");
  409. }
  410. int status = waitResponse(60000L,
  411. GFP(GSM_OK),
  412. GF("BUSY" GSM_NL),
  413. GF("NO ANSWER" GSM_NL),
  414. GF("NO CARRIER" GSM_NL));
  415. switch (status) {
  416. case 1: return true;
  417. case 2:
  418. case 3: return false;
  419. default: return false;
  420. }
  421. }
  422. bool callHangup() {
  423. sendAT(GF("H"));
  424. return waitResponse() == 1;
  425. }
  426. // 0-9,*,#,A,B,C,D
  427. bool dtmfSend(char cmd, int duration_ms = 100) {
  428. duration_ms = constrain(duration_ms, 100, 1000);
  429. sendAT(GF("+VTD="), duration_ms / 100); // VTD accepts in 1/10 of a second
  430. waitResponse();
  431. sendAT(GF("+VTS="), cmd);
  432. return waitResponse(10000L) == 1;
  433. }
  434. /*
  435. * Messaging functions
  436. */
  437. String sendUSSD(const String& code) {
  438. sendAT(GF("+CMGF=1"));
  439. waitResponse();
  440. sendAT(GF("+CSCS=\"HEX\""));
  441. waitResponse();
  442. sendAT(GF("+CUSD=1,\""), code, GF("\""));
  443. if (waitResponse() != 1) {
  444. return "";
  445. }
  446. if (waitResponse(10000L, GF(GSM_NL "+CUSD:")) != 1) {
  447. return "";
  448. }
  449. stream.readStringUntil('"');
  450. String hex = stream.readStringUntil('"');
  451. stream.readStringUntil(',');
  452. int dcs = stream.readStringUntil('\n').toInt();
  453. if (dcs == 15) {
  454. return TinyGsmDecodeHex8bit(hex);
  455. } else if (dcs == 72) {
  456. return TinyGsmDecodeHex16bit(hex);
  457. } else {
  458. return hex;
  459. }
  460. }
  461. bool sendSMS(const String& number, const String& text) {
  462. sendAT(GF("+CMGF=1"));
  463. waitResponse();
  464. //Set GSM 7 bit default alphabet (3GPP TS 23.038)
  465. sendAT(GF("+CSCS=\"GSM\""));
  466. waitResponse();
  467. sendAT(GF("+CMGS=\""), number, GF("\""));
  468. if (waitResponse(GF(">")) != 1) {
  469. return false;
  470. }
  471. stream.print(text);
  472. stream.write((char)0x1A);
  473. stream.flush();
  474. return waitResponse(60000L) == 1;
  475. }
  476. bool sendSMS_UTF16(const String& number, const void* text, size_t len) {
  477. sendAT(GF("+CMGF=1"));
  478. waitResponse();
  479. sendAT(GF("+CSCS=\"HEX\""));
  480. waitResponse();
  481. sendAT(GF("+CSMP=17,167,0,8"));
  482. waitResponse();
  483. sendAT(GF("+CMGS=\""), number, GF("\""));
  484. if (waitResponse(GF(">")) != 1) {
  485. return false;
  486. }
  487. uint16_t* t = (uint16_t*)text;
  488. for (size_t i=0; i<len; i++) {
  489. uint8_t c = t[i] >> 8;
  490. if (c < 0x10) { stream.print('0'); }
  491. stream.print(c, HEX);
  492. c = t[i] & 0xFF;
  493. if (c < 0x10) { stream.print('0'); }
  494. stream.print(c, HEX);
  495. }
  496. stream.write((char)0x1A);
  497. stream.flush();
  498. return waitResponse(60000L) == 1;
  499. }
  500. /*
  501. * Location functions
  502. */
  503. String getGsmLocation() {
  504. sendAT(GF("+CIPGSMLOC=1,1"));
  505. if (waitResponse(10000L, GF(GSM_NL "+CIPGSMLOC:")) != 1) {
  506. return "";
  507. }
  508. String res = stream.readStringUntil('\n');
  509. waitResponse();
  510. res.trim();
  511. return res;
  512. }
  513. /*
  514. * Time functions
  515. */
  516. String getGSMDateTime(TinyGSMDateTimeFormat format) {
  517. sendAT(GF("+CCLK?"));
  518. if (waitResponse(2000L, GF(GSM_NL "+CCLK: \"")) != 1) {
  519. return "";
  520. }
  521. String res;
  522. switch(format) {
  523. case DATE_FULL:
  524. res = stream.readStringUntil('"');
  525. break;
  526. case DATE_TIME:
  527. streamSkipUntil(',');
  528. res = stream.readStringUntil('"');
  529. break;
  530. case DATE_DATE:
  531. res = stream.readStringUntil(',');
  532. break;
  533. }
  534. return res;
  535. }
  536. /*
  537. * Battery & temperature functions
  538. */
  539. // Use: float vBatt = modem.getBattVoltage() / 1000.0;
  540. uint16_t getBattVoltage() {
  541. sendAT(GF("+CBC"));
  542. if (waitResponse(GF(GSM_NL "+CBC:")) != 1) {
  543. return 0;
  544. }
  545. streamSkipUntil(','); // Skip battery charge status
  546. streamSkipUntil(','); // Skip battery charge level
  547. // return voltage in mV
  548. uint16_t res = stream.readStringUntil(',').toInt();
  549. // Wait for final OK
  550. waitResponse();
  551. return res;
  552. }
  553. int8_t getBattPercent() {
  554. sendAT(GF("+CBC"));
  555. if (waitResponse(GF(GSM_NL "+CBC:")) != 1) {
  556. return false;
  557. }
  558. streamSkipUntil(','); // Skip battery charge status
  559. // Read battery charge level
  560. int res = stream.readStringUntil(',').toInt();
  561. // Wait for final OK
  562. waitResponse();
  563. return res;
  564. }
  565. uint8_t getBattChargeState() {
  566. sendAT(GF("+CBC?"));
  567. if (waitResponse(GF(GSM_NL "+CBC:")) != 1) {
  568. return false;
  569. }
  570. // Read battery charge status
  571. int res = stream.readStringUntil(',').toInt();
  572. // Wait for final OK
  573. waitResponse();
  574. return res;
  575. }
  576. bool getBattStats(uint8_t &chargeState, int8_t &percent, uint16_t &milliVolts) {
  577. sendAT(GF("+CBC?"));
  578. if (waitResponse(GF(GSM_NL "+CBC:")) != 1) {
  579. return false;
  580. }
  581. chargeState = stream.readStringUntil(',').toInt();
  582. percent = stream.readStringUntil(',').toInt();
  583. milliVolts = stream.readStringUntil('\n').toInt();
  584. // Wait for final OK
  585. waitResponse();
  586. return true;
  587. }
  588. /*
  589. * NTP server functions
  590. */
  591. boolean isValidNumber(String str) {
  592. if(!(str.charAt(0) == '+' || str.charAt(0) == '-' || isDigit(str.charAt(0)))) return false;
  593. for(byte i=1;i < str.length(); i++) {
  594. if(!(isDigit(str.charAt(i)) || str.charAt(i) == '.')) return false;
  595. }
  596. return true;
  597. }
  598. String ShowNTPError(byte error) {
  599. switch (error) {
  600. case 1:
  601. return "Network time synchronization is successful";
  602. case 61:
  603. return "Network error";
  604. case 62:
  605. return "DNS resolution error";
  606. case 63:
  607. return "Connection error";
  608. case 64:
  609. return "Service response error";
  610. case 65:
  611. return "Service response timeout";
  612. default:
  613. return "Unknown error: " + String(error);
  614. }
  615. }
  616. byte NTPServerSync(String server = "pool.ntp.org", byte TimeZone = 3) {
  617. //Serial.println("Sync time with NTP server.");
  618. sendAT(GF("+CNTPCID=1"));
  619. if (waitResponse(10000L) != 1) {
  620. return -1;
  621. }
  622. sendAT(GF("+CNTP="), server, ',', String(TimeZone));
  623. if (waitResponse(10000L) != 1) {
  624. return -1;
  625. }
  626. sendAT(GF("+CNTP"));
  627. if (waitResponse(10000L, GF(GSM_NL "+CNTP:"))) {
  628. String result = stream.readStringUntil('\n');
  629. result.trim();
  630. if (isValidNumber(result))
  631. {
  632. return result.toInt();
  633. }
  634. }
  635. else {
  636. return -1;
  637. }
  638. return -1;
  639. }
  640. float getTemperature() TINY_GSM_ATTR_NOT_AVAILABLE;
  641. /*
  642. * Client related functions
  643. */
  644. protected:
  645. bool modemConnect(const char* host, uint16_t port, uint8_t mux,
  646. bool ssl = false, int timeout_s = 75)
  647. {
  648. int rsp;
  649. uint32_t timeout_ms = ((uint32_t)timeout_s)*1000;
  650. #if !defined(TINY_GSM_MODEM_SIM900)
  651. sendAT(GF("+CIPSSL="), ssl);
  652. rsp = waitResponse();
  653. if (ssl && rsp != 1) {
  654. return false;
  655. }
  656. #endif
  657. sendAT(GF("+CIPSTART="), mux, ',', GF("\"TCP"), GF("\",\""), host, GF("\","), port);
  658. rsp = waitResponse(timeout_ms,
  659. GF("CONNECT OK" GSM_NL),
  660. GF("CONNECT FAIL" GSM_NL),
  661. GF("ALREADY CONNECT" GSM_NL),
  662. GF("ERROR" GSM_NL),
  663. GF("CLOSE OK" GSM_NL) // Happens when HTTPS handshake fails
  664. );
  665. return (1 == rsp);
  666. }
  667. int16_t modemSend(const void* buff, size_t len, uint8_t mux) {
  668. sendAT(GF("+CIPSEND="), mux, ',', len);
  669. if (waitResponse(GF(">")) != 1) {
  670. return 0;
  671. }
  672. stream.write((uint8_t*)buff, len);
  673. stream.flush();
  674. if (waitResponse(GF(GSM_NL "DATA ACCEPT:")) != 1) {
  675. return 0;
  676. }
  677. streamSkipUntil(','); // Skip mux
  678. return stream.readStringUntil('\n').toInt();
  679. }
  680. size_t modemRead(size_t size, uint8_t mux) {
  681. #ifdef TINY_GSM_USE_HEX
  682. sendAT(GF("+CIPRXGET=3,"), mux, ',', size);
  683. if (waitResponse(GF("+CIPRXGET:")) != 1) {
  684. return 0;
  685. }
  686. #else
  687. sendAT(GF("+CIPRXGET=2,"), mux, ',', size);
  688. if (waitResponse(GF("+CIPRXGET:")) != 1) {
  689. return 0;
  690. }
  691. #endif
  692. streamSkipUntil(','); // Skip Rx mode 2/normal or 3/HEX
  693. streamSkipUntil(','); // Skip mux
  694. size_t len_requested = stream.readStringUntil(',').toInt();
  695. // ^^ Requested number of data bytes (1-1460 bytes)to be read
  696. size_t len_confirmed = stream.readStringUntil('\n').toInt();
  697. // ^^ Confirmed number of data bytes to be read, which may be less than requested.
  698. // 0 indicates that no data can be read.
  699. // This is actually be the number of bytes that will be remaining after the read
  700. for (size_t i=0; i<len_requested; i++) {
  701. uint32_t startMillis = millis();
  702. #ifdef TINY_GSM_USE_HEX
  703. while (stream.available() < 2 && (millis() - startMillis < sockets[mux]->_timeout)) { TINY_GSM_YIELD(); }
  704. char buf[4] = { 0, };
  705. buf[0] = stream.read();
  706. buf[1] = stream.read();
  707. char c = strtol(buf, NULL, 16);
  708. #else
  709. while (!stream.available() && (millis() - startMillis < sockets[mux]->_timeout)) { TINY_GSM_YIELD(); }
  710. char c = stream.read();
  711. #endif
  712. sockets[mux]->rx.put(c);
  713. }
  714. DBG("### READ:", len_requested, "from", mux);
  715. // sockets[mux]->sock_available = modemGetAvailable(mux);
  716. sockets[mux]->sock_available = len_confirmed;
  717. waitResponse();
  718. return len_requested;
  719. }
  720. size_t modemGetAvailable(uint8_t mux) {
  721. sendAT(GF("+CIPRXGET=4,"), mux);
  722. size_t result = 0;
  723. if (waitResponse(GF("+CIPRXGET:")) == 1) {
  724. streamSkipUntil(','); // Skip mode 4
  725. streamSkipUntil(','); // Skip mux
  726. result = stream.readStringUntil('\n').toInt();
  727. waitResponse();
  728. }
  729. DBG("### Available:", result, "on", mux);
  730. if (!result) {
  731. sockets[mux]->sock_connected = modemGetConnected(mux);
  732. }
  733. return result;
  734. }
  735. bool modemGetConnected(uint8_t mux) {
  736. sendAT(GF("+CIPSTATUS="), mux);
  737. waitResponse(GF("+CIPSTATUS"));
  738. int res = waitResponse(GF(",\"CONNECTED\""), GF(",\"CLOSED\""), GF(",\"CLOSING\""),
  739. GF(",\"REMOTE CLOSING\""), GF(",\"INITIAL\""));
  740. waitResponse();
  741. return 1 == res;
  742. }
  743. public:
  744. /*
  745. Utilities
  746. */
  747. TINY_GSM_MODEM_STREAM_UTILITIES()
  748. // TODO: Optimize this!
  749. uint8_t waitResponse(uint32_t timeout_ms, String& data,
  750. GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR),
  751. GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
  752. {
  753. /*String r1s(r1); r1s.trim();
  754. String r2s(r2); r2s.trim();
  755. String r3s(r3); r3s.trim();
  756. String r4s(r4); r4s.trim();
  757. String r5s(r5); r5s.trim();
  758. DBG("### ..:", r1s, ",", r2s, ",", r3s, ",", r4s, ",", r5s);*/
  759. data.reserve(64);
  760. int index = 0;
  761. unsigned long startMillis = millis();
  762. do {
  763. TINY_GSM_YIELD();
  764. while (stream.available() > 0) {
  765. int a = stream.read();
  766. if (a <= 0) continue; // Skip 0x00 bytes, just in case
  767. data += (char)a;
  768. if (r1 && data.endsWith(r1)) {
  769. index = 1;
  770. goto finish;
  771. } else if (r2 && data.endsWith(r2)) {
  772. index = 2;
  773. goto finish;
  774. } else if (r3 && data.endsWith(r3)) {
  775. index = 3;
  776. goto finish;
  777. } else if (r4 && data.endsWith(r4)) {
  778. index = 4;
  779. goto finish;
  780. } else if (r5 && data.endsWith(r5)) {
  781. index = 5;
  782. goto finish;
  783. } else if (data.endsWith(GF(GSM_NL "+CIPRXGET:"))) {
  784. String mode = stream.readStringUntil(',');
  785. if (mode.toInt() == 1) {
  786. int mux = stream.readStringUntil('\n').toInt();
  787. if (mux >= 0 && mux < TINY_GSM_MUX_COUNT && sockets[mux]) {
  788. sockets[mux]->got_data = true;
  789. }
  790. data = "";
  791. DBG("### Got Data:", mux);
  792. } else {
  793. data += mode;
  794. }
  795. } else if (data.endsWith(GF(GSM_NL "+RECEIVE:"))) {
  796. int mux = stream.readStringUntil(',').toInt();
  797. int len = stream.readStringUntil('\n').toInt();
  798. if (mux >= 0 && mux < TINY_GSM_MUX_COUNT && sockets[mux]) {
  799. sockets[mux]->got_data = true;
  800. sockets[mux]->sock_available = len;
  801. }
  802. data = "";
  803. DBG("### Got Data:", len, "on", mux);
  804. } else if (data.endsWith(GF("CLOSED" GSM_NL))) {
  805. int nl = data.lastIndexOf(GSM_NL, data.length()-8);
  806. int coma = data.indexOf(',', nl+2);
  807. int mux = data.substring(nl+2, coma).toInt();
  808. if (mux >= 0 && mux < TINY_GSM_MUX_COUNT && sockets[mux]) {
  809. sockets[mux]->sock_connected = false;
  810. }
  811. data = "";
  812. DBG("### Closed: ", mux);
  813. }
  814. }
  815. } while (millis() - startMillis < timeout_ms);
  816. finish:
  817. if (!index) {
  818. data.trim();
  819. if (data.length()) {
  820. DBG("### Unhandled:", data);
  821. }
  822. data = "";
  823. }
  824. //data.replace(GSM_NL, "/");
  825. //DBG('<', index, '>', data);
  826. return index;
  827. }
  828. uint8_t waitResponse(uint32_t timeout_ms,
  829. GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR),
  830. GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
  831. {
  832. String data;
  833. return waitResponse(timeout_ms, data, r1, r2, r3, r4, r5);
  834. }
  835. uint8_t waitResponse(GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR),
  836. GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
  837. {
  838. return waitResponse(1000, r1, r2, r3, r4, r5);
  839. }
  840. public:
  841. Stream& stream;
  842. protected:
  843. GsmClient* sockets[TINY_GSM_MUX_COUNT];
  844. };
  845. #endif