This is the documentation for the latest (main) development branch. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

VS Code

The following IDEs are currently available for users:

VS Code

Environment Requirements

  • VS Code requires version V1.70.0 or above, otherwise the plugin cannot be installed successfully.

Usage in Windows Environment

  1. Install VS Code

Visit the official website of Visual Studio Code to download and install it correctly.

  1. After opening VS Code, click on the extensions on the leftmost side, then search for WM-IDE to install it.

../_images/wm_vscode_ide_plugin.svg

  1. For better development with VS Code, it is recommended to install the following extensions as well:

  • Microsoft C/C++ extensions

  • Microsoft Serial Monitor Extension

  1. Open the WM-IDE plugin

Click on the WinnerMicro icon in the left functional panel to enter the plugin’s main interface, where you can perform operations such as environment configuration and project creation.

../_images/wm_vscode_ide_ui.svg

  1. Configure the WM-IDE plugin

Before using WM-IDE, you must first perform the configuration, and before that, you need to obtain the WM IoT SDK software development framework source code from the download page .

Complete the configurations shown in the diagram, including WM IoT SDK Path and WM Dev Suite Path.

../_images/wm_vscode_ide_win_config1.svg

For WM IoT SDK Path:

The download and storage path for WM IoT SDK source code \wm_iot_sdk

For WM Dev Suite Path:

If you have already installed the Integrated Development Environment(IDE) by referring to Set up command line compilation environment in Windows, you can directly configure it.

Installation path of the Integrated Development Environment(IDE)\winnermicro\wmclics

If you have not installed the Integrated Development Environment(IDE) by referring to Setting up command line compilation environment in Windows, you can click Install and select the installation path for automatic installation configuration.

../_images/wm_vscode_ide_win_config_install.svg

If you do not wish to use the Integrated Development Environment(IDE), you can also click Advance for advanced configuration and configure each item separately.

../_images/wm_vscode_ide_win_config2.svg

Click Save after completing the configuration.

  1. Create a project

There are three ways to create a project:

  • Create Empty Project: Create an empty project, and you can add corresponding functions to the project after creation.

  • Create Hello World Project: Create the simplest Hello World project for a quick experience.

  • Import Project: Import various example projects from the WM IoT SDK examples directory to quickly master the use of related functions.

../_images/wm_vscode_ide_creat_project.svg

After entering the project save location and project name in the project creation interface, the project will be generated.

  1. Configure, compile, burn, and run on the created project

Select any project file, such as main.c, click main.c and then right-click:

../_images/wm_vscode_ide_build.svg

Follow the steps in the above picture:

  1. Select menuconfig to open the settings menu for project configuration.

  2. Select build to compile the project.

  3. Select flash to burn the firmware.

You can also select the corresponding command from the WM IoT SDK menu in the status bar at the bottom.

After successfully burning the firmware, you can click Serial Monitor -> Change Port Number (consistent with the chip port number) -> Change Baud Rate -> Run to view the running results.

../_images/wm_vscode_ide_log.svg

Hint

  • You can also skip step six to create a project and directly open the project under examples in wm_iot_sdk, then configure, compile, burn, and run it.

Usage in Linux Environment

The usage method and steps are completely the same as Usage in Windows Environment, the following describes the steps with differences:

  1. Install VS Code

On Linux system, it is more recommended to use package management tools such as apt, yum, dnf, etc., to automatically install related tools. The following is an example of using the apt command on the Ubuntu system:

sudo apt update
sudo apt install code

  1. Configure the WM-IDE plugin

Before configuration, you need to obtain the WM IoT SDK software development framework source code from the download page and refer to Set up command line compilation environment in Linux to install the development compilation environment.

Complete the configurations shown in the diagram below, and the configuration paths need to be set according to the actual installation paths.

../_images/wm_vscode_ide_linux_config.svg

Hint

  • To connect the development board, you need to install the corresponding USB to serial port (e.g., CH34X) driver.

  • If the serial port cannot be opened, it may be a serial port permission issue. Try adding the user to the dialout group with sudo gpasswd –add username dialout to gain serial port access permissions, or use sudo chmod 777 /dev/ttyUSB0 (depending on the actual serial port used) to grant read and write permissions to all users.