XBee Docs
  • Nav
Version
  • Welcome to XBee 3 BLU
  • Get started
    • Step 1 - Requirements
    • Step 2 - Set up the hardware
    • Step 3 - Install the software
    • Step 4 - Configure the XBees
    • Step 5 - Test your setup
    • Step 6 - Recap and solidify
    • Next steps
  • How XBees work
    • What is an XBee?
    • Hosted/hostless architecture
    • Operating mode
  • XBee 3 BLU use cases
    • XBee to phone/tablet communication
    • Beacon scanner
    • Beacon advertiser
    • GATT client and GATT server
    • Bluetooth mesh (NOT SUPPORTED)
    • Bluetooth audio (NOT SUPPORTED)
  • Manage the XBee 3 BLU
    • Change device settings
    • Update the firmware
    • Exchange data with the device over BLE
    • Manage the file system
    • Interact with the MicroPython REPL
    • Apply pre-defined setups
    • Recover the device
  • Application development
    • MicroPython application development
      • Set the MicroPython REPL operating mode
      • Interact with the MicroPython REPL
      • Develop a MicroPython application
    • Host application development
    • Bluetooth application development
  • Bluetooth
    • Bluetooth in XBee devices
    • Configure the BLE interface
    • BLE reference
  • Power management
    • Pin Sleep
    • MicroPython Sleep
    • Bluetooth transmit power
  • Security
    • Bluetooth security
  • API frames
    • User Data Relay frames
    • API frames reference
      • Local AT Command Request - 0x08
      • Queue Local AT Command Request - 0x09
      • Explicit Addressing Command Request - 0x11
      • BLE Unlock Request - 0x2C
      • User Data Relay Input - 0x2D
      • Bluetooth Gap Scan Request - 0x34
      • Local AT Command Response - 0x88
      • Transmit Status - 0x89
      • Modem Status - 0x8A
      • Extended Transmit Status - 0x8B
      • Explicit Receive Indicator - 0x91
      • User Data Relay Output - 0xAD
      • Bluetooth GAP Scan Legacy Advertisement Response - 0xB4
      • Bluetooth GAP Scan Status - 0xB5
      • Bluetooth GAP Scan Extended Advertisement Response - 0xB7
      • BLE Unlock Response - 0xAC
  • AT commands
    • AT commands reference
      • Bluetooth Low Energy (BLE) commands
        • BT (Bluetooth Enable)
        • BL (Bluetooth Address)
        • BI (Bluetooth Identifier)
        • BP (Bluetooth Power)
        • GS (GAP Scan)
        • DG (GAP Scan Duration)
        • WG (GAP Scan Window)
        • IG (GAP Scan Interval)
        • FG (Advertisement Data Filter)
        • $S (SRP Salt)
        • $V, $W, $X, $Y commands (SRP Salt verifier)
      • MicroPython commands
        • PS (Python Startup)
      • Sleep settings commands
        • SM (Sleep Mode)
      • API configuration commmands
        • AP (API Enable)
        • AO (API Options)
        • NP (Maximum Packet Payload Bytes)
      • UART interface commands
        • BD (UART Baud Rate)
        • NB (Parity)
        • SB (Stop Bits)
        • FT (Flow Control Threshold)
      • AT Command options
        • CC (Command Character)
        • CT (Command Mode Timeout)
        • GT (Guard Time)
        • CN (Exit Command mode)
      • UART pin configuration commands
        • D6 (DIO6/RTS Configuration)
        • D7 (DIO7/CTS Configuration)
        • P3 (DIO13/UART_DOUT Configuration)
        • P4 (DIO14/UART_DIN Configuration)
      • SMT/MMT SPI interface commands
        • P5 (DIO15/SPI_MISO Configuration)
        • P6 (DIO16/SPI_MOSI Configuration)
        • P7 (DIO17/SPI_SSEL Configuration)
        • P8 (DIO18/SPI_CLK Configuration)
        • P9 (DIO19/SPI_ATTN Configuration)
      • I/O settings commands
        • D0 (DIO0/ADC0/Commissioning Configuration)
        • D1 (DIO1/ADC1/TH_SPI_ATTN Configuration)
        • D2 (DIO2/ADC2/TH_SPI_CLK Configuration)
        • D3 (DIO3/ADC3/TH_SPI_SSEL Configuration)
        • D4 (DIO4/TH_SPI_MOSI Configuration)
        • D5 (DIO5/Associate Configuration)
        • D8 (DIO8/DTR/SLP_Request Configuration)
        • D9 (DIO9/ON_SLEEP Configuration)
        • P2 (DIO12/TH_SPI_MISO Configuration)
        • PR (Pull-up/Down Resistor Enable)
        • PD (Pull Up/Down Direction)
        • LT (Associate LED Blink Time)
        • AV (Analog Voltage Reference)
      • Location commands
        • LX (Location X—Latitude)
        • LY (Location Y—Longitude)
        • LZ (Location Z—Elevation)
      • File System commands
        • FS (File System)
      • Diagnostic commands
        • NI (Network Identifier)
        • DD (Device Type Identifier)
        • SH (Serial Number High)
        • SL (Serial Number Low)
        • VR (Firmware Version)
        • VH (Bootloader Version)
        • HV (Hardware Version)
        • %C (Hardware/Software Compatibility)
        • %V (Supply Voltage)
        • TP (Temperature)
        • CK (Configuration CRC)
        • D% (Manufacturing Date)
      • Memory access commands
        • FR (Software Reset)
        • AC (Apply Changes)
        • WR (Write)
        • RE (Restore Defaults)
      • Custom default commands
        • %F (Set Custom Default)
        • !C (Clear Custom Defaults)
        • R1 (Restore Factory Defaults)
  • Advanced topics
    • I/O support
    • Storage
      • File system
      • GPM
        • Possible errors returned from GPM commands
        • Update the firmware over-the-air
  • Hardware
    • Device pinout
    • Wired communication
      • UART
      • SPI
    • Reference manuals
    • Design files
    • Safety instructions
      • Safety instructions
      • Инструкции за безопасност
      • Sigurnosne upute
      • Bezpečnostní instrukce
      • Sikkerhedsinstruktioner
      • Veiligheidsinstructies
      • Ohutusjuhised
      • Turvallisuusohjeet
      • Consignes de sécurité
      • Sicherheitshinweise
      • Οδηγίες ασφαλείας
      • Biztonsági utasítások
      • Istruzioni di sicurezza
      • Drošības instrukcijas
      • Saugos instrukcijos
      • Sikkerhetsinstruksjoner
      • Instrukcje bezpieczeństwa
      • Instruções de segurança
      • Instructiuni de siguranta
      • Bezpečnostné inštrukcie
      • Varnostna navodila
      • Instrucciones de seguridad
      • Säkerhets instruktioner
Version
  • Welcome to XBee 3 BLU
  • Get started
    • Step 1 - Requirements
    • Step 2 - Set up the hardware
    • Step 3 - Install the software
    • Step 4 - Configure the XBees
    • Step 5 - Test your setup
    • Step 6 - Recap and solidify
    • Next steps
  • How XBees work
    • What is an XBee?
    • Hosted/hostless architecture
    • Operating mode
  • XBee 3 BLU use cases
    • XBee to phone/tablet communication
    • Beacon scanner
    • Beacon advertiser
    • GATT client and GATT server
    • Bluetooth mesh (NOT SUPPORTED)
    • Bluetooth audio (NOT SUPPORTED)
  • Manage the XBee 3 BLU
    • Change device settings
    • Update the firmware
    • Exchange data with the device over BLE
    • Manage the file system
    • Interact with the MicroPython REPL
    • Apply pre-defined setups
    • Recover the device
  • Application development
    • MicroPython application development
      • Set the MicroPython REPL operating mode
      • Interact with the MicroPython REPL
      • Develop a MicroPython application
    • Host application development
    • Bluetooth application development
  • Bluetooth
    • Bluetooth in XBee devices
    • Configure the BLE interface
    • BLE reference
  • Power management
    • Pin Sleep
    • MicroPython Sleep
    • Bluetooth transmit power
  • Security
    • Bluetooth security
  • API frames
    • User Data Relay frames
    • API frames reference
      • Local AT Command Request - 0x08
      • Queue Local AT Command Request - 0x09
      • Explicit Addressing Command Request - 0x11
      • BLE Unlock Request - 0x2C
      • User Data Relay Input - 0x2D
      • Bluetooth Gap Scan Request - 0x34
      • Local AT Command Response - 0x88
      • Transmit Status - 0x89
      • Modem Status - 0x8A
      • Extended Transmit Status - 0x8B
      • Explicit Receive Indicator - 0x91
      • User Data Relay Output - 0xAD
      • Bluetooth GAP Scan Legacy Advertisement Response - 0xB4
      • Bluetooth GAP Scan Status - 0xB5
      • Bluetooth GAP Scan Extended Advertisement Response - 0xB7
      • BLE Unlock Response - 0xAC
  • AT commands
    • AT commands reference
      • Bluetooth Low Energy (BLE) commands
        • BT (Bluetooth Enable)
        • BL (Bluetooth Address)
        • BI (Bluetooth Identifier)
        • BP (Bluetooth Power)
        • GS (GAP Scan)
        • DG (GAP Scan Duration)
        • WG (GAP Scan Window)
        • IG (GAP Scan Interval)
        • FG (Advertisement Data Filter)
        • $S (SRP Salt)
        • $V, $W, $X, $Y commands (SRP Salt verifier)
      • MicroPython commands
        • PS (Python Startup)
      • Sleep settings commands
        • SM (Sleep Mode)
      • API configuration commmands
        • AP (API Enable)
        • AO (API Options)
        • NP (Maximum Packet Payload Bytes)
      • UART interface commands
        • BD (UART Baud Rate)
        • NB (Parity)
        • SB (Stop Bits)
        • FT (Flow Control Threshold)
      • AT Command options
        • CC (Command Character)
        • CT (Command Mode Timeout)
        • GT (Guard Time)
        • CN (Exit Command mode)
      • UART pin configuration commands
        • D6 (DIO6/RTS Configuration)
        • D7 (DIO7/CTS Configuration)
        • P3 (DIO13/UART_DOUT Configuration)
        • P4 (DIO14/UART_DIN Configuration)
      • SMT/MMT SPI interface commands
        • P5 (DIO15/SPI_MISO Configuration)
        • P6 (DIO16/SPI_MOSI Configuration)
        • P7 (DIO17/SPI_SSEL Configuration)
        • P8 (DIO18/SPI_CLK Configuration)
        • P9 (DIO19/SPI_ATTN Configuration)
      • I/O settings commands
        • D0 (DIO0/ADC0/Commissioning Configuration)
        • D1 (DIO1/ADC1/TH_SPI_ATTN Configuration)
        • D2 (DIO2/ADC2/TH_SPI_CLK Configuration)
        • D3 (DIO3/ADC3/TH_SPI_SSEL Configuration)
        • D4 (DIO4/TH_SPI_MOSI Configuration)
        • D5 (DIO5/Associate Configuration)
        • D8 (DIO8/DTR/SLP_Request Configuration)
        • D9 (DIO9/ON_SLEEP Configuration)
        • P2 (DIO12/TH_SPI_MISO Configuration)
        • PR (Pull-up/Down Resistor Enable)
        • PD (Pull Up/Down Direction)
        • LT (Associate LED Blink Time)
        • AV (Analog Voltage Reference)
      • Location commands
        • LX (Location X—Latitude)
        • LY (Location Y—Longitude)
        • LZ (Location Z—Elevation)
      • File System commands
        • FS (File System)
      • Diagnostic commands
        • NI (Network Identifier)
        • DD (Device Type Identifier)
        • SH (Serial Number High)
        • SL (Serial Number Low)
        • VR (Firmware Version)
        • VH (Bootloader Version)
        • HV (Hardware Version)
        • %C (Hardware/Software Compatibility)
        • %V (Supply Voltage)
        • TP (Temperature)
        • CK (Configuration CRC)
        • D% (Manufacturing Date)
      • Memory access commands
        • FR (Software Reset)
        • AC (Apply Changes)
        • WR (Write)
        • RE (Restore Defaults)
      • Custom default commands
        • %F (Set Custom Default)
        • !C (Clear Custom Defaults)
        • R1 (Restore Factory Defaults)
  • Advanced topics
    • I/O support
    • Storage
      • File system
      • GPM
        • Possible errors returned from GPM commands
        • Update the firmware over-the-air
  • Hardware
    • Device pinout
    • Wired communication
      • UART
      • SPI
    • Reference manuals
    • Design files
    • Safety instructions
      • Safety instructions
      • Инструкции за безопасност
      • Sigurnosne upute
      • Bezpečnostní instrukce
      • Sikkerhedsinstruktioner
      • Veiligheidsinstructies
      • Ohutusjuhised
      • Turvallisuusohjeet
      • Consignes de sécurité
      • Sicherheitshinweise
      • Οδηγίες ασφαλείας
      • Biztonsági utasítások
      • Istruzioni di sicurezza
      • Drošības instrukcijas
      • Saugos instrukcijos
      • Sikkerhetsinstruksjoner
      • Instrukcje bezpieczeństwa
      • Instruções de segurança
      • Instructiuni de siguranta
      • Bezpečnostné inštrukcie
      • Varnostna navodila
      • Instrucciones de seguridad
      • Säkerhets instruktioner

API frames reference

  • Local AT Command Request - 0x08

  • Queue Local AT Command Request - 0x09

  • Explicit Addressing Command Request - 0x11

  • BLE Unlock Request - 0x2C

  • User Data Relay Input - 0x2D

  • Bluetooth Gap Scan Request - 0x34

  • Local AT Command Response - 0x88

  • Transmit Status - 0x89

  • Modem Status - 0x8A

  • Extended Transmit Status - 0x8B

  • Explicit Receive Indicator - 0x91

  • User Data Relay Output - 0xAD

  • Bluetooth GAP Scan Legacy Advertisement Response - 0xB4

  • Bluetooth GAP Scan Status - 0xB5

  • Bluetooth GAP Scan Extended Advertisement Response - 0xB7

  • BLE Unlock Response - 0xAC

API frames reference:

Scroll to top of page
Product page More documentation Official site About Digi Contact us Support
©2024 Digi International Inc. All rights reserved.
Digi International Inc.