From ed9b87d8960b638c8607174e584bfb72a81a6181 Mon Sep 17 00:00:00 2001 From: Sara Damiano Date: Thu, 13 Sep 2018 16:43:08 -0400 Subject: [PATCH] Added very minor code comments --- src/TinyGsmClientA6.h | 8 +++++++- src/TinyGsmClientBG96.h | 8 +++++++- src/TinyGsmClientESP8266.h | 9 ++++++++- src/TinyGsmClientM590.h | 8 +++++++- src/TinyGsmClientM95.h | 8 +++++++- src/TinyGsmClientMC60.h | 4 ++++ src/TinyGsmClientSIM800.h | 10 +++++++++- src/TinyGsmClientUBLOX.h | 8 +++++++- src/TinyGsmClientXBee.h | 8 +++++++- 9 files changed, 63 insertions(+), 8 deletions(-) diff --git a/src/TinyGsmClientA6.h b/src/TinyGsmClientA6.h index 5f720e2..d16bbf0 100644 --- a/src/TinyGsmClientA6.h +++ b/src/TinyGsmClientA6.h @@ -522,6 +522,10 @@ public: return res; } + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t* mux) { @@ -566,7 +570,9 @@ protected: public: - /* Utilities */ + /* + Utilities + */ template void streamWrite(T last) { diff --git a/src/TinyGsmClientBG96.h b/src/TinyGsmClientBG96.h index 3edbf8a..71ce42d 100644 --- a/src/TinyGsmClientBG96.h +++ b/src/TinyGsmClientBG96.h @@ -534,6 +534,10 @@ public: int getBattPercent() TINY_GSM_ATTR_NOT_IMPLEMENTED; + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool ssl = false) { @@ -623,7 +627,9 @@ protected: public: - /* Utilities */ + /* + Utilities + */ template void streamWrite(T last) { diff --git a/src/TinyGsmClientESP8266.h b/src/TinyGsmClientESP8266.h index a87432e..585a856 100644 --- a/src/TinyGsmClientESP8266.h +++ b/src/TinyGsmClientESP8266.h @@ -191,6 +191,7 @@ public: } }; + public: TinyGsmESP8266(Stream& stream) @@ -386,6 +387,10 @@ public: return res2; } + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool ssl = false) { @@ -423,7 +428,9 @@ protected: public: - /* Utilities */ + /* + Utilities + */ template void streamWrite(T last) { diff --git a/src/TinyGsmClientM590.h b/src/TinyGsmClientM590.h index 8f0093d..6b524ee 100644 --- a/src/TinyGsmClientM590.h +++ b/src/TinyGsmClientM590.h @@ -519,6 +519,10 @@ public: int getBattPercent() TINY_GSM_ATTR_NOT_AVAILABLE; + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t mux) { @@ -576,7 +580,9 @@ protected: public: - /* Utilities */ + /* + Utilities + */ template void streamWrite(T last) { diff --git a/src/TinyGsmClientM95.h b/src/TinyGsmClientM95.h index 4925ffa..90a1e82 100644 --- a/src/TinyGsmClientM95.h +++ b/src/TinyGsmClientM95.h @@ -627,6 +627,10 @@ public: return res; } + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool ssl = false) { @@ -728,7 +732,9 @@ protected: public: - /* Utilities */ + /* + Utilities + */ template void streamWrite(T last) { diff --git a/src/TinyGsmClientMC60.h b/src/TinyGsmClientMC60.h index 58e0e65..20477a9 100644 --- a/src/TinyGsmClientMC60.h +++ b/src/TinyGsmClientMC60.h @@ -662,6 +662,10 @@ public: return res; } + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool ssl = false) { diff --git a/src/TinyGsmClientSIM800.h b/src/TinyGsmClientSIM800.h index 346701e..34843c2 100644 --- a/src/TinyGsmClientSIM800.h +++ b/src/TinyGsmClientSIM800.h @@ -39,6 +39,7 @@ enum RegStatus { REG_UNKNOWN = 4, }; + class TinyGsmSim800 : public TinyGsmModem { @@ -694,6 +695,7 @@ public: /* * Battery functions */ + // Use: float vBatt = modem.getBattVoltage() / 1000.0; uint16_t getBattVoltage() { sendAT(GF("+CBC")); @@ -719,6 +721,10 @@ public: return res; } + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t mux, bool ssl = false) { @@ -813,7 +819,9 @@ protected: public: - /* Utilities */ + /* + Utilities + */ template void streamWrite(T last) { diff --git a/src/TinyGsmClientUBLOX.h b/src/TinyGsmClientUBLOX.h index 42c736a..84e5d56 100644 --- a/src/TinyGsmClientUBLOX.h +++ b/src/TinyGsmClientUBLOX.h @@ -547,6 +547,10 @@ public: return res; } + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t* mux, bool ssl = false) { @@ -640,7 +644,9 @@ protected: public: - /* Utilities */ + /* + Utilities + */ template void streamWrite(T last) { diff --git a/src/TinyGsmClientXBee.h b/src/TinyGsmClientXBee.h index 5b4b13e..4a9c94d 100644 --- a/src/TinyGsmClientXBee.h +++ b/src/TinyGsmClientXBee.h @@ -651,6 +651,10 @@ fail: int getBattPercent() TINY_GSM_ATTR_NOT_AVAILABLE; + /* + * Client related functions + */ + protected: bool modemConnect(const char* host, uint16_t port, uint8_t mux = 0, bool ssl = false) { @@ -716,7 +720,9 @@ protected: public: - /* Utilities */ + /* + Utilities + */ template void streamWrite(T last) {