MySensors Library & Examples  2.3.2-36-g2e00bf6
Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TinyGsm Class Reference

Detailed Description

Definition at line 42 of file TinyGsmClientA6.h.

+ Collaboration diagram for TinyGsm:

Classes

class  GsmClient
 
class  GsmClientSecure
 

Public Member Functions

 TinyGsm (Stream &stream)
 
bool begin ()
 
bool init ()
 
void setBaud (unsigned long baud)
 
bool testAT (unsigned long timeout=10000L)
 
void maintain ()
 
bool factoryDefault ()
 
String getModemInfo ()
 
bool hasSSL ()
 
bool restart ()
 
bool poweroff ()
 
bool radioOff () TINY_GSM_ATTR_NOT_IMPLEMENTED
 
bool sleepEnable (bool enable=true) TINY_GSM_ATTR_NOT_IMPLEMENTED
 
bool simUnlock (const char *pin)
 
String getSimCCID ()
 
String getIMEI ()
 
SimStatus getSimStatus (unsigned long timeout=10000L)
 
RegStatus getRegistrationStatus ()
 
String getOperator ()
 
int getSignalQuality ()
 
bool isNetworkConnected ()
 
bool waitForNetwork (unsigned long timeout=60000L)
 
bool gprsConnect (const char *apn, const char *user=NULL, const char *pwd=NULL)
 
bool gprsDisconnect ()
 
bool isGprsConnected ()
 
String getLocalIP ()
 
IPAddress localIP ()
 
bool setGsmBusy (bool busy=true) TINY_GSM_ATTR_NOT_AVAILABLE
 
bool callAnswer ()
 
bool callNumber (const String &number)
 
bool callHangup ()
 
bool dtmfSend (char cmd, unsigned duration_ms=100)
 
bool audioSetHeadphones ()
 
bool audioSetSpeaker ()
 
bool audioMuteMic (bool mute)
 
String sendUSSD (const String &code)
 
bool sendSMS (const String &number, const String &text)
 
String getGsmLocation () TINY_GSM_ATTR_NOT_AVAILABLE
 
uint16_t getBattVoltage () TINY_GSM_ATTR_NOT_AVAILABLE
 
int getBattPercent ()
 
template<typename T >
void streamWrite (T last)
 
template<typename T , typename... Args>
void streamWrite (T head, Args... tail)
 
bool streamSkipUntil (char c)
 
template<typename... Args>
void sendAT (Args... cmd)
 
uint8_t waitResponse (uint32_t timeout, String &data, GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
uint8_t waitResponse (uint32_t timeout, GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
uint8_t waitResponse (GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
 TinyGsm (Stream &stream)
 
bool begin ()
 
bool init ()
 
void setBaud (unsigned long baud)
 
bool testAT (unsigned long timeout=10000L)
 
void maintain ()
 
bool factoryDefault ()
 
String getModemInfo ()
 
bool hasSSL ()
 
bool restart ()
 
int getSignalQuality ()
 
bool isNetworkConnected ()
 
bool waitForNetwork (unsigned long timeout=60000L)
 
bool networkConnect (const char *ssid, const char *pwd)
 
bool networkDisconnect ()
 
String getLocalIP ()
 
IPAddress localIP ()
 
template<typename T >
void streamWrite (T last)
 
template<typename T , typename... Args>
void streamWrite (T head, Args... tail)
 
bool streamSkipUntil (char c)
 
template<typename... Args>
void sendAT (Args... cmd)
 
uint8_t waitResponse (uint32_t timeout, String &data, GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
uint8_t waitResponse (uint32_t timeout, GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
uint8_t waitResponse (GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
 TinyGsm (Stream &stream)
 
bool begin ()
 
bool init ()
 
void setBaud (unsigned long baud)
 
bool testAT (unsigned long timeout=10000L)
 
void maintain ()
 
bool factoryDefault ()
 
String getModemInfo ()
 
bool hasSSL ()
 
bool restart ()
 
bool poweroff ()
 
bool radioOff () TINY_GSM_ATTR_NOT_IMPLEMENTED
 
bool sleepEnable (bool enable=true)
 
bool simUnlock (const char *pin)
 
String getSimCCID ()
 
String getIMEI ()
 
SimStatus getSimStatus (unsigned long timeout=10000L)
 
RegStatus getRegistrationStatus ()
 
String getOperator ()
 
int getSignalQuality ()
 
bool isNetworkConnected ()
 
bool waitForNetwork (unsigned long timeout=60000L)
 
bool gprsConnect (const char *apn, const char *user=NULL, const char *pwd=NULL)
 
bool gprsDisconnect ()
 
bool isGprsConnected ()
 
String getLocalIP ()
 
IPAddress localIP ()
 
bool setGsmBusy (bool busy=true) TINY_GSM_ATTR_NOT_AVAILABLE
 
bool callAnswer () TINY_GSM_ATTR_NOT_AVAILABLE
 
bool callNumber (const String &number) TINY_GSM_ATTR_NOT_AVAILABLE
 
bool callHangup () TINY_GSM_ATTR_NOT_AVAILABLE
 
String sendUSSD (const String &code)
 
bool sendSMS (const String &number, const String &text)
 
bool sendSMS_UTF16 (const String &number, const void *text, size_t len) TINY_GSM_ATTR_NOT_AVAILABLE
 
String getGsmLocation () TINY_GSM_ATTR_NOT_AVAILABLE
 
uint16_t getBattVoltage () TINY_GSM_ATTR_NOT_AVAILABLE
 
int getBattPercent () TINY_GSM_ATTR_NOT_AVAILABLE
 
template<typename T >
void streamWrite (T last)
 
template<typename T , typename... Args>
void streamWrite (T head, Args... tail)
 
bool streamSkipUntil (char c)
 
template<typename... Args>
void sendAT (Args... cmd)
 
uint8_t waitResponse (uint32_t timeout, String &data, GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
uint8_t waitResponse (uint32_t timeout, GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
uint8_t waitResponse (GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
 TinyGsm (Stream &stream)
 
bool begin ()
 
bool init ()
 
bool testAT (unsigned long timeout=10000L)
 
void maintain ()
 
bool factoryDefault ()
 
bool hasSSL ()
 
bool restart ()
 
void setupPinSleep ()
 
bool simUnlock (const char *pin)
 
String getSimCCID ()
 
String getIMEI ()
 
SimStatus getSimStatus (unsigned long timeout=10000L)
 
RegStatus getRegistrationStatus ()
 
String getOperator ()
 
int getSignalQuality ()
 
bool isNetworkConnected ()
 
bool waitForNetwork (unsigned long timeout=60000L)
 
bool networkConnect (const char *ssid, const char *pwd)
 
bool networkDisconnect ()
 
String getLocalIP ()
 
IPAddress localIP ()
 
bool gprsConnect (const char *apn, const char *user=NULL, const char *pwd=NULL)
 
bool gprsDisconnect ()
 
String sendUSSD (const String &code) TINY_GSM_ATTR_NOT_IMPLEMENTED
 
bool sendSMS (const String &number, const String &text)
 
template<typename T >
void streamWrite (T last)
 
template<typename T , typename... Args>
void streamWrite (T head, Args... tail)
 
int streamRead ()
 
String streamReadUntil (char c)
 
void streamClear (void)
 
bool commandMode (void)
 
void writeChanges (void)
 
void exitCommand (void)
 
template<typename... Args>
void sendAT (Args... cmd)
 
uint8_t waitResponse (uint32_t timeout, String &data, GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
uint8_t waitResponse (uint32_t timeout, GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 
uint8_t waitResponse (GsmConstStr r1=GFP(GSM_OK), GsmConstStr r2=GFP(GSM_ERROR), GsmConstStr r3=NULL, GsmConstStr r4=NULL, GsmConstStr r5=NULL)
 

Public Attributes

Stream & stream
 

Protected Member Functions

bool modemConnect (const char *host, uint16_t port, uint8_t *mux)
 
int modemSend (const void *buff, size_t len, uint8_t mux)
 
bool modemGetConnected (uint8_t mux)
 
bool modemConnect (const char *host, uint16_t port, uint8_t mux, bool ssl=false)
 
int modemSend (const void *buff, size_t len, uint8_t mux)
 
bool modemGetConnected (uint8_t mux)
 
bool modemConnect (const char *host, uint16_t port, uint8_t mux)
 
int modemSend (const void *buff, size_t len, uint8_t mux)
 
bool modemGetConnected (uint8_t mux)
 
String dnsIpQuery (const char *host)
 

Protected Attributes

GsmClientsockets [TINY_GSM_MUX_COUNT]
 
int guardTime
 
XBeeType beeType
 

The documentation for this class was generated from the following files: