unirtos-vfs-demos

中文 | English

This repository is recommended to be used through the unirtos-cli demo workflow to ensure consistency in project creation, environment setup, and build procedures.

Feature Description

This demo demonstrates the basic usage of virtual file system (VFS) capabilities and is suitable as a reference for file read/write application development.

• Demonstrates file system access and basic file operation workflow
• Provides validation examples for common read/write paths
• Makes it easy to extend directory management, exception handling, and storage adaptation 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 the above tools are installed, confirm that the following commands are available:

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

2. Fetch the Demo Using unirtos-cli

First, check the available demos and versions:

unirtos-cli ls-demos

Create this demo project:

unirtos-cli new -r unirtos-vfs-demos

To specify a version:

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

3. Enter the Project and Build

cd unirtos-vfs-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, scope of impact, 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.