group__espressif__esp32

---

title: Espressif ESP32 (AT)

Espressif ESP32 (AT) (group)

Module: Supported Modules / Espressif AT / Espressif ESP32 (AT)

Manufacturer: Espressif. Models: ESP32 (AT firmware, version >= 3.2.0.0).

Connection Information

• Combined TCP/SSL sockets:
  • 5
  • Using more than 1 SSL socket at a time may cause the module to crash.
• SSL contexts:
  • 2
• Socket Buffering:
  • The modem has an internal buffer for incoming data.
• Socket Numbering:
  • The modem respects user-specified multiplexing channel numbers/identifiers for socket connections. Todo: todo

Supported Public Functions

• TinyGsmESP32
  • GSM Modem Constructor
    • TinyGsmEspressif(Stream& stream)
  • Basic functions (TinyGsmModem.tpp)
    • begin(const char* pin = nullptr)
    • init(const char* pin = nullptr)
    • sendAT(Args... cmd)
    • setBaud(uint32_t baud)
    • setDefaultBaud(uint32_t baud)
    • forceModemBaud(StreamObject& at_serial, uint32_t targetBaud)
    • testAT(uint32_t timeout_ms = 10000L)
    • waitResponse(uint32_t timeout_ms, String& data, GsmConstStr r1 = GFP(ModemConfig::GSM_OK), GsmConstStr r2 = GFP(ModemConfig::GSM_ERROR), GsmConstStr r3 = nullptr, GsmConstStr r4 = nullptr, GsmConstStr r5 = nullptr, GsmConstStr r6 = nullptr, GsmConstStr r7 = nullptr, GsmConstStr r8 = nullptr)
    • waitResponse(uint32_t timeout_ms, GsmConstStr r1 = GFP(ModemConfig::GSM_OK), GsmConstStr r2 = GFP(ModemConfig::GSM_ERROR), GsmConstStr r3 = nullptr, GsmConstStr r4 = nullptr, GsmConstStr r5 = nullptr, GsmConstStr r6 = nullptr, GsmConstStr r7 = nullptr, GsmConstStr r8 = nullptr)
    • waitResponse(GsmConstStr r1 = GFP(ModemConfig::GSM_OK), GsmConstStr r2 = GFP(ModemConfig::GSM_ERROR), GsmConstStr r3 = nullptr, GsmConstStr r4 = nullptr, GsmConstStr r5 = nullptr, GsmConstStr r6 = nullptr, GsmConstStr r7 = nullptr, GsmConstStr r8 = nullptr)
    • getConfiguredModem()
    • getModemInfo()
    • getModemName()
    • getModemManufacturer()
    • getModemModel()
    • getModemRevision()
    • getModemSerialNumber()
    • factoryDefault()
  • Power functions (TinyGsmModem.tpp)
    • restart(const char* pin = nullptr)
    • radioOff()
    • sleepEnable(bool enable = true)
    • setPhoneFunctionality(uint8_t fun, bool reset = false)
  • Generic network functions (TinyGsmModem.tpp)
    • getRegistrationStatus()
    • isNetworkConnected()
    • waitForNetwork(uint32_t timeout_ms = 60000L, bool check_signal = false)
    • getSignalQuality()
    • getLocalIP()
    • localIP()
  • WiFi functions (TinyGsmWifi.tpp)
    • networkConnect(const char* ssid, const char* pwd)
    • networkDisconnect()
  • Socket listening functions (TinyGsmTCP.tpp)
    • maintain()
  • Secure socket layer (SSL) certificate management functions (TinyGsmSSL.tpp)
    • TinyGsmSSL()
    • TinyGsmSSL(modemType& , uint8_t = 0)
    • loadCertificate(const char* certificateName, const char* cert, const uint16_t len)
    • loadCertificate(const String& certificateName, const String& cert, const uint16_t len)
    • deleteCertificate(const String& filename)
    • printCertificate(const char* filename, Stream& print_stream)
    • printCertificate(const String& filename, Stream& print_stream)
    • convertCertificate(CertificateType cert_type, const String& filename)
    • convertCACertificate(const String& ca_cert_name)
    • convertClientCertificates(const String& client_cert_name, const String& client_cert_key)
    • convertPSKandID(const String& psk, const String& pskIdent)
    • convertPSKTable(const String& psk_table_name)
  • Secure socket layer (SSL) certificate management functions
    • loadCACert(uint8_t certNumber, const char* cert, const uint16_t len)
    • loadClientCert(uint8_t certNumber, const char* cert, const uint16_t len)
    • loadPrivateKey(uint8_t keyNumber, const char* key, const uint16_t len)
    • loadCertificateByNumber(CertificateType cert_type, uint8_t certNumber, const char* cert, const uint16_t len)
    • deleteCertificateByNumber(CertificateType cert_type, uint8_t certNumber)
    • printCertificateByNumber(CertificateType cert_type, uint8_t certNumber, Stream& print_stream)
  • NTP server functions (TinyGsmNTP.tpp)
    • NTPServerSync(const char* server =pool.ntp.org", int TimeZone = 0)"
    • NTPServerSync(const String& server, int TimeZone = 0)
    • waitForTimeSync(uint16_t timeout_s = 120)
  • Time functions (TinyGsmTime.tpp)
    • getGSMDateTime(TinyGSMDateTimeFormat format)
    • getNetworkTime(int* year, int* month, int* day, int* hour, int* minute, int* second, float* timezone)
    • getNetworkEpoch(TinyGSM_EpochStart epoch = TinyGSM_EpochStart::UNIX)
  • Time functions
    • setTimeZone(int8_t timezone, bool enable_sync = true)
    • setTimeSyncInterval(uint16_t seconds)
  • Utilities (TinyGsmModem.tpp)
    • streamWrite(T last)
    • streamWrite(T head, Args... tail)
    • streamClear()
    • streamDump(int16_t expected_len)
• GsmClientESP32
  • Arduino Client interface (TinyGsmTCP.tpp)
    • connect(const char* host, uint16_t port, int timeout_s)
    • connect(IPAddress ip, uint16_t port, int timeout_s)
    • connect(const char* host, uint16_t port)
    • connect(IPAddress ip, uint16_t port)
    • stop(uint32_t maxWaitMs)
    • stop()
    • write(const uint8_t* buf, size_t size)
    • write(uint8_t c)
    • available()
    • read(uint8_t* buf, size_t size)
    • read()
    • peek()
    • flush()
    • connected()
  • Extended Client API (TinyGsmTCP.tpp)
    • getMux()
    • getConnectionID()
    • beginWrite(uint16_t size)
    • endWrite(uint16_t expected_size = 0)
• GsmClientSecureESP32
  • Client constructors and initialization
    • GsmClientSecureESP32()
    • GsmClientSecureESP32(TinyGsmESP32& modem, uint8_t mux = 0)
    • GsmClientSecureESP32(TinyGsmESP32& modem, SSLAuthMode sslAuthMode, SSLVersion sslVersion = SSLVersion::TLS1_2, const char* CAcertName = nullptr, const char* clientCertName = nullptr, const char* clientKeyName = nullptr)
    • GsmClientSecureESP32(TinyGsmESP32& modem, uint8_t mux, SSLAuthMode sslAuthMode, SSLVersion sslVersion = SSLVersion::TLS1_2, const char* CAcertName = nullptr, const char* clientCertName = nullptr, const char* clientKeyName = nullptr)
    • GsmClientSecureESP32(TinyGsmESP32& modem, const char* pskIdent, const char* psKey, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureESP32(TinyGsmESP32& modem, uint8_t mux, const char* pskIdent, const char* psKey, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureESP32(TinyGsmESP32& modem, const char* pskTableName, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureESP32(TinyGsmESP32& modem, uint8_t mux, const char* pskTableName, SSLVersion sslVersion = SSLVersion::TLS1_2)
  • Client SSL configuration functions (TinyGsmSSL.tpp)
    • setSSLContextIndex(uint8_t sslCtxIndex)
    • setSSLAuthMode(SSLAuthMode mode)
    • setSSLVersion(SSLVersion version)
  • Arduino Client interface (TinyGsmTCP.tpp)
    • connect(const char* host, uint16_t port, int timeout_s)
    • connect(IPAddress ip, uint16_t port, int timeout_s)
    • connect(const char* host, uint16_t port)
    • connect(IPAddress ip, uint16_t port)
    • stop(uint32_t maxWaitMs)
    • stop()
    • write(const uint8_t* buf, size_t size)
    • write(uint8_t c)
    • available()
    • read(uint8_t* buf, size_t size)
    • read()
    • peek()
    • flush()
    • connected()
  • Client certificate assignment functions (TinyGsmSSL.tpp)
    • setCACertName(const char* CAcertName)
    • setCACertName(const String& CAcertName)
    • setClientCertName(const char* clientCertName)
    • setClientCertName(const String& clientCertName)
    • setPrivateKeyName(const char* clientKeyName)
    • setPrivateKeyName(const String& clientKeyName)
  • Client PSK assignment functions (TinyGsmSSL.tpp)
    • setPSKTableName(const char* pskTableName)
    • setPSKTableName(const String& pskTableName)
    • setPreSharedKey(const char* pskIdent, const char* psKey)
    • setPreSharedKey(const String& pskIdent, const String& psKey)
  • Extended Client API (TinyGsmTCP.tpp)
    • getMux()
    • getConnectionID()
    • beginWrite(uint16_t size)
    • endWrite(uint16_t expected_size = 0)
  • Client certificate assignment functions
    • setCACertificateNumber(uint8_t certNumber)
    • setClientCertificateNumber(uint8_t certNumber)
    • setPrivateKeyNumber(uint8_t keyNumber)

Classes

	Name
struct	TinyGsmESP32ModemConfig Basic modem configurations for the ESP32.
struct	TinyGsmESP32TcpConfig TCP behavior and limits for the ESP32.
class	TinyGsmESP32 Class for the Espressif ESP32 modem, which is a Wi-Fi module with SSL support.
class	TinyGsmESP32::GsmClientESP32 Inner client.
class	TinyGsmESP32::GsmClientSecureESP32 Inner secure client.

Types

	Name
enum class	ESP32RegStatus { REG_UNINITIALIZED = 0, REG_UNREGISTERED = 1, REG_OK = 2, REG_CONNECTING = 3, REG_DISCONNECTING = 4, REG_UNKNOWN = 5 } State: current Wi-Fi state.

ESP32RegStatus

Enumerator	Value	Description
REG_UNINITIALIZED	0	ESP32 station has not started any Wi-Fi connection.
REG_UNREGISTERED	1	ESP32 station has connected to an AP, but does not get an IPv4 address yet.
REG_OK	2	ESP32 station has connected to an AP, and got an IPv4 address.
REG_CONNECTING	3	ESP32 station is in Wi-Fi connecting or reconnecting state.
REG_DISCONNECTING	4	ESP32 station is in Wi-Fi disconnected state.
REG_UNKNOWN	5	ESP32 station is in an unknown state.

---

Generated by Doxygen and m.css with templates from doxybook2 Updated on 2026-09-11