group__quectel__bg96

---

title: Quectel BG96 and BG95

Quectel BG96 and BG95 (group)

Module: Supported Modules / Quectel / Quectel BG96 and BG95

Manufacturer: Quectel. Models: BG95, BG96.

Connection Information

• Combined TCP/SSL sockets:
  • 12
• SSL contexts:
  • 6
• 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

• TinyGsmBG96
  • GSM Modem Constructor
    • TinyGsmBG96(Stream& stream)
  • Basic functions (TinyGsmModem.tpp)
    • begin(const char* pin = nullptr)
    • init(const char* pin = nullptr)
    • sendAT(Args... cmd)
    • setBaud(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)
    • powerOff()
    • 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()
  • SIM card functions (TinyGsmGPRS.tpp)
    • simUnlock(const char* pin)
    • getSimCCID()
    • getIMEI()
    • getIMSI()
    • getSimStatus(uint32_t timeout_ms = 10000L)
  • GPRS functions (TinyGsmGPRS.tpp)
    • gprsConnect(const char* apn, const char* user = nullptr, const char* pwd = nullptr)
    • gprsDisconnect()
    • isGprsConnected()
    • getOperator()
    • getProvider()
  • 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)
  • SSL context functions
    • configureSSLContext(uint8_t context_id, SSLAuthMode sslAuthMode, SSLVersion sslVersion, const char* CAcertName, const char* clientCertName, const char* clientKeyName)
  • Phone call functions (TinyGsmCalling.tpp)
    • callAnswer()
    • callNumber(const String& number)
    • callHangup()
    • dtmfSend(char cmd, int duration_ms = 100)
  • Text messaging (SMS) functions (TinyGsmSMS.tpp)
    • sendUSSD(const String& code)
    • sendSMS(const String& number, const String& text)
    • sendSMS_UTF16(const char* const number, const void* text, size_t len)
  • GPS (GNSS, GLONASS) functions (TinyGsmGPS.tpp)
    • enableGPS()
    • disableGPS()
    • getGPSraw()
    • getGPS(float* lat, float* lon, float* speed = 0, float* alt = 0, int* vsat = 0, int* usat = 0, float* accuracy = 0, int* year = 0, int* month = 0, int* day = 0, int* hour = 0, int* minute = 0, int* second = 0)
    • getGPSTime(int* year, int* month, int* day, int* hour, int* minute, int* second)
  • 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)
    • getNetworkUTCTime(int* year, int* month, int* day, int* hour, int* minute, int* second, float* timezone)
    • getNetworkEpoch(TinyGSM_EpochStart epoch = TinyGSM_EpochStart::UNIX)
  • Battery functions (TinyGsmBattery.tpp)
    • getBattVoltage()
    • getBattPercent()
    • getBattChargeState()
    • getBattStats(int8_t& chargeState, int8_t& percent, int16_t& milliVolts)
  • Temperature functions (TinyGsmTemperature.tpp)
    • getTemperature()
  • Utilities (TinyGsmModem.tpp)
    • streamWrite(T last)
    • streamWrite(T head, Args... tail)
    • streamClear()
    • streamDump(int16_t expected_len)
• GsmClientBG96
  • 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)
• GsmClientSecureBG96
  • Client constructors and initialization
    • GsmClientSecureBG96()
    • GsmClientSecureBG96(TinyGsmBG96& modem, uint8_t mux = 0)
    • GsmClientSecureBG96(TinyGsmBG96& modem, SSLAuthMode sslAuthMode, SSLVersion sslVersion = SSLVersion::TLS1_2, const char* CAcertName = nullptr, const char* clientCertName = nullptr, const char* clientKeyName = nullptr)
    • GsmClientSecureBG96(TinyGsmBG96& modem, uint8_t mux, SSLAuthMode sslAuthMode, SSLVersion sslVersion = SSLVersion::TLS1_2, const char* CAcertName = nullptr, const char* clientCertName = nullptr, const char* clientKeyName = nullptr)
    • GsmClientSecureBG96(TinyGsmBG96& modem, const char* pskIdent, const char* psKey, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureBG96(TinyGsmBG96& modem, uint8_t mux, const char* pskIdent, const char* psKey, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureBG96(TinyGsmBG96& modem, const char* pskTableName, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureBG96(TinyGsmBG96& 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)

Classes

	Name
struct	TinyGsmBG96ModemConfig Basic modem configurations for Quectel BG96 and BG95.
struct	TinyGsmBG96TcpConfig TCP behavior and limits for Quectel BG96 and BG95.
class	TinyGsmBG96 Class for the Quectel BG96 and BG95.
class	TinyGsmBG96::GsmClientBG96 Inner client.
class	TinyGsmBG96::GsmClientSecureBG96 Inner secure client.

Types

	Name
enum class	BG96RegStatus { REG_NO_RESULT = -1, REG_UNREGISTERED = 0, REG_SEARCHING = 2, REG_DENIED = 3, REG_OK_HOME = 1, REG_OK_ROAMING = 5, REG_UNKNOWN = 4 } Registration status.

BG96RegStatus

Enumerator	Value	Description
REG_NO_RESULT	-1	No registration result.
REG_UNREGISTERED	0	Not registered on the network.
REG_SEARCHING	2	Searching for network.
REG_DENIED	3	Registration denied.
REG_OK_HOME	1	Registered on the home network.
REG_OK_ROAMING	5	Registered on a roaming network.
REG_UNKNOWN	4	Unknown registration status.

---

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