mirror of
				https://github.com/KevinMidboe/TinyGSM.git
				synced 2025-10-29 18:00:18 +00:00 
			
		
		
		
	Added very minor code comments
This commit is contained in:
		| @@ -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<typename T> | ||||
|   void streamWrite(T last) { | ||||
|   | ||||
| @@ -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<typename T> | ||||
|   void streamWrite(T last) { | ||||
|   | ||||
| @@ -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<typename T> | ||||
|   void streamWrite(T last) { | ||||
|   | ||||
| @@ -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<typename T> | ||||
|   void streamWrite(T last) { | ||||
|   | ||||
| @@ -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<typename T> | ||||
|   void streamWrite(T last) { | ||||
|   | ||||
| @@ -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) { | ||||
|   | ||||
| @@ -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<typename T> | ||||
|   void streamWrite(T last) { | ||||
|   | ||||
| @@ -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<typename T> | ||||
|   void streamWrite(T last) { | ||||
|   | ||||
| @@ -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<typename T> | ||||
|   void streamWrite(T last) { | ||||
|   | ||||
		Reference in New Issue
	
	Block a user