MCUXpresso SDK Documentation

Version: 26.03.00-pvw1 25.12.00 25.12.00-pvw2 25.12.00-pvw1 25.09.00 latest

Open on Repo Open an Issue

Source (.md/.rst) Page PDF (.pdf)

Bluetooth Low Energy Application Developer’s Guide

Table of Contents

• Introduction
• Prerequisites
  • Task and event queues
  • GATT database
  • Non-Volatile Memory (NVM) access
    • Note:
• Bluetooth LE Host Stack Initialization and APIs
  • Initialization
  • Main function to initialize the Bluetooth LE Host Stack
  • HCI entry and exit points
  • Bluetooth LE Host Stack libraries and API availability
  • Synchronous and asynchronous functions
  • Radio TX Power level
• Generic Access Profile (GAP) Layer
  • Peripheral setup
    • Advertising
    • Pairing and bonding (peripheral)
  • Central setup
    • Scanning
    • Initiating and closing a connection
    • Pairing and bonding (Central)
  • LE data packet length extension
  • Privacy feature
    • Introduction
      • Resolvable private addresses
      • Non-resolvable private addresses
      • Multiple identity resolving keys
    • Host privacy
    • Controller privacy
      • Privacy mode
      • Scanning and initiating
      • Advertising
      • Connected
  • Setting PHY mode in a connection
  • Data management of bonded devices
    • Application removal of bonded devices data
  • Controller enhanced notifications
  • Extended advertising
    • Peripheral setup
    • Central setup
  • Periodic Advertising
    • Peripheral Setup
    • Central Setup
  • Periodic Advertising with Responses (PAwR)
    • Central Setup
    • Peripheral Setup
  • Encrypted Advertising Data
    • Central Setup
    • Peripheral Setup
  • L2CAP credit-based channels
  • Enhanced ATT
    • EATT Credits management
    • EATT Connection establishment
    • EATT Bearer reconfiguration
    • EATT Bearer disconnection
• Generic Attribute Profile (GATT) Layer
  • Client APIs
    • Installing client callbacks
      • Client procedure callback
      • Notification and indication callbacks
    • MTU exchange
    • Service and characteristic discovery
      • Discover all primary services
      • Discover primary services by UUID
      • Discover included services
      • Discover all characteristics of a service
      • Discover characteristics by UUID
      • Discover characteristic descriptors
    • Reading and writing characteristics
      • Characteristic value read procedure
      • Characteristic read by UUID procedure
      • Characteristic read multiple procedure
      • Characteristic write procedure
    • Reading and writing characteristic descriptors
    • Resetting procedures
  • Server APIs
    • Server callback
    • Sending notifications and indications
    • Attribute write notifications
• GATT database application interface
  • Writing and reading attributes
  • Finding attribute handles
• Creating GATT database
  • Creating static GATT database
    • Declaring custom 128-bit UUIDs
    • Declaring a service
      • Service declaration macros
      • Include declaration macros
    • Declaring a characteristic
      • Characteristic declaration macros
      • Declaring characteristic values
      • Declaring characteristic descriptors
    • Static GATT database definition examples
  • Creating a GATT database dynamically
    • Memory considerations
    • Initialization and release
    • Adding services
    • Adding characteristics and descriptors
    • Removing services and characteristics
  • Gatt caching
    • Service change feature
    • Robust caching
• Creating a Custom Profile
  • Defining custom UUIDs
  • Creating service functionality
  • GATT client interactions
• Application Structure
  • Folder structure
  • Application main framework
    • Start task
    • Application messaging
  • Bluetooth LE Connection Manager
    • GAP generic event
    • GAP configuration
    • GAP connection event
    • Privacy
  • GATT database
  • RTOS specifics
    • Operating system selection
    • Bluetooth LE Host task configuration
  • Board configuration
  • Bluetooth Low Energy initialization
  • Bluetooth Low Energy Host Stack configuration
  • Profile configuration
    • Application code
  • Multiple connections
  • Bluetooth address generation
  • Repeated attempts
  • Advanced Secure Mode
    • Additional considerations
• Low-Power Management
  • System considerations
  • When/how to enter low power
• Over the Air Programming (OTAP)
  • General functionality
  • Bluetooth Low Energy OTAP service-profile
    • OTAP service and characteristics
    • OTAP server and OTAP client interactions
  • Bluetooth LE OTAP protocol
    • Protocol design considerations
    • Bluetooth Low Energy OTAP commands
      • New image notification command
      • New image info request command
      • New image info response command
      • Image block request command
      • Image chunk command
      • Image transfer complete command
      • Error notification command
      • Stop image transfer command
    • OTAP client–server interactions
  • Bluetooth Low Energy OTAP image file format
    • Bluetooth Low Energy OTAP header
      • Upgrade file identifier
      • Header version
      • Header length
      • Header field control
      • Company identifier
      • Image ID
      • Image version
      • Header string
      • Total image file size
  • Building Bluetooth Low Energy OTAP image file from SREC file
  • Building Bluetooth Low Energy OTAP image file from BIN file
  • Bluetooth Low Energy OTAP application integration
    • OTAP server
    • OTAP client
  • Secured OTAP
• Creating a Bluetooth LE application when the Host Stack runs on another processor
  • Serial manager and FSCI configuration
    • Serial manager initialization
    • FSCI configuration and initialization
    • FSCI handlers (GAP, GATT, and GATTDB) registration
  • Bluetooth Low Energy Host Stack initialization
  • GATT database configuration
  • FSCI host layer
• Intrusion Detection System
  • Overview
  • Event Types
    • Pairing-Related Events
    • Connection-Related Events
    • Application-Related Events
  • Usage Example
• References
• Acronyms and abbreviations
• Note about the source code in the document
• Revision history
• Legal information