/** * @file TinyGsmClientUBLOX.h * @author Volodymyr Shymanskyy * @license LGPL-3.0 * @copyright Copyright (c) 2016 Volodymyr Shymanskyy * @date Nov 2016 */ #ifndef SRC_TINYGSMCLIENTUBLOX_H_ #define SRC_TINYGSMCLIENTUBLOX_H_ // #pragma message("TinyGSM: TinyGsmClientUBLOX") // #define TINY_GSM_DEBUG Serial #define TINY_GSM_MUX_COUNT 7 #define TINY_GSM_BUFFER_READ_AND_CHECK_SIZE #include "TinyGsmBattery.tpp" #include "TinyGsmCalling.tpp" #include "TinyGsmGPRS.tpp" #include "TinyGsmGPS.tpp" #include "TinyGsmGSMLocation.tpp" #include "TinyGsmModem.tpp" #include "TinyGsmSMS.tpp" #include "TinyGsmSSL.tpp" #include "TinyGsmTCP.tpp" #include "TinyGsmTime.tpp" #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; #if defined TINY_GSM_DEBUG static const char GSM_CME_ERROR[] TINY_GSM_PROGMEM = GSM_NL "+CME ERROR:"; #endif enum RegStatus { REG_NO_RESULT = -1, REG_UNREGISTERED = 0, REG_SEARCHING = 2, REG_DENIED = 3, REG_OK_HOME = 1, REG_OK_ROAMING = 5, REG_UNKNOWN = 4, }; class TinyGsmUBLOX : public TinyGsmModem, public TinyGsmGPRS, public TinyGsmTCP, public TinyGsmSSL, public TinyGsmCalling, public TinyGsmSMS, public TinyGsmGSMLocation, public TinyGsmGPS, public TinyGsmTime, public TinyGsmBattery { friend class TinyGsmModem; friend class TinyGsmGPRS; friend class TinyGsmTCP; friend class TinyGsmSSL; friend class TinyGsmCalling; friend class TinyGsmSMS; friend class TinyGsmGSMLocation; friend class TinyGsmGPS; friend class TinyGsmTime; friend class TinyGsmBattery; /* * Inner Client */ public: class GsmClientUBLOX : public GsmClient { friend class TinyGsmUBLOX; public: GsmClientUBLOX() {} explicit GsmClientUBLOX(TinyGsmUBLOX& modem, uint8_t mux = 0) { init(&modem, mux); } bool init(TinyGsmUBLOX* modem, uint8_t mux = 0) { this->at = modem; sock_available = 0; prev_check = 0; sock_connected = false; got_data = false; if (mux < TINY_GSM_MUX_COUNT) { this->mux = mux; } else { this->mux = (mux % TINY_GSM_MUX_COUNT); } at->sockets[this->mux] = this; return true; } public: virtual int connect(const char* host, uint16_t port, int timeout_s) { // stop(); // DON'T stop! TINY_GSM_YIELD(); rx.clear(); uint8_t oldMux = mux; sock_connected = at->modemConnect(host, port, &mux, false, timeout_s); if (mux != oldMux) { DBG("WARNING: Mux number changed from", oldMux, "to", mux); at->sockets[oldMux] = NULL; } at->sockets[mux] = this; at->maintain(); return sock_connected; } TINY_GSM_CLIENT_CONNECT_OVERRIDES void stop(uint32_t maxWaitMs) { dumpModemBuffer(maxWaitMs); at->sendAT(GF("+USOCL="), mux); at->waitResponse(); // should return within 1s sock_connected = false; } void stop() override { stop(15000L); } /* * Extended API */ String remoteIP() TINY_GSM_ATTR_NOT_IMPLEMENTED; }; /* * Inner Secure Client */ public: class GsmClientSecureUBLOX : public GsmClientUBLOX { public: GsmClientSecureUBLOX() {} explicit GsmClientSecureUBLOX(TinyGsmUBLOX& modem, uint8_t mux = 0) : GsmClientUBLOX(modem, mux) {} public: int connect(const char* host, uint16_t port, int timeout_s) override { // stop(); // DON'T stop! TINY_GSM_YIELD(); rx.clear(); uint8_t oldMux = mux; sock_connected = at->modemConnect(host, port, &mux, true, timeout_s); if (mux != oldMux) { DBG("WARNING: Mux number changed from", oldMux, "to", mux); at->sockets[oldMux] = NULL; } at->sockets[mux] = this; at->maintain(); return sock_connected; } TINY_GSM_CLIENT_CONNECT_OVERRIDES }; /* * Constructor */ public: explicit TinyGsmUBLOX(Stream& stream) : stream(stream) { memset(sockets, 0, sizeof(sockets)); } /* * Basic functions */ protected: bool initImpl(const char* pin = NULL) { DBG(GF("### TinyGSM Version:"), TINYGSM_VERSION); if (!testAT()) { return false; } sendAT(GF("E0")); // Echo Off if (waitResponse() != 1) { return false; } #ifdef TINY_GSM_DEBUG sendAT(GF("+CMEE=2")); // turn on verbose error codes #else sendAT(GF("+CMEE=0")); // turn off error codes #endif waitResponse(); DBG(GF("### Modem:"), getModemName()); // Enable automatic time zome update sendAT(GF("+CTZU=1")); if (waitResponse(10000L) != 1) { return false; } SimStatus ret = getSimStatus(); // if the sim isn't ready and a pin has been provided, try to unlock the sim if (ret != SIM_READY && pin != NULL && strlen(pin) > 0) { simUnlock(pin); return (getSimStatus() == SIM_READY); } else { // if the sim is ready, or it's locked but no pin has been provided, // return true return (ret == SIM_READY || ret == SIM_LOCKED); } } // only difference in implementation is the warning on the wrong type String getModemNameImpl() { sendAT(GF("+CGMI")); String res1; if (waitResponse(1000L, res1) != 1) { return "u-blox Cellular Modem"; } res1.replace(GSM_NL "OK" GSM_NL, ""); res1.trim(); sendAT(GF("+GMM")); String res2; if (waitResponse(1000L, res2) != 1) { return "u-blox Cellular Modem"; } res2.replace(GSM_NL "OK" GSM_NL, ""); res2.trim(); String name = res1 + String(' ') + res2; DBG("### Modem:", name); if (name.startsWith("u-blox SARA-R4") || name.startsWith("u-blox SARA-N4")) { DBG("### WARNING: You are using the wrong TinyGSM modem!"); } else if (name.startsWith("u-blox SARA-N2")) { DBG("### SARA N2 NB-IoT modems not supported!"); } return name; } bool factoryDefaultImpl() { sendAT(GF("+UFACTORY=0,1")); // No factory restore, erase NVM waitResponse(); sendAT(GF("+CFUN=16")); // Reset return waitResponse() == 1; } /* * Power functions */ protected: bool restartImpl() { if (!testAT()) { return false; } sendAT(GF("+CFUN=16")); if (waitResponse(10000L) != 1) { return false; } delay(3000); // TODO(?): Verify delay timing here return init(); } bool powerOffImpl() { sendAT(GF("+CPWROFF")); return waitResponse(40000L) == 1; } bool sleepEnableImpl(bool enable = true) TINY_GSM_ATTR_NOT_AVAILABLE; /* * Generic network functions */ public: RegStatus getRegistrationStatus() { return (RegStatus)getRegistrationStatusXREG("CGREG"); } protected: bool isNetworkConnectedImpl() { RegStatus s = getRegistrationStatus(); if (s == REG_OK_HOME || s == REG_OK_ROAMING) return true; else if (s == REG_UNKNOWN) // for some reason, it can hang at unknown.. return isGprsConnected(); else return false; } String getLocalIPImpl() { sendAT(GF("+UPSND=0,0")); if (waitResponse(GF(GSM_NL "+UPSND:")) != 1) { return ""; } streamSkipUntil(','); // Skip PSD profile streamSkipUntil('\"'); // Skip request type String res = stream.readStringUntil('\"'); if (waitResponse() != 1) { return ""; } return res; } /* * GPRS functions */ protected: bool gprsConnectImpl(const char* apn, const char* user = NULL, const char* pwd = NULL) { // gprsDisconnect(); sendAT(GF("+CGATT=1")); // attach to GPRS if (waitResponse(360000L) != 1) { return false; } // Setting up the PSD profile/PDP context with the UPSD commands sets up an // "internal" PDP context, i.e. a data connection using the internal IP // stack and related AT commands for sockets. // Packet switched data configuration // AT+UPSD=,, // profile_id = 0 - PSD profile identifier, in range 0-6 (NOT PDP context) // param_tag = 1: APN // param_tag = 2: username // param_tag = 3: password // param_tag = 7: IP address Note: IP address set as "0.0.0.0" means // dynamic IP address assigned during PDP context activation sendAT(GF("+UPSD=0,1,\""), apn, '"'); // Set APN for PSD profile 0 waitResponse(); if (user && strlen(user) > 0) { sendAT(GF("+UPSD=0,2,\""), user, '"'); // Set user for PSD profile 0 waitResponse(); } if (pwd && strlen(pwd) > 0) { sendAT(GF("+UPSD=0,3,\""), pwd, '"'); // Set password for PSD profile 0 waitResponse(); } sendAT(GF("+UPSD=0,7,\"0.0.0.0\"")); // Dynamic IP on PSD profile 0 waitResponse(); // Packet switched data action // AT+UPSDA=, // profile_id = 0: PSD profile identifier, in range 0-6 (NOT PDP context) // action = 3: activate; it activates a PDP context with the specified // profile, using the current parameters sendAT(GF( "+UPSDA=0,3")); // Activate the PDP context associated with profile 0 if (waitResponse(360000L) != 1) { // Should return ok return false; } // Packet switched network-assigned data - Returns the current (dynamic) // network-assigned or network-negotiated value of the specified parameter // for the active PDP context associated with the specified PSD profile. // AT+UPSND=, // profile_id = 0: PSD profile identifier, in range 0-6 (NOT PDP context) // param_tag = 8: PSD profile status: if the profile is active the return // value is 1, 0 otherwise sendAT(GF("+UPSND=0,8")); // Check if PSD profile 0 is now active int8_t res = waitResponse(GF(",8,1"), GF(",8,0")); waitResponse(); // Should return another OK if (res == 1) { return true; // It's now active } else if (res == 2) { // If it's not active yet, wait for the +UUPSDA URC if (waitResponse(180000L, GF("+UUPSDA: 0")) != 1) { // 0=successful return false; } streamSkipUntil('\n'); // Ignore the IP address, if returned } else { return false; } return true; } bool gprsDisconnectImpl() { sendAT(GF( "+UPSDA=0,4")); // Deactivate the PDP context associated with profile 0 if (waitResponse(360000L) != 1) { return false; } sendAT(GF("+CGATT=0")); // detach from GPRS if (waitResponse(360000L) != 1) { return false; } return true; } /* * SIM card functions */ protected: // This uses "CGSN" instead of "GSN" String getIMEIImpl() { sendAT(GF("+CGSN")); if (waitResponse(GF(GSM_NL)) != 1) { return ""; } String res = stream.readStringUntil('\n'); waitResponse(); res.trim(); return res; } /* * Phone Call functions */ protected: // Can follow all of the phone call functions from the template /* * Messaging functions */ protected: // Can follow all template functions /* * GSM/GPS/GNSS/GLONASS Location functions * NOTE: u-blox modules use the same function to get location data from both * GSM tower triangulation and from dedicated GPS/GNSS/GLONASS receivers. The * only difference in which sensor the data is requested from. If a GNSS * location is requested from a modem without a GNSS receiver installed on the * I2C port, the GSM-based "Cell Locate" location will be returned instead. */ protected: bool enableGPSImpl() { // AT+UGPS=[,[,]] // - 0: GNSS receiver powered off, 1: on // - 0: no aiding (default) // - 3: GPS + SBAS (default) sendAT(GF("+UGPS=1,0,3")); if (waitResponse(10000L, GF(GSM_NL "+UGPS:")) != 1) { return false; } return waitResponse(10000L) == 1; } bool disableGPSImpl() { sendAT(GF("+UGPS=0")); if (waitResponse(10000L, GF(GSM_NL "+UGPS:")) != 1) { return false; } return waitResponse(10000L) == 1; } String inline getUbloxLocationRaw(int8_t sensor) { // AT+ULOC=,,,, // - 2: single shot position // - 0: use the last fix in the internal database and stop the GNSS // receiver // - 1: use the GNSS receiver for localization // - 2: use cellular CellLocate location information // - 3: ?? use the combined GNSS receiver and CellLocate service // information ?? - Docs show using sensor 3 and it's // documented for the +UTIME command but not for +ULOC // - 0: standard (single-hypothesis) response // - Timeout period in seconds // - Target accuracy in meters (1 - 999999) sendAT(GF("+ULOC=2,"), sensor, GF(",0,120,1")); // wait for first "OK" if (waitResponse(10000L) != 1) { return ""; } // wait for the final result - wait full timeout time if (waitResponse(120000L, GF(GSM_NL "+UULOC:")) != 1) { return ""; } String res = stream.readStringUntil('\n'); waitResponse(); res.trim(); return res; } String getGsmLocationRawImpl() { return getUbloxLocationRaw(2); } String getGPSrawImpl() { return getUbloxLocationRaw(1); } inline bool getUbloxLocation(int8_t sensor, float* lat, float* lon, float* speed = 0, float* alt = 0, int* vsat = 0, int* usat = 0, float* accuracy = 0, int* year = 0, int* month = 0, int* day = 0, int* hour = 0, int* minute = 0, int* second = 0) { // AT+ULOC=,,,, // - 2: single shot position // - 2: use cellular CellLocate location information // - 0: use the last fix in the internal database and stop the GNSS // receiver // - 1: use the GNSS receiver for localization // - 3: ?? use the combined GNSS receiver and CellLocate service // information ?? - Docs show using sensor 3 and it's documented // for the +UTIME command but not for +ULOC // - 0: standard (single-hypothesis) response // - Timeout period in seconds // - Target accuracy in meters (1 - 999999) sendAT(GF("+ULOC=2,"), sensor, GF(",0,120,1")); // wait for first "OK" if (waitResponse(10000L) != 1) { return false; } // wait for the final result - wait full timeout time if (waitResponse(120000L, GF(GSM_NL "+UULOC: ")) != 1) { return false; } // +UULOC: ,