Welcome to Atmosic OpenAir Documentation
SDK Release Documentation
OpenAir Latest SDK Release
Current Release: Latest development version
Key Features:
Latest features and improvements
Most up-to-date documentation
Root-level documentation sources
Recommended for new projects
Getting Started
Development Guide
- Advanced Build and Flash
- West Build and Flash
- Sysbuild and Flash
- Overview
- Building with Sysbuild
- Flashing with Sysbuild
- Subpages
- Atmosic Sysbuild Options
- Table of Contents
- Basic Structure
- Common Configuration Options
- Atmosic-Specific Configurations
- MCUboot Configurations
- TrustZone Configurations
- DFU and OTA Configurations
- Channel Sounding (CS) Configurations
- XIP (Execute-in-Place) Configurations
- ATM Archive Generation
- Complete Examples
- Building with Sample.yaml
- Atmosic Sysbuild Options
- Configuration Options
- MCUboot and Secure Boot
- Secure Debug
- SPE/NSPE Architecture and Advanced Build Options
- Atmosic BLE Stack
- GPIO Pin Assignment
- Partition Layout
- Peripheral Devices
- DFU Update
- AT Command Set
- AT Command Set — Subsystem Reference
- Overview
- Role-Based Command Bundles
CONFIG_AT_CMD_PERIPHERAL— Peripheral / advertiser roleCONFIG_AT_CMD_CENTRAL— Central / observer roleCONFIG_AT_CMD_GATT_DFT_SERVER— Default GATT server (auto-selected byCONFIG_AT_CMD_PERIPHERAL)CONFIG_AT_CMD_GATT_CLIENT— GATT client (auto-selected byCONFIG_AT_CMD_CENTRAL)- Connection commands — enabled automatically when
CONFIG_PERIPHERALorCONFIG_CENTRALis selected CONFIG_AT_CMD_TAG_SET— Tracking tag role
- Command Groups
- Role-Based Command Bundles
- Typical Two-Device Flow
- Kconfig Summary
- Overview
- AT Command Format
- System Commands
- AT+SYSFUNCPIN — GPIO Function Pin Control
- AT+SYSPM — System Power Mode
- AT+SYSUARTBR — UART Baud Rate
- AT+SYSUARTFC — UART Flow Control
- System Command Error Codes
- AT+SYSBDADDR — Bluetooth Device Address
- AT+SYSRESET — System Reset
- AT+SYSLOCK — Channel Lock
- AT+SYSUNLOCK — Channel Unlock
- AT+SYSSTORAGE — NVS Key-Value Storage
- AT+SYSUARTRAW — Bounded UART/BLE Raw Data Transfer
- Serial DFU Commands
- BLE Peripheral Commands
- AT+BLEGAPDEVNAME — GAP Device Name
- AT+BLEADVENABLE — Start / Stop Advertising
- AT+BLEADVSETID — Assign BT Identity to Advertising Instance
- AT+BLEADVLEGACYPARM — Legacy Advertising Parameters
- AT+BLEEXTADVPARM — Extended Advertising Parameters
- AT+BLEADVDATA — Set Advertisement Payload
- AT+BLESCANRSPDATA — Set Scan-Response Payload
- AT+BLEADVTXPWR — Advertising TX Power
- BLE Central Commands
- BLE Common Commands
- BLE Events
- BLE GATT Server Commands
- BLE GATT Default Server Commands
- sec_prop Reference
- Default Attribute Layout
- AT+BLEGATTDFTSERVER — Enable / Disable Default GATT Server
- AT+BLEGATTDFTSERVICE — Default Service Configuration
- AT+BLEGATTDFTCHAR1 — Characteristic 1 (TRX) Configuration
- AT+BLEGATTDFTCHAR2 — Characteristic 2 (TRX2) Configuration
- AT+BLEGATTDFTCHAR1VAL — Characteristic 1 Pre-set Read Value
- AT+BLEGATTDFTCHAR2VAL — Characteristic 2 Pre-set Read Value
- AT+BLEGATTTOBLE — Send Notification / Indication
- BLE GATT Dynamic Server Commands
- Basic Workflow
- Typical Dynamic GATT Workflow
- Events
- Troubleshooting
- BLE GATT Client Commands
- Tag Commands and Events
- Command Dependencies
- AT+TAGINFO — Tag Information
- AT+TAGMODE — Tag Mode Select / Query
- AT+TAGBATTERY — Battery Level
- AT+TAGSTART — Start Tag BLE Stack
- AT+TAGRESET — Reboot / Factory Reset
- AT+TAGSTFIND — STF Button Simulation
- AT+TAGFMNASN — FMNA Serial Number Lookup
- AT+TAGFMNAMFI — FMNA MFI Token Log
- AT+TAGCSUNPAIR — Channel Sounding Unpair
- AT+TAGGFPIND — GFP Button Simulation
- AT+TAGMOTIONRPT — Host Motion Acceleration Report
- +EVTTAGSTATE — Tag State
- +EVTTAGERROR — Tag Error
- +EVTTAGGFPREVERSERING — GFP Reverse Ringing Status
- +EVTTAGBUZZER — Tag Buzzer Action
- +EVTTAGMOTIONCTL — Motion Sensor Control Event
- AT+TAGADDR — Query Advertising BT Address
- Tag AT Command Error Codes
- Implementation Notes
- Command Dependencies
- Error Code Reference
- AT Command Set — Subsystem Reference
- Samples
- Bluetooth: atm_beacon
- ATM BLE Central and Peripheral Sample
- Bluetooth: beacon
- Bluetooth: broadcaster
- Bluetooth: broadcaster_multiple
- Bluetooth: Central HR
- Bluetooth: Central Multilink
- Bluetooth: DTM 2-wire
- Bluetooth: extended_adv_advertiser
- Bluetooth: extended_adv_scanner
- Bluetooth: hci_uart
- Bluetooth: hci_vendor
- Bluetooth: High Duty Cycle Directed Advertising
- Bluetooth: observer
- Bluetooth: periodic advertising
- Bluetooth: periodic_adv_conn
- Bluetooth: Periodic Advertising with Responses (PAwR) Advertiser
- Bluetooth: Periodic Sync
- Bluetooth: Periodic Advertising Connection Procedure (Responder)
- Bluetooth: Periodic Advertising with Responses (PAwR) Synchronization
- Bluetooth: peripheral
- Bluetooth: peripheral_accept_list
- Bluetooth: Peripheral DIS
- Bluetooth: Peripheral HR
- Bluetooth: Peripheral Identity
- Bluetooth: Scan & Advertise
- Drivers: i2s_output
- Drivers: uart_passthrough
- Basic: Hello World
- Basic: Minimal
- Basic: NSC Hello World
- Basic: spe
- Sensor: adt7420
- Sensor: bme280
- Sensor: lis2dh
- Subsys: AT Command Set
- Subsys: mgmt_mcumgr_smp_svr
- Subsys: settings
- Sysbuild: hello_world
- Atmosic Applications
- Channel Sounding: Initiator with Ranging Requester
- Channel Sounding: Reflector with Ranging Responder
- Multimode Consumer Tag
- Overview
- AT Command Interface
- Requirements
- Device State Transitions
- Buttons and user actions (Summary)
- Build items (targets)
- 1) Default triple-mode (FMNA + FHN + STF)
- 2) Google only (FHN)
- 3) Apple only (FMNA)
- 4) Samsung only (STF, minimal)
- 5) Dual-mode: Google + Apple
- 6) Dual-mode: Samsung + Apple
- 7) Dual-mode: Samsung + Google
- 8) Google only (FHN) with MCUboot + OTA
- 9) Apple only (FMNA) with MCUboot + UARP
- 10) Samsung only (STF, minimal) with MCUboot + Native Firmware Update Only
- 11) Samsung only (STF) with MCUboot + OTA
- 12) Dual-mode: Google + Apple with MCUboot + Flash XIP (swap-using-offset) with OTA
- 13) Dual-mode: Samsung + Apple with MCUboot + Flash XIP (swap-using-offset) with OTA
- 14) Dual-mode: Samsung + Google with MCUboot + Flash XIP (swap-using-offset) with OTA
- 15) MCUboot + Flash XIP (triple-mode) with OTA
- 16) MCUboot + Flash XIP (overwrite-only) with OTA
- 17) MCUboot + Flash XIP (legacy scratch) with OTA
- 18) Dual-mode (FHN + FMNA) Channel Sounding demo
- 19) Dual-mode (FHN + FMNA) Channel Sounding demo with MCUboot + OTA
- 20) Dual-mode (FHN + FMNA) with Precision Finding, Flash XIP, UARP + OTA
- 21) Dual-mode v2 (FHN + FMNA) with Precision Finding, Flash XIP, UARP + OTA
- 22) Google only (FHN) with Ranging OOB Data Element (Precision Finding)
- Storage Size Configuration
- Google Find Hub Network (FHN) details
- Apple Find My Network Accessory (FMNA) details
- Samsung SmartThings Find (STF) details
- Sensor Beacon Application
- ATM BLE Throughput Central Test Application
- Overview
- Features
- Hardware Requirements
- Building and Running
- Configuration
- Custom Shell Commands
start_testack <on|off>set_phy <1M|2M|CODED_S2|CODED_S8>set_conn_interval <interval>set_payload_size <size>show_payload_sizeset_packet_count <count>show_packet_countset_tx_power <power>(Atmosic Vendor Command)show_tx_powershow_tx_power_infoset_test_direction <direction>show_test_direction
- Usage
- ATM BLE Throughput Peripheral Test Application
- ATMBTCSTAG-IOT-3405 Applications
- Flash XIP with Split Images
- Low Power Design and Energy Harvesting
- Power Management Unit
- Energy Harvesting and Charging
- Energy Harvesting Meter
- Batteryless Operation
- Hardware and Software Requirements
- Battery model Kconfig options
- Battery monitoring for VBATLI
- Enable VBATLI for ATM33/ATM34
- Enable VBATLI for ATM33e/ATM34e
- Modify Brownout Levels (ATM34)
- Example configuration for energy harvesting
- IDE
- Debugging
- Tools
- Atmosic Archive Tool
- Atmosic Secure Journal Tool
- Atmosic OTP Tool
- Atmosic Zephyr Settings Generator (ZSG) Tool
- Atmosic Dump Tool
- Atmosic Side-Load Key (SLKEY) Tool
- FAQ
Quick start guide for new users
Overview of the Atmosic OpenAir SDK
SDK structure and evaluation kit information
Advanced building and flashing techniques
Debugging tools and techniques
Device Firmware Update procedures
UART AT command reference for BLE and tag control
Frequently asked questions
Flash partitioning and XIP configuration
GPIO configuration and pin assignments
Integrated development environment setup
Power optimization and energy harvesting
Memory partition configuration
Peripheral device drivers and usage
Code samples and examples
Secure and non-secure processing environments
Development tools and utilities