Getting Started Overview¶
SF32 devices support several software paths. SiFli-SDK and CodeKit are the official first-run paths today. The SF32LB52 DevKit LCD also has maintained upstream Zephyr support starting with Zephyr v4.3.0. OpenSiFli offers a beta ArduinoCore-zephyr package and is developing Rust support for SF32LB52. MicroPython still needs official firmware images and board-specific instructions before it can become a verified tutorial.
For the reference development workflow and the current scope of each development path, consult Develop Overview. Use the table below only to choose where to begin; each platform page is the canonical reference for its supported boards and limits.
Choose Your Path¶
| Path | Current status | Start here |
|---|---|---|
| SiFli-SDK | Official SiFli path for reference SF32 development, RT-Thread, Bluetooth, graphics, audio, low power, and board bring-up. | SiFli-SDK |
| SiFli CodeKit | Official SiFli VS Code workflow for SDK setup, project creation, build, flash, and serial monitor. | SiFli CodeKit |
| Zephyr | Maintained upstream support for sf32lb52_devkit_lcd is available starting with Zephyr v4.3.0. |
Zephyr Upstream |
| Arduino | OpenSiFli beta ArduinoCore-zephyr package exists for the SF32LB52 DevKit LCD. | Arduino |
| Rust | OpenSiFli sifli-rs provides a work-in-progress Rust evaluation path; not production-ready. |
Rust |
| MicroPython | Needs official firmware images, flash commands, REPL settings, and supported API details. | MicroPython |
What You Need¶
Start with a board supported by the software path you chose. The exact download and serial connections can differ by board and framework:
- An SF32 development board, such as the SF32LB52-DevKit-LCD.
- A data-capable cable and the programming/serial interface specified for that board and framework. On the SF32LB52-DevKit-LCD, SiFli's connection instructions use the USB-to-UART port for serial download; do not confuse it with the dedicated USB-function port.
- A computer running Windows, macOS, or Linux.
- A serial terminal configured for the board's console, so you can see boot logs and example output.
Use a data cable
Charge-only USB cables are a common cause of first-run failures. If the board powers up but no serial port appears, try a known-good data cable and a direct USB port.
Recommended First Run¶
If this is your first SF32 board, start with SiFli-SDK. It is the reference software stack for SF32 and the most reliable baseline for confirming that your board, cable, serial port, flash flow, and toolchain all work.
After hello_world runs successfully, switch to another framework that supports your exact hardware. That gives you a known-good recovery path if later experiments fail.
What Success Looks Like¶
By the end of a getting-started guide, you should have:
- Built or loaded a first example.
- Flashed it to the board.
- Opened the serial console.
- Seen predictable output, such as a boot log,
hello_world, a shell prompt, or REPL banner. - Recorded the board name, serial port, and flash command that worked.
Keep those details with your project notes. They are the fastest way back to a working setup when you start modifying examples.
Continue with Tutorials¶
Once you can repeat the first-run success criteria, continue to the Tutorials Overview. The tutorials are the next stage of this onboarding path: begin with one peripheral, then combine subsystems, and finally practice the validation work needed for a product.
When to Move to Develop¶
Getting Started ends when you can reproduce a known-good first run. Develop is the ongoing engineering reference for platform maturity, tools, flash/debug workflows, firmware architecture, and product integration. In particular, use the CodeKit tool reference after the first run for CodeKit's role in the daily development workflow; keep this page for the first-run path.
Before Choosing a Development Path¶
Before adopting a software path, check that its documentation covers your exact board and software version. In particular, look for:
- A public, board-by-board support and maturity matrix for SiFli-SDK, CodeKit, Zephyr, Arduino, and MicroPython.
- The exact board identifier used by each supported software path.
- Flash/download instructions for Windows, macOS, and Linux.
- Expected serial output for each first example.
- Recovery steps for failed flashes or invalid firmware images.
- Known framework limitations, especially for Bluetooth, display, storage, USB, and low-power behavior.
- Release notes that identify compatible SDK, CodeKit, package, firmware-image, and board-support versions.
Do not assume that support for one board applies to every SF32 board; verify the exact board and software version you plan to use.
Last updated: