docs: openvela 开发者文档

Fetch the repository succeeded.

Scan WeChat QR to Pay

Cancel

Complete

richgiteeai

Watch

Unwatch Watching Releases Only Ignoring

18 Star 92 Fork 28

openvela/docs

Code Issues 2 Pull Requests 3 Wiki Insights Pipelines

Service

Tencent Cloud Serverless

Create your Gitee Account

Explore and code with more than 14 million developers,Free private repositories !:)

Already have an account? Sign in

Clone or Download

Clone/Download

HTTPS SSH SVN SVN+SSH Download ZIP

Prompt

To download the code, please copy the following command and execute it in the terminal

To ensure that your submitted code identity is correctly recognized by Gitee, please execute the following command.

git config --global user.name userName 
git config --global user.email userEmail

When using the SSH protocol for the first time to clone or push code, follow the prompts below to complete the SSH configuration.

1 Generate RSA keys.

2 Obtain the content of the RSA public key and configure it in SSH Public Keys

To use SVN on Gitee, please visit the usage guide

When using the HTTPS protocol, the command line will prompt for account and password verification as follows. For security reasons, Gitee recommends configure and use personal access tokens instead of login passwords for cloning, pushing, and other operations.

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # Private Token

New file Create Diagram file

New submodule

Upload file

Branches 4

Tags 3

contribute

Sync branch

Create Pull Request

known more

See difference Through Pull Request Sync

Sync branch

Through Pull Request Sync

A Pull Request will be created to the current
branch and will be merged in to complete the sync

tanghao docs(dev_board): add Certified_Board and u... 417dca0

692 commits

.gitee

.github

.vscode

images

zh-cn

.gitignore

.markdownlint.json

CONTRIBUTING.md

CONTRIBUTING_zh-cn.md

DOC_README.md

DOC_README_zh-cn.md

LICENSE

README.md

README_zh-cn.md

Third_Party_and_Open_Source_Component...

README

Apache-2.0

<h1 align="center">openvela</h1>

# openvela Open Source Project

\[ English | [简体中文](README_zh-cn.md) ]

## About openvela

openvela is an operating system specifically crafted for the AIoT industry, with a focus on being lightweight, standards-compliant, secure, and highly scalable. It has become the technology of choice for millions of IoT devices and AI gadgets, including smart watches, fitness bands, smart speakers, earbuds, smart appliances, and robotics.

The name "Vela" is originated from the Latin term for "sail," which is also the name of the constellation resembling a sail in the southern sky. We aspire to partner with developers and set sail on a voyage through the AIoT landscape.

## Technical Architecture

![img](images/002.png)

- **Kernel Layer**

The kernel layer provides fundamental operating system functions, including task scheduling, inter-process communication (IPC), and file system management. It also supplies compact, efficient components such as device drivers, a lightweight TCP/IP protocol stack, and power management modules. This layer supports both homogeneous and heterogeneous multi-core architectures, enhancing performance support across diverse hardware platforms.

- **Service Framework Layer**

The service framework layer is a general-purpose framework designed to extend system services. It includes connectivity subsystem, graphics subsystem, multimedia subsystem, security subsystem, and XPC cross-core communication capabilities. This layer provides flexible support for service expansion, serving as the essential foundation for system functional expansion.

- **Maintenance and Testing Tools**

Maintenance and testing tools include common utilities and diagnostic frameworks. In addition to standard tools like Logger and Debugger, they feature the Emulator — a high-fidelity device simulator that supports full functional emulation, including CPU instruction-set simulation. The Emulator currently supports multiple product form factors, including smart panels, smartwatches, smart bands, and smart screen speakers. By leveraging the Emulator's PC-based debugging tools, developers can perform application development and testing without physical devices, significantly reducing both development and debugging efforts.

## Technical Advantages

- **Highly Scalable**

openvela has been designed to be modular and scalable, allowing it to easily adapt to a wide range of IoT applications. It can fit in a small BLE module with 32KB RAM, and scale up to a powerful smart display device with 512MB RAM, highly scalable!

- **One-Stop Solution**

Over the years, openvela has evolved into a powerful platform with comprehensive feature sets, making it a one-stop solution for various IoT applications. We consistently incorporate new functionalities to meet emerging needs. By leveraging openvela, manufacturers can significantly reduce their R&D costs and accelerate their product development cycles.

- **Mature Heterogeneous Computing Support**

openvela offers top-of-the-line support for heterogeneous multi-core systems, featuring a seamless IPC mechanism between various processing units such as MCU, MPU, DSP, GPU, and NPU. Additionally, openvela provides an advanced RPC framework between openvela, Linux, and Android systems to enable hybrid OS leveraging strength from three systems.

- **Standard Compliant and High Portability**

openvela Kernel is built upon Apache NuttX, which is often referred to as "tiny Linux". With this foundation, openvela achieves a high degree of conformity with the POSIX standard. Our team has been continually enhancing its POSIX compatibility, which has now reached an impressive 89%. Because of this standards conformance, software developed under other standard OSs (such as Linux) can be easily ported to openvela with minimum effort.

- **Comprehensive Connectivity Suite**

openvela offers broad protocol support, including Bluetooth BR/EDR/LE, LE Mesh, WiFi, Matter, IEEE802.15.4, and LTE Cat1, Ethernet, CAN/LIN, etc. Additionally, it seamlessly integrates with Xiaomi HyperConnect protocols.

- **Rich Developer Tools**

openvela offers a comprehensive suite of developer tools, including system monitoring, performance analysis, debugger, trace, crash dump, and log analysis tools.

## Hardware Support

- openvela supports a variety of architectures (ARM32, ARM64, RISC-V, Xtensa, MIPS, CEVA, etc.) and platforms.
- Please refer to the [Supported Architectures and Platforms](https://nuttx.apache.org/docs/latest/platforms/index.html) page for a complete list.
- For adaptation cases regarding development boards, please refer to the [Case Documentation](./en/dev_board/Development_Board.md).

## What's New

- **On-Device AI Agent Capability Upgrade**: openvela provides the **[ai_agent](../../../packages_ai_agent/blob/dev/README.md)** AI Agent framework, supporting multiple LLM backends, 35+ built-in tools, a Skills system, proactive tasks, and multi-channel access. It runs on-device intelligent applications on small devices such as watches, glasses, and speakers with only about 256KB of RAM.

- **Enhanced AI-Assisted Development**: openvela introduces the official AI development skill set **[.claude](https://github.com/open-vela/.claude)**. Combined with AI coding tools like Claude Code, you can set up the environment, build, adapt drivers, and debug using natural language, significantly lowering the development barrier.

- **openvela Official Website Launched**: openvela now has its own official website, providing developers with a more convenient channel for accessing project information, documentation, community updates, and more. Visit the [openvela Official Website](https://openvela.com).

- **First openvela Officially Certified Development Board**: The **[Gemini-S1](https://rivotek.feishu.cn/wiki/Onndw4lmniFBnEk0Rb7cDbwOnTc)** development board, independently developed by Runxinwei Intelligent Technology Co., Ltd., has become the first development board to pass the openvela official compatibility certification, marking a significant milestone in the openvela ecosystem.

- **Significant Hardware Ecosystem Expansion**: Added support for **Infineon AURIXTM TC4**, **Flagchip MCU**, and the **QEMU-R52 SIL** platform. (View [TC4 Guide](./en/quickstart/development_board/tc4d9_evb_guide.md) / [Flagchip Guide](./en/quickstart/development_board/fc7300f8m_evb_guide.md))

- **Enhanced Ubuntu Development Experience**: The OpenVela VS Code plugin now **fully supports the Ubuntu environment**. Linux developers can enjoy a seamless, end-to-end workflow—from project creation and build to system debugging—significantly boosting development efficiency. Get started: [VS Code Plugin Guide](./en/quickstart/vscode_plugin_usage.md).

## Version Strategy

We manage releases based on the `trunk` branch, using Tags to track release history. This ensures traceability and stability for production environments.

### Release Tags

Release tags are immutable markers created on the `trunk` branch. Each tag represents an officially released version of openvela.

- **Production Environment Recommendation**: To ensure maximum system stability and security, we **strongly recommend** using the latest release tags in production environments (Production Environment), rather than using branch code directly.

### Released Versions

Below are the currently released stable versions and their change logs:

- **trunk-5.5**: Please refer to the [v5.5 Release Notes](./en/release_notes/v5.5.md) for detailed changes.

- **trunk-5.4**: Please refer to the [v5.4 Release Notes](./en/release_notes/v5.4.md) for detailed changes.

- **trunk-5.2**: Please refer to the [v5.2 Release Notes](./en/release_notes/v5.2.md) for detailed changes.

### Hardware Adaptation Guide

To maximize efficiency and ensure code stability, we offer the following recommendations for developers performing hardware porting:

- **Recommended Baseline**: We strongly recommend **basing your development on the latest openvela release version** (i.e., Release Tags on the `trunk` branch).
- **Risk Warning**: The current **`dev` branch** is undergoing rapid iteration with frequent code updates. It may be subject to underlying interface changes or temporary instability. Therefore, it is **NOT recommended** as a baseline for hardware adaptation.
- **Self-Validation**: After porting, you can use the community-provided [xTS Test Case Collection (Chinese)](./zh-cn/test_dev_guide/openvela_xts_test_cases.md) for self-validation. It covers fundamental capabilities such as the system kernel, driver BSP, filesystem, WiFi, Bluetooth, and audio/video. Commands can be copied directly into nsh for execution without writing tests from scratch.
- **Get Support**: If you have adaptation requirements or encounter technical difficulties, please feel free to **submit an Issue** or contact us via the **WeChat Community**. The openvela team is ready to provide the necessary development support.

### Version Maintenance Strategy

openvela follows a strict version maintenance lifecycle:

- **Patch Updates**: For critical bugs or security vulnerabilities discovered in released versions, the team issues new patch release tags (Patch Release) to provide fixes.
- **Naming Convention**: Patch versions increment based on the original version number, such as `trunk-5.2.1`.

## Branch Strategy

openvela adopts a dual-branch model to balance system innovation and stability. Please select the appropriate branch according to your development needs.

### dev (Development Branch)

- **Definition**: This is the cutting-edge development branch of openvela, aggregating the latest features and bug fixes.
- **Status**: The code updates frequently and remains in a state of continuous integration and rapid iteration. It may contain features not yet fully verified, so potential instability exists.
- **Target Audience**:

- Developers who wish to experience new features early.
 - Contributors planning to submit code or participate in core function development.

### trunk (Stable Trunk Branch)

- **Definition**: This is the fully tested main branch, representing the current stable state of the system.
- **Status**: Features from the `dev` branch are merged here only after they pass rigorous testing and verification.
- **Target Audience**: Most users who require high system stability, and engineers developing standard applications.

## Quick start

### Device Development

If you want to experience openvela, we provide a fully functional emulator that can be used without a hardware platform. For more information, refer to the following guide.

[Quick Start (Ubuntu)](./en/quickstart/openvela_ubuntu_quick_start.md)

> **AI-Assisted Setup**: If you use an AI coding assistant, you can quickly set up the development environment with openvela's official AI skill set. See the [AI-Assisted Development](#ai-assisted-development-openvela-ai-skills) section below for details.

### Quick App Development

[Quick App Quick Start](https://iot.mi.com/vela/quickapp/zh/guide/start/use-ide.html)

## AI-Assisted Development (openvela AI Skills)

[.claude](https://github.com/open-vela/.claude) is openvela's officially maintained AI development skill set (Skills), providing AI coding assistants with domain knowledge for openvela environment setup, build, driver adaptation, debugging, and optimization. It is the recommended entry point for developing openvela with an AI coding workflow.

Use it together with AI coding tools like Claude Code:

```bash
git clone https://github.com/open-vela/.claude.git .claude
```

After cloning, describe your needs to the AI (e.g., "Help me set up the openvela development environment"), and the AI will leverage these Skills to automatically complete tasks such as environment setup, build, and debugging.

## List of Sub-repositories

| Sub-repository Link | Description |
| :--------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [frameworks](../../../../open-vela/frameworks) | openvela service framework: primarily includes Bluetooth, telephony, graphics, multimedia, application frameworks, security, and system service frameworks (KVDB, OTA, healthd, binder, charger, etc.). |
| [vendor](../../../../open-vela/vendor) | Drivers and frameworks provided by the original chip manufacturers. |
| [nuttx](../../../../open-vela/nuttx) | A kernel built on the open-source real-time operating system NuttX, providing essential kernel functions, including task scheduling, inter-process communication, file systems, TCP/IP stack, device drivers, and power management, while offering a standard POSIX interface. For more information about the NuttX operating system, you can visit the [Apache NuttX](https://nuttx.apache.org/) official website. |
| [apps](../../../../open-vela/apps) | `apps` is the application library for the open-source real-time operating system (NuttX), containing a series of applications and utilities designed for NuttX RTOS. These applications and tools include shell command-line tools, file system tools, network tools, etc., which can help developers develop and debug embedded systems based on NuttX RTOS more conveniently. |
| [external](../../../../open-vela/external) | Third-party libraries introduced by openvela. |
| [tests](../../../../open-vela/tests) | This repository contains interface tests, specifically including core API tests for multimedia, file systems, memory management, and socket communication. |
| [docs](../../../../open-vela/docs) | Developer documentation for openvela. |
| [packages](../../../../open-vela/packages) | A collection of openvela application and example packages, including the AI Agent framework (ai_agent), native app and game examples (demos), Quick App examples (fe_examples), and the Quick App framework. Contest-related examples and frameworks are mainly located in this repository. |
| [build](../../../../open-vela/build) | The openvela build system, providing `build.sh`, CMake/Kconfig build scripts, and build configurations. |
| [.claude](../../../../open-vela/.claude) | openvela's official AI development skill set (Skills), used with AI coding tools to assist environment setup, build, driver adaptation, and debugging. See the [AI-Assisted Development](#ai-assisted-development-openvela-ai-skills) section for details. |

> Note: After `repo sync`, a `prebuilts/` directory is also generated in the workspace, holding platform prebuilt binaries such as the build toolchain, QEMU, and the emulator. This directory is fetched per-platform automatically by `repo` and requires no manual maintenance or a separate repository.

## Developer Documentation

- [Documentation Center](https://doc.openvela.com/document)
- [API Reference](./en/api/index.md) — Complete API specification for kernel, network, and application framework interfaces

## Application Example Center

A collection of native and Quick App examples for developers to learn from.

### Native Apps

Here are some typical native application examples demonstrating the usage of different modules and features.

- [Music Player](./en/demo/Music_Player_Example.md): Demonstrates audio playback, playlist management, and background services.
- [Smart Band](./en/demo/Smart_Band_Example.md): Demonstrates sleep monitoring, heart rate monitoring, music playback, and a stopwatch.
- [Cycling Computer](./en/demo/X_Track.md): Demonstrates GPS positioning, real-time data display, and route tracking.
- [Calculator](../../../../open-vela/packages_demos/blob/dev/calculator/Readme.md): A basic example of UI and logic interaction.
- [Relation Calculator](../../../../open-vela/packages_demos/blob/dev/relation_calculator/Readme.md): Demonstrates complex conditional logic and algorithm implementation.
- [Whack-a-Mole](../../../../open-vela/packages_demos/blob/dev/Whackmole/README.md): Demonstrates a game loop, random number generation, and animation effects.

To see the full list of native apps, please visit the [Native App Examples Repository](../../../packages_demos/blob/dev/README_zh-cn.md).

### AI Agent Apps

An on-device AI Agent framework running on openvela, supporting multiple LLM backends, 35+ built-in tools, a Skills system, proactive tasks, and multi-channel access. It runs on small devices with around 256KB of RAM.

- [ai_agent](../../../packages_ai_agent/blob/dev/README.md): An AI Agent framework providing conversation, tool calling, Skills, proactive tasks, the MCP protocol, multi-device collaboration, and more. It serves as the core foundation for AI hardware application development.

### Quick Apps

- [Mi Band Weather App](../../.././packages_fe_examples/blob/dev/weather/README.md): Presents a clean and intuitive seven-day weather forecast.
- [Music Player](../../.././packages_fe_examples/blob/dev/player/README.md): Demonstrates a basic music player, including playback, volume control, and playlist viewing.
- [Calendar](../../.././packages_fe_examples/blob/dev/calendar/README.md): Demonstrates a basic calendar.

More Quick App examples are continuously being added. To see all examples, please visit the [Quick App Examples Repository](../../../packages_fe_examples).

## Code contribution

- [Code Contribution Guide](./CONTRIBUTING.md)
- [Documentation Contribution Guide](./en/contribute/process/doc_dev_process.md)

## Licensing

The openvela project consists of multiple independent repositories. Its licensing policy is as follows:

1. Basic Principles

The openvela project generally adopts the **Apache 2.0** license. However, the specific license for each code repository is determined by the `LICENSE` file located in its respective root directory.

2. Vendor Repositories

Repositories under the `vendor` directory are provided by third parties (such as chip manufacturers). These repositories follow their own independent licenses (e.g., MIT, BSD, etc.) and are **not** governed by the openvela project's Apache 2.0 license. Please ensure you review and comply with their respective terms before use.

3. Third-Party Dependencies

For information regarding third-party open source components referenced in the project code and their licenses, please refer to the [Third-Party Open Source Software Notice](./Third_Party_and_Open_Source_Components.md) file.

## Community and Support

We welcome you to interact with and contribute to the openvela community through our various channels.

### Technical Discussions and Contributions

- **Issues**: If you have any questions, suggestions, or find any bugs, submit a new issue on the Issues page. Try to provide detailed information, so that we can understand and solve the problem faster.
- **Pull Requests**: If you find an issue and have fixed it, you are welcome to submit a Pull Request. Please make sure to follow our [Contribution Guide](./CONTRIBUTING.md).
- **Discussions**: If you have a broader topic or discussion, you can start a new discussion on the Discussions page.

### WeChat Community

Welcome to the **OpenVela** community! Scan the QR codes below to follow our Official Account or add our assistant to join the group chat.

| Official Account | Developer Group |
| :---------------------------------------------------------------------: | :-------------------------------------------------: |
| <img src="./images/openvela_WeChat_Official_Account.png" width="200" /> | <img src="./images/assistant_qr.jpg" width="200" /> |
| **Follow Us**<br>Get the latest updates and technical articles | **Join the Group**<br>Scan to add assistant |

Copyright (C) 2024 Xiaomi Corporation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.