group__digi__xbee

---

title: Digi XBee and XBee3 cellular and WiFi modules

Digi XBee and XBee3 cellular and WiFi modules (group)

Module: Supported Modules / Digi / Digi XBee and XBee3 cellular and WiFi modules

Manufacturer: Digi. Models: XBee and XBee3 cellular and WiFi modules.

Connection Information

• Combined TCP/SSL sockets:
  • 1
  • The much more complicated (and unsupported) API mode is needed for multiplexing.
• Socket Buffering:
  • The modem does not have an internal buffer for incoming data.
  • You must set the buffer size in this library to be larger than your largest expected incoming packet, or you will lose incoming data.
• Socket Numbering:
  • Only one socket is available in transparent/command mode, and it is always channel 0.
  • The mux argument on the client constructor and init() is ignored. Todo: todo

Supported Public Functions

• TinyGsmXBee
  • GSM Modem Constructor
    • TinyGsmXBee(Stream& stream)
    • TinyGsmXBee(Stream& stream, int8_t resetPin)
  • 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()
  • WiFi functions (TinyGsmWifi.tpp)
    • networkConnect(const char* ssid, const char* pwd)
    • networkDisconnect()
  • Socket listening functions (TinyGsmTCP.tpp)
    • maintain()
  • Text messaging (SMS) functions (TinyGsmSMS.tpp)
    • sendSMS(const String& number, const String& text)
    • sendSMS_UTF16(const char* const number, const void* text, size_t len)
  • Battery functions (TinyGsmBattery.tpp)
    • getBattVoltage()
    • 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)
  • Utilities
    • streamClear(void)
  • XBee identifier functions
    • getBeeType()
    • getBeeName()
    • getSeries(void)
  • XBee specific utilities
    • commandMode(uint8_t retries = 5)
    • writeChanges(void)
    • exitCommand(void)
    • exitAndFail(void)
    • readResponseString(uint32_t timeout_ms = 1000)
    • readResponseInt(uint32_t timeout = 1000L)
    • sendATGetString(GsmConstStr cmd)
    • changeSettingIfNeeded(GsmConstStr cmd, int16_t newValue, uint32_t timeout_ms = 1000L)
    • changeSettingIfNeeded(GsmConstStr cmd, String newValue, uint32_t timeout_ms = 1000L)
    • gotIPforSavedHost()
• GsmClientXBee
  • Arduino Client interface (TinyGsmTCP.tpp)
    • stop()
  • Extended Client API (TinyGsmTCP.tpp)
    • remoteIP()
    • getMux()
    • getConnectionID()
    • beginWrite(uint16_t size)
    • endWrite(uint16_t expected_size = 0)
• GsmClientSecureXBee
  • Client constructors and initialization
    • GsmClientSecureXBee()
    • GsmClientSecureXBee(TinyGsmXBee& modem, uint8_t mux = 0)
    • GsmClientSecureXBee(TinyGsmXBee& modem, SSLAuthMode sslAuthMode, SSLVersion sslVersion = SSLVersion::TLS1_2, const char* CAcertName = nullptr, const char* clientCertName = nullptr, const char* clientKeyName = nullptr)
    • GsmClientSecureXBee(TinyGsmXBee& modem, uint8_t mux, SSLAuthMode sslAuthMode, SSLVersion sslVersion = SSLVersion::TLS1_2, const char* CAcertName = nullptr, const char* clientCertName = nullptr, const char* clientKeyName = nullptr)
    • GsmClientSecureXBee(TinyGsmXBee& modem, const char* pskIdent, const char* psKey, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureXBee(TinyGsmXBee& modem, uint8_t mux, const char* pskIdent, const char* psKey, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureXBee(TinyGsmXBee& modem, const char* pskTableName, SSLVersion sslVersion = SSLVersion::TLS1_2)
    • GsmClientSecureXBee(TinyGsmXBee& 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)
  • 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)
  • Arduino Client interface (TinyGsmTCP.tpp)
    • stop()
  • 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)
    • remoteIP()
    • getMux()
    • getConnectionID()
    • beginWrite(uint16_t size)
    • endWrite(uint16_t expected_size = 0)

Classes

	Name
struct	TinyGsmXBeeModemConfig Basic modem configurations for the Digi XBee and XBee3.
struct	TinyGsmXBeeTcpConfig TCP behavior and limits for the Digi XBee and XBee3.
class	TinyGsmXBee Class for the Digi XBee family of modems.
class	TinyGsmXBee::GsmClientXBee Inner client.
class	TinyGsmXBee::GsmClientSecureXBee Inner secure client.

Types

	Name
enum class	XBeeRegStatus { REG_OK = 0, REG_UNREGISTERED = 1, REG_SEARCHING = 2, REG_DENIED = 3, REG_UNKNOWN = 4 } Registration status.
enum class	XBeeType { XBEE_UNKNOWN = 0, XBEE_S6B_WIFI = 0x601, XBEE_LTE1_VZN = 0xB01, XBEE_3G = 0xB02, XBEE3_LTE1_ATT = 0xB06, XBEE3_LTEM_ATT = 0xB08, XBEE3_LTEM3 = 0xB0E } The known types of XBees The values are responses to the HS command to get "hardware series".

XBeeRegStatus

Enumerator	Value	Description
REG_OK	0	Registered on the network.
REG_UNREGISTERED	1	Not registered on the network.
REG_SEARCHING	2	Searching for network.
REG_DENIED	3	Registration denied.
REG_UNKNOWN	4	Unknown registration status.

XBeeType

Enumerator	Value	Description
XBEE_UNKNOWN	0	Unknown XBee type.
XBEE_S6B_WIFI	0x601	Digi XBee Wi-Fi.
XBEE_LTE1_VZN	0xB01	Digi XBee Cellular LTE Cat 1.
XBEE_3G	0xB02	Digi XBee Cellular 3G.
XBEE3_LTE1_ATT	0xB06	Digi XBee3 Cellular LTE CAT 1.
XBEE3_LTEM_ATT	0xB08	Digi XBee3 Cellular LTE-M.
XBEE3_LTEM3	0xB0E	Digi XBee3 Cellular LTE-M3.

---

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