Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*Note: Please adhere to [Contributing Guidelines](https://github.com/open-vela/docs/blob/trunk/CONTRIBUTING.md).*
*Note: Please adhere to [Contributing Guidelines](https://github.com/open-vela/docs/blob/trunk-5.4/CONTRIBUTING.md).*

## Summary

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,17 +101,17 @@ Here are some typical native application examples demonstrating the usage of dif
- [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/trunk/calculator/Readme.md): A basic example of UI and logic interaction.
- [Relation Calculator](../../../../open-vela/packages_demos/blob/trunk/relation_calculator/Readme.md): Demonstrates complex conditional logic and algorithm implementation.
- [Whack-a-Mole](../../../../open-vela/packages_demos/blob/trunk/Whackmole/README.md): Demonstrates a game loop, random number generation, and animation effects.
- [Calculator](../../../../open-vela/packages_demos/blob/trunk-5.4/calculator/Readme.md): A basic example of UI and logic interaction.
- [Relation Calculator](../../../../open-vela/packages_demos/blob/trunk-5.4/relation_calculator/Readme.md): Demonstrates complex conditional logic and algorithm implementation.
- [Whack-a-Mole](../../../../open-vela/packages_demos/blob/trunk-5.4/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/trunk/README.md).
To see the full list of native apps, please visit the [Native App Examples Repository](../../../packages_demos/blob/trunk-5.4/README.md).

### Quick Apps

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

Expand Down
14 changes: 7 additions & 7 deletions README_zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,17 @@ Vela 的命名源自拉丁语中船帆的含义,也是南方星空中船帆星
- [音乐播放器](./zh-cn/demo/Music_Player_Example_zh-cn.md):演示音频播放、列表管理和后台服务。
- [智能手环](./zh-cn/demo/Smart_Band_Example_zh-cn.md):演示睡眠监测、心率监测、音乐播放、秒表计时。
- [自行车码表](./zh-cn/demo/X_Track_zh-cn.md):演示 GPS 定位、实时数据显示和运动轨迹记录。
- [计算器](../../../../open-vela/packages_demos/blob/trunk/calculator/Readme.md):一个基础的 UI 与逻辑交互示例。
- [亲戚计算器](../../../../open-vela/packages_demos/blob/trunk/relation_calculator/Readme_zh-cn.md):演示复杂的条件逻辑与算法实现。
- [打地鼠](../../../../open-vela/packages_demos/blob/trunk/Whackmole/README_zh-cn.md):演示游戏循环、随机数生成和动画效果。
- [计算器](../../../../open-vela/packages_demos/blob/trunk-5.4/calculator/Readme.md):一个基础的 UI 与逻辑交互示例。
- [亲戚计算器](../../../../open-vela/packages_demos/blob/trunk-5.4/relation_calculator/Readme_zh-cn.md):演示复杂的条件逻辑与算法实现。
- [打地鼠](../../../../open-vela/packages_demos/blob/trunk-5.4/Whackmole/README_zh-cn.md):演示游戏循环、随机数生成和动画效果。

查看完整的原生应用列表,请访问[原生应用示例仓库](../../../packages_demos/blob/trunk/README_zh-cn.md)。
查看完整的原生应用列表,请访问[原生应用示例仓库](../../../packages_demos/blob/trunk-5.4/README_zh-cn.md)。

### 快应用(Quick Apps)

- [小米手环天气预报应用](../../.././packages_fe_examples/blob/trunk/weather/README.md):提供简洁直观的未来七日天气信息展示。
- [音乐播放器](../../.././packages_fe_examples/blob/trunk/player/README.md):演示一个基础的音乐播放器,包含音乐的播放,音量调节,歌单查看。
- [日历](../../.././packages_fe_examples/blob/trunk/calendar/README.md):演示一个基础的日历。
- [小米手环天气预报应用](../../.././packages_fe_examples/blob/trunk-5.4/weather/README.md):提供简洁直观的未来七日天气信息展示。
- [音乐播放器](../../.././packages_fe_examples/blob/trunk-5.4/player/README.md):演示一个基础的音乐播放器,包含音乐的播放,音量调节,歌单查看。
- [日历](../../.././packages_fe_examples/blob/trunk-5.4/calendar/README.md):演示一个基础的日历。

快应用相关示例正在持续丰富中。查看所有示例,请访问[快应用示例仓库](../../../packages_fe_examples)。

Expand Down
2 changes: 1 addition & 1 deletion en/app_dev/system_apps/Dev_UI_App.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## I. Prerequisites

1. Download the source code. Please refer to [Quick Start](./../../quickstart/openvela_ubuntu_quick_start.md).
2. Before starting this tutorial, please obtain the example code from [music_player](../../../../../../packages_demos/tree/trunk/music_player).
2. Before starting this tutorial, please obtain the example code from [music_player](../../../../../../packages_demos/tree/trunk-5.4/music_player).

## II. Preliminary Concepts

Expand Down
2 changes: 1 addition & 1 deletion en/chip_porting/Interrupt_System_Adaptation_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The following are the interrupt-related functions that vendors need to implement

### 2. Required Interrupt-Related Macros

Alongside the above function implementations, vendors need to define a series of interrupt-related macros, which describe the configuration of the NVIC (Nested Vectored Interrupt Controller). These macros should be defined in the `chips/chip_name/include/irq.h` file. Refer to the [RTL8720C example](../../../../../nuttx/blob/trunk/arch/arm/src/rtl8720c/include/irq.h) for guidance.
Alongside the above function implementations, vendors need to define a series of interrupt-related macros, which describe the configuration of the NVIC (Nested Vectored Interrupt Controller). These macros should be defined in the `chips/chip_name/include/irq.h` file. Refer to the [RTL8720C example](../../../../../nuttx/blob/trunk-5.4/arch/arm/src/rtl8720c/include/irq.h) for guidance.

The required macros and their descriptions are as follows:

Expand Down
2 changes: 1 addition & 1 deletion en/debugging_tools/offline_debugging/backtrace.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ CONFIG_FRAME_POINTER=y
CONFIG_SCHED_BACKTRACE=y
```

For more information, refer to: [RISC-V Backtrace Implementation](../../../../../../nuttx/blob/trunk/arch/risc-v/src/common/riscv_backtrace.c).
For more information, refer to: [RISC-V Backtrace Implementation](../../../../../../nuttx/blob/trunk-5.4/arch/risc-v/src/common/riscv_backtrace.c).

### 4. Xtensa

Expand Down
2 changes: 1 addition & 1 deletion en/dev_board/Development_Board.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
| STMicroelectronics | STM32F411CEU6 | [STM32F411CE](https://www.st.com/en/microcontrollers-microprocessors/stm32f411ce.html) | [Blink an LED with openvela on STM32F411](../quickstart/development_board/STM32F411.md) | IoT, Industrial Automation | [ST MCU China Support](mailto:mcu.china@st.com) |
| Espressif | [ESP32-S3-EYE](https://www.espressif.com/en/dev-board/esp32-s3-eye) | [ESP32-S3](https://www.espressif.com/en/products/socs/esp32-s3) | [Port openvela to the ESP32-S3-EYE Dev Board](../quickstart/development_board/ESP32-S3-EYE.md) | AIoT, HMI, Smart Home | [Espressif Developer Community](https://www.espressif.com/en/contact-us/technical-inquiries) |
| Espressif | [ESP32-S3-BOX](https://www.espressif.com/en/news/ESP32-S3-BOX_video) | [ESP32-S3](https://www.espressif.com/en/products/socs/esp32-s3) | [See: Port openvela to the ESP32-S3-EYE Dev Board](../quickstart/development_board/ESP32-S3-EYE.md) | AIoT, HMI, Smart Home | [Espressif Developer Community](https://www.espressif.com/en/contact-us/technical-inquiries) |
| Bestechnic | [BES2600WM MAIN BOARD V1.1](https://www.fortune-co.com/index.php?s=/Cn/Public/singlePage/catid/176.html) | BES2600WM-AX4F | [Readme](../../../../../vendor_bes/blob/trunk/boards/best2003_ep/aos_evb/Readme) | Smart Wearables, AI Toys | [Contact Distributor](https://www.fortune-co.com/Tech/projectDetail/id/64.html) |
| Bestechnic | [BES2600WM MAIN BOARD V1.1](https://www.fortune-co.com/index.php?s=/Cn/Public/singlePage/catid/176.html) | BES2600WM-AX4F | [Readme](../../../../../vendor_bes/blob/trunk-5.4/boards/best2003_ep/aos_evb/Readme) | Smart Wearables, AI Toys | [Contact Distributor](https://www.fortune-co.com/Tech/projectDetail/id/64.html) |
| Flagchip | [FC7300F8M-EVB](https://www.flagchip.com.cn/Pro/3/3.html) | [FC7300F8MDT](https://www.flagchip.com.cn/Pro/3/3.html) | [openvela Running Guide for FC7300F8M-EVB](../quickstart/development_board/fc7300f8m_evb_guide.md) | Domain/Zonal Controllers, ADAS, BMS, Motor Control, etc. | [Contact Distributor](https://www.flagchip.com.cn/Pro/3/3.html) | [Contact Distributor](https://www.flagchip.com.cn/Pro/3/3.html) |
| Infineon | [TC4D9-EVB](https://itools.infineon.com/aurix_tc4xx_code_examples/documents/Board_Users_Manual_TriBoard-TC4X9-COM-V2_0_0.pdf) | [AURIX ™ TC4x](https://www.infineon.cn/products/microcontroller/32-bit-tricore/aurix-tc4x/tc4dx#products) | [openvela Running Guide for TC4D9-EVB](../quickstart/development_board/tc4d9_evb_guide.md) | Vehicle Motion Controllers, Zonal Controllers, Automotive Gateways, etc. | [Contact Distributor](https://www.infineon.cn/contact-us/where-to-buy) | [Contact Distributor](https://www.infineon.cn/contact-us/where-to-buy) |
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ The implementation of these member functions depends on the actual operation of

#### Note

- To quickly validate custom callbacks and driver registration in a QEMU environment, this example implements the `struct bt_driver_s` member functions directly within the [drivers_initialize](../../../../../../../nuttx/blob/trunk/drivers/drivers_initialize.c) function and completes driver registration.
- In a real integration or production scenario, it is recommended to create a separate source file under the [vendor](../../../../../../../vendor_template/blob/trunk/boards/chip_name/board_name/src) directory for maintainability and version control.
- To quickly validate custom callbacks and driver registration in a QEMU environment, this example implements the `struct bt_driver_s` member functions directly within the [drivers_initialize](../../../../../../../nuttx/blob/trunk-5.4/drivers/drivers_initialize.c) function and completes driver registration.
- In a real integration or production scenario, it is recommended to create a separate source file under the [vendor](../../../../../../../vendor_template/blob/trunk-5.4/boards/chip_name/board_name/src) directory for maintainability and version control.

#### Steps

1. In [drivers_initialize.c](../../../../../../../nuttx/blob/trunk/drivers/drivers_initialize.c), add the [bt_driver.h](../../../../../../../nuttx/blob/trunk/include/nuttx/wireless/bluetooth/bt_driver.h) header include:
1. In [drivers_initialize.c](../../../../../../../nuttx/blob/trunk-5.4/drivers/drivers_initialize.c), add the [bt_driver.h](../../../../../../../nuttx/blob/trunk-5.4/include/nuttx/wireless/bluetooth/bt_driver.h) header include:

```C
#include <nuttx/wireless/bluetooth/bt_driver.h> /* Add bt_driver.h header include */
```

2. In [drivers_initialize.c](../../../../../../../nuttx/blob/trunk/drivers/drivers_initialize.c), implement the member functions.
2. In [drivers_initialize.c](../../../../../../../nuttx/blob/trunk-5.4/drivers/drivers_initialize.c), implement the member functions.

In openvela, the `receive` member function of `struct bt_driver_s` already has a default implementation in [uart_bth4.c](../../../../../../../nuttx/blob/trunk/drivers/serial/uart_bth4.c). Therefore, developers or vendors do not need to redefine or implement this method.
In openvela, the `receive` member function of `struct bt_driver_s` already has a default implementation in [uart_bth4.c](../../../../../../../nuttx/blob/trunk-5.4/drivers/serial/uart_bth4.c). Therefore, developers or vendors do not need to redefine or implement this method.

```C
/* The following are sample implementations for demonstration only.
Expand Down Expand Up @@ -68,7 +68,7 @@ The implementation of these member functions depends on the actual operation of
/* 4. The receive member function is assigned by openvela at registration time */
```

3. In [drivers_initialize.c](../../../../../../../nuttx/blob/trunk/drivers/drivers_initialize.c), define the `struct bt_driver_s` structure.
3. In [drivers_initialize.c](../../../../../../../nuttx/blob/trunk-5.4/drivers/drivers_initialize.c), define the `struct bt_driver_s` structure.

The following code shows a complete example of initializing a `struct bt_driver_s` instance, where the function pointers are assigned to the sample functions defined above:

Expand All @@ -94,15 +94,15 @@ After implementing the above structure, register the driver instance using one o

- `bt_driver_register_with_id(FAR struct bt_driver_s *driver, int id)`: Registers with the specified id

The type definition `int bt_driver_register(FAR struct bt_driver_s *drv)` can be found in the header [bt_driver.h](../../../../../../../nuttx/blob/trunk/include/nuttx/wireless/bluetooth/bt_driver.h). Vendors or developers do not need to define the `receive()` member function; the BTH4 driver will initialize it.
The type definition `int bt_driver_register(FAR struct bt_driver_s *drv)` can be found in the header [bt_driver.h](../../../../../../../nuttx/blob/trunk-5.4/include/nuttx/wireless/bluetooth/bt_driver.h). Vendors or developers do not need to define the `receive()` member function; the BTH4 driver will initialize it.

The call flow is shown below:

![img](img/bt_driver.png)

### Example

After completing the driver implementation example above, call the driver registration API at the end of the `drivers_initialize()` function in [drivers_initialize.c](../../../../../../../nuttx/blob/trunk/drivers/drivers_initialize.c) to complete the driver registration:
After completing the driver implementation example above, call the driver registration API at the end of the `drivers_initialize()` function in [drivers_initialize.c](../../../../../../../nuttx/blob/trunk-5.4/drivers/drivers_initialize.c) to complete the driver registration:

```C
void drivers_initialize(void)
Expand Down
2 changes: 1 addition & 1 deletion en/device_dev_guide/driver/driver_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ In openvela, the application layer accesses drivers through system calls, with t

**System call -> VFS (Virtual File System) -> Driver**.

To understand how drivers are registered with the file system, it is necessary to first understand the relevant data structures. The definitions of these data structures are located in the [include/nuttx/fs/fs.h](../../../../../../nuttx/blob/trunk/include/nuttx/fs/fs.h) file.
To understand how drivers are registered with the file system, it is necessary to first understand the relevant data structures. The definitions of these data structures are located in the [include/nuttx/fs/fs.h](../../../../../../nuttx/blob/trunk-5.4/include/nuttx/fs/fs.h) file.

#### Driver Registration and `inode`

Expand Down
Loading
Loading