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

This page helps you complete one verified end-to-end flow in the shortest possible time:

1. Download the SDK source code

2. Select a board configuration and build an image

3. Flash the image to the development board

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

For full documentation, refer to the User Guide:

• How to Build Firmware

• How to Flash Firmware

• How to Run Sample Programs

Prerequisites

• Host OS: Ubuntu 20.04 x86_64 (recommended)

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

• Network access (for repo sync and toolchain download)

15-Minute Quick Start

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 a Board Configuration

# List available configurations
make list-def

# Example: 01Studio
make k230_rtos_01studio_defconfig

If your board only has a k230_canmv_*_defconfig, you can select it first and then use menuconfig to disable CanMV and enable RTOS capabilities. See the section “Building an RTOS image when only a CanMV defconfig is available” in How to Build Firmware.

Build the Image

time make log

Build output is typically located at:

output/<defconfig>/images/

Common files:

• *.kdimg: recommended for K230BurningTool (USB)

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

Flash and Boot

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

After booting, connect to the board using a serial terminal (common baud rate: 115200) to access the RT-Smart shell.

Run the First Sample

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

If the sample path differs, use the output of find as the reference.

Common Entry Points

• Add or modify an application: userguide/helloworld.md

• View supported sensors and how to enable them: userguide/sensor_list.md

• Application development guide: app_develop_guide/index.md

• API reference: api_reference/index.md

Recommended Next Steps

1. Run a ready-made sample first to verify that the toolchain, flashing, and serial link all work.

2. Then enable or trim the samples and application switches you need.

3. Finally, lock in a unified defconfig for your team to avoid configuration drift.