Note

This is the documentation for the latest development branch and may refer to features that are not available in released versions. If you are looking for the documentation for a specific release, use the drop-down menu on the left and select the desired version.

Quick Start Guide

What You Will Accomplish

The goal of this page is to help you complete a “verifiably successful” process in the shortest amount of time:

1. Download the SDK source code

2. Select the board configuration and build the image

3. Flash it to the development board

4. Log in via serial port and run the first example

If you want to see the full instructions, please go to the user guide:

• How to Build Firmware

• How to Flash Firmware

• How to Run Sample Programs

Prerequisites

• Host system: Ubuntu 20.04 x86_64 (recommended)

• Development board, serial cable, USB cable (or SD card reader) connected

• Available network (for repo sync and toolchain download)

15-Minute Onboarding Path

Download the Source Code

mkdir -p ~/rtos_k230 && cd ~/rtos_k230
repo init -u git@gitee.com:canmv-k230/manifest.git --repo-url=git@gitee.com:canmv-k230/git-repo.git
repo sync -j $(nproc)

Download the Toolchain (First Time Only)

make dl_toolchain

Select the Board Configuration

# View available configurations
make list-def

# Example: 01Studio
make k230_rtos_01studio_defconfig

If your board only has k230_canmv_*_defconfig, you can also select it first, then use menuconfig to disable CanMV and enable RTOS-side capabilities (see the section “How to Build an RTOS Image When Only CanMV defconfig Is Available” in How to Build Firmware).

Build the Image

time make log

Build results are typically located at:

output/<defconfig>/images/

Common files:

• *.kdimg: Recommended for K230BurningTool (USB)

• *.img: Commonly used for SD card imaging or command-line flashing

Flash and Boot

It is recommended to first use K230BurningTool to flash *.kdimg. See How to Flash Firmware for the steps.

After booting, use a serial port tool to connect to the development board (commonly 115200 baud rate) and enter the RT-Smart shell.

Run the First Example

cd /sdcard/app/examples
find . -name "*.elf" | head
./integrated_poc/smart_ipc.elf

If the example path is different, please refer to the output of find.

Common Entry Points

• Add/Modify Applications: userguide/helloworld.md

• View Supported Sensors and Enable Methods: hardware_compatibility/sensor_list.md

• Application Development Guide: app_develop_guide/index.md

• API Reference: api_reference/index.md

Next Steps

1. First, run through an existing example to confirm that the toolchain, flashing, and serial port link are all working properly

2. Then enable/trim the examples and application switches you need

3. Finally, solidify it into a unified team defconfig to avoid configuration drift