JSD/TinyGSM
3
0
Fork 1
mirror of https://github.com/vshymanskyy/TinyGSM.git synced 2026-05-15 04:06:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added some notes

Browse Source 
Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
This commit is contained in:
Sara Damiano
2024-05-21 15:46:19 -04:00
parent d608229522
commit edb42d896a
14 changed files with 154 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/TinyGsmBattery.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmBattery {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* Battery functions
@@ -44,6 +49,13 @@ class TinyGsmBattery {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* Battery functions
*/

11
src/TinyGsmBluetooth.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmBluetooth {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* Bluetooth functions
@@ -43,6 +48,12 @@ class TinyGsmBluetooth {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* Bluetooth functions
*/

11
src/TinyGsmCalling.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmCalling {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* Phone Call functions
@@ -43,6 +48,12 @@ class TinyGsmCalling {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* Phone Call functions
*/

11
src/TinyGsmGPRS.tpp
View File

@@ -22,6 +22,11 @@ enum SimStatus {
template <class modemType>
class TinyGsmGPRS {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* SIM card functions
@@ -81,6 +86,12 @@ class TinyGsmGPRS {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* SIM card functions
*/

12
src/TinyGsmGPS.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmGPS {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* GPS/GNSS/GLONASS location functions
@@ -62,6 +67,13 @@ class TinyGsmGPS {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* GPS/GNSS/GLONASS location functions
*/

11
src/TinyGsmGSMLocation.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmGSMLocation {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* GSM Location functions
@@ -54,6 +59,12 @@ class TinyGsmGSMLocation {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* GSM Location functions
* Template is based on SIMCOM commands

13
src/TinyGsmModem.tpp
View File

@@ -43,6 +43,11 @@ static const char GSM_VERBOSE_2[] TINY_GSM_PROGMEM = AT_VERBOSE_2;
template <class modemType>
class TinyGsmModem {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* Basic functions
@@ -168,6 +173,12 @@ class TinyGsmModem {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* Basic functions
*/
@@ -175,7 +186,7 @@ class TinyGsmModem {
bool setBaudImpl(uint32_t baud) {
thisModem().sendAT(GF("+IPR="), baud);
return thisModem().waitResponse() == 1;
}
}
bool testATImpl(uint32_t timeout_ms = 10000L) {
for (uint32_t start = millis(); millis() - start < timeout_ms;) {

11
src/TinyGsmNTP.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmNTP {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* NTP server functions
@@ -50,6 +55,12 @@ class TinyGsmNTP {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* NTP server functions
*/

13
src/TinyGsmSMS.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmSMS {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* Messaging functions
@@ -41,7 +46,7 @@ class TinyGsmSMS {
}
/*
* Messaging functions
* Utilities
*/
protected:
static inline String TinyGsmDecodeHex7bit(String& instr) {
@@ -111,6 +116,12 @@ class TinyGsmSMS {
return result;
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
String sendUSSDImpl(const String& code) {
// Set preferred message format to text mode
thisModem().sendAT(GF("+CMGF=1"));

27
src/TinyGsmSSL.tpp
View File

@@ -16,6 +16,11 @@
template <class modemType>
class TinyGsmSSL {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* SSL functions
@@ -38,27 +43,11 @@ class TinyGsmSSL {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Inner Secure Client
* Define the default function implementations
*/
/*
public:
class GsmClientSecure : public GsmClient {
public:
GsmClientSecureSim800() {}
explicit GsmClientSecureSim800(TinyGsmSim800& modem, uint8_t mux = 0)
: GsmClientSim800(modem, mux) {}
public:
int connect(const char* host, uint16_t port, int timeout_s) overide {
stop();
TINY_GSM_YIELD();
rx.clear();
sock_connected = at->modemConnect(host, port, mux, true, timeout_s);
return sock_connected;
}
};*/
/*
* SSL functions

11
src/TinyGsmTCP.tpp
View File

@@ -43,6 +43,11 @@
template <class modemType, uint8_t muxCount>
class TinyGsmTCP {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* Basic functions
@@ -315,6 +320,12 @@ class TinyGsmTCP {
RxFifo rx;
};
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* Basic functions
*/

11
src/TinyGsmTemperature.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmTemperature {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* Temperature functions
@@ -34,6 +39,12 @@ class TinyGsmTemperature {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
float getTemperatureImpl() TINY_GSM_ATTR_NOT_IMPLEMENTED;
};

10
src/TinyGsmTime.tpp
View File

@@ -17,6 +17,11 @@ enum TinyGSMDateTimeFormat { DATE_FULL = 0, DATE_TIME = 1, DATE_DATE = 2 };
template <class modemType>
class TinyGsmTime {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* Time functions
@@ -46,6 +51,11 @@ class TinyGsmTime {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* Time functions
*/

11
src/TinyGsmWifi.tpp
View File

@@ -15,6 +15,11 @@
template <class modemType>
class TinyGsmWifi {
/* =========================================== */
/* =========================================== */
/*
* Define the interface
*/
public:
/*
* WiFi functions
@@ -37,6 +42,12 @@ class TinyGsmWifi {
return static_cast<modemType&>(*this);
}
/* =========================================== */
/* =========================================== */
/*
* Define the default function implementations
*/
/*
* WiFi functions
*/