Quick Start Guide
This document aims to guide users in setting up a software environment for hardware development, demonstrating how to use the WM IoT SDK configuration menu through a simple example, and the steps to compile and download firmware to the development board.
Overview
The WM IoT SDK supports the following features for SoC chips:
The SoC uses a 40 nm process technology, offering optimal power consumption, RF performance, stability, versatility, and reliability, suitable for various application scenarios and different power consumption needs.
WinnerMicro provides complete software and hardware resources for users to develop hardware devices. The WM IoT SDK aims to assist users in quickly developing IoT applications, meeting user requirements for Wi-Fi, Bluetooth, low power consumption, and more.
Preparation
Hardware
A development board
USB data cable
Computer (Windows, Linux, or macOS)
Software
To use the WM IoT SDK, please install the following software:
Set up the toolchain for compiling firmware code;
Build tools — CMake and Ninja build tools for compiling user applications;
Obtain the WM IoT SDK software development framework.
Setting Up the Compilation Environment
Currently, two compilation environments are available:：
Command line compilation (SHELL compilation)
Integrated tool compilation(IDE compilation)
Hint
Due to the fact that different users may use different operating systems, we have provided steps for setting up environments for several commonly used operating systems on the market (Windows system、Linux system and macOS system)Users can choose one according to their actual situation.
Set up a command-line compilation environment
Build a compilation environment using IDE
Compile the first project
Start creating project
If the WM IoT SDK is installed and you are not using an integrated development environment (IDE), start compiling the project in the command prompt.
cd examples
cd hello_world
wm.py build
Flash to Device
Run the following command to flash the firmware. PORT is the serial port connected to the development board.
wm.py flash -p PORT
Replace PORT with the actual serial port name in your system (e.g., COM1 on Windows, /dev/ttyUSB0 on Linux, or /dev/cu.usbserial-1401 on macOS).
If the -p option is omitted, wm.py flash will try to use the first available serial port.To erase the entire flash and then re-flash, run: wm.py flash -e -p PORT .
Observe Serial Port Running Results
Then open your preferred serial port tool, select the serial port connected to UART0 on the development board, and press the reset button to observe the running results.
Uninstalling the Compilation Environment
If you are a Windows user and used the WM IoT SDK integrated package to set up the compilation environment, you can directly run the uninstallation wizard to uninstall the WM IoT SDK compilation environment.
If you used VS Code to set up the compilation environment, select the installed WM IoT SDK plugin from the plugin list on the left side of VS Code. The uninstallation option is available on the redirected page. Click uninstall to uninstall the compilation environment.