unirtos-at-demos

中文 | English

This repository is recommended to be used via the unirtos-cli demo workflow to ensure a consistent process for project creation, environment setup, and compilation.

Feature Description

This demo demonstrates the basic development workflow for AT command extension, and is suitable as a beginner example for command parsing, interactive callbacks, and transparent transmission mode development.

• Demonstrates the registration flow for custom AT commands and unified entry initialization
• Provides three typical command examples: +QEXAMPLEHELLO, +QEXAMPLEEDIT, and +QEXAMPLERAW
• Covers the key handling paths for normal commands, edit mode, and transparent transmission mode
• Easy to extend with parameter validation, service dispatching, serial transparent transmission, and exception recovery logic

Quick Start

1. Install the UniRTOS Toolchain

• Development Preparation
• Install the Cross-Compilation Toolchain
• Install Python3
• Install git
• Install unirtos-cli: pip install unirtos-cli

After installing the tools above, verify that the following commands are available:

python --version # Python3
git --version
unirtos --version # 1.0.5 or later
unirtos-cli version # 1.0.11 or later

2. Fetch the Demo with unirtos-cli

First, check the available demos and versions:

unirtos-cli ls-demos

Create this demo project:

unirtos-cli new -r unirtos-at-demos

To specify a version:

unirtos-cli new -r unirtos-at-demos -v 1.0.0

3. Enter the Project and Build

cd unirtos-at-demos-1.0.0
unirtos-cli env-setup
unirtos-cli build

Common Commands

# Open the SDK menu configuration
unirtos-cli menuconfig

# Clean build artifacts
unirtos-cli clean

Technical Community

Technical Community: https://forumschinese.quectel.com/c/66-category/66

Contribution Guide

Contributions are welcome. It is recommended to submit changes in the following way:

• Run a basic verification before submission: env-setup, build, clean.
• Use clear commit messages describing the purpose of the change, affected scope, and verification results.
• When adding new features or changing behavior, update the README and related documentation accordingly.
• Submit bug fixes and feature improvements through Issues or Pull Requests.