Guide update

This commit is contained in:
MartinLoren
2026-04-14 13:53:45 +08:00
parent be087c72c8
commit 4872623300
18 changed files with 115 additions and 14 deletions

BIN
Docs/AT32_Install.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 153 KiB

BIN
Docs/Jlink_driver.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

BIN
Docs/VPN-set.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB

BIN
Docs/build-succeed.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

BIN
Docs/failed.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB

BIN
Docs/git-step1.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
Docs/git-step2.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
Docs/git-step3.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

BIN
Docs/git-step4.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

BIN
Docs/git-success.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 209 KiB

BIN
Docs/jlink_port.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.8 KiB

BIN
Docs/success.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 229 KiB

BIN
Docs/upload-succeed.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

30
GIT-README.md Normal file
View File

@@ -0,0 +1,30 @@
## Git-Installation 安装
Git is required to download some of the AT32 Platform required extensions.
Before proceeding, make sure Git is installed. It can be downloaded from:
<br/>克隆这个存储库需要Git。
在继续之前请确保安装了Git。可从以下网址下载
[here](https://git-scm.com/downloads).
During installation, ensure that Git is added to your system PATH and properly configured. All other options can be left as default.
<br/>在安装过程中确保Git被添加到您的系统PATH中并被正确配置。所有其他选项都可以保留为默认值。
![MCU Comparison](Docs/git-step1.jpg "MCU Comparison")
![MCU Comparison](Docs/git-step2.jpg "MCU Comparison")
![MCU Comparison](Docs/git-step3.jpg "MCU Comparison")
## Troubleshooting 使用说明
If during first time code compilation an error like the one shown below occurs (failed to connect to GitHub), it is usually caused by network issues. Please ensure that GitHub is accessible or configure a proper network proxy service for your windows machine.
<br>如果出现如下图所示错误(无法连接 GitHub通常是网络问题请确保可以访问 GitHub 或为 Git 配置代理
![VSCode Platform](Docs/git-step4.jpg "VSCode Platform")
##### Solution:
For China Mainland users you can enable Global Mode in your Network Acceleration service software.
##### 解决方案:
![VSCode Platform](Docs/VPN-set.jpg "VSCode Platform")
The project should now compile successfully.
<br>项目现在可以成功编译了。
![VSCode Platform](Docs/git-success.jpg "VSCode Platform")

15
JLINK-README.md Normal file
View File

@@ -0,0 +1,15 @@
# JLINK Installation
Before proceeding, make sure J-Link software (including JLink.exe) is installed. It can be downloaded from:[here](https://www.segger.com/downloads/jlink/)
在此之前请确保已安装J-Link软件包括JLink.exe。可以从 [here](https://www.segger.com/downloads/jlink/)下载.
### J-OB Device Driver Installation
### 说明
Open Device Manager on your PC and check whether the J-Link device is correctly recognized under "Ports (COM & LPT)". If not check the J-Link installation guide above.
<br>在PC上打开设备管理器检查是否在“端口COM & LPT”下正确识别J-Link设备
If a warning icon (yellow exclamation mark) appears next to J-Link, it means the driver is not installed properly. In this case, go to the J-Link installation directory (for example: E:\software\JLink_V934b\USBDriver), then double-click `InstDrivers.exe` to install the driver.
<br>如果“J-Link”旁边出现警告图标黄色感叹号说明驱动安装不正确。在这种情况下进入J-Link安装目录例如E:\software\JLink_V934b\USBDriver然后双击“InstDrivers.exe”安装驱动程序。
![MCU Comparison](Docs/Jlink_driver.jpg "MCU Comparison")
After installation, unplug and reconnect the J-Link device.
<br>安装完成后请拔出并重新连接J-Link设备。
![MCU Comparison](Docs/Jlink_port.jpg "MCU Comparison")

View File

@@ -1,35 +1,76 @@
# Artery-AT32-PlatformIO
PlatformIO platform and framework for developing the new Artery AT32 MCU.<br/>雅特力科技AT32芯片 PlatformIO 平台和框架。
PlatformIO platform and framework for developing the new Artery AT32 MCU under VS Code!<br/>雅特力科技AT32芯片 PlatformIO 平台和框架。
MCUs Supported: **[AT32F403A](https://www.arterychip.com/en/product/AT32F403A.jsp)**, **[AT32F435](https://www.arterychip.com/en/product/AT32F435.jsp)**, **[AT32F437](https://www.arterychip.com/en/product/AT32F437.jsp)**.
<br/>Version 版本: 2024-12
<br/>Version 版本: 2026-03
## AT32 VS STM32
![MCU Comparison](Docs/MCU_Comparison.jpg "MCU Comparison")
## Prerequisites 前置条件
Before using this framework, make sure the following tools are installed:
- Visual Studio Code + PlatformIO ([Installation Guide](./VSCode-README.md))
- Git ([Installation Guide](./GIT-README.md))
- J-Link (for firmware upload and debugging) ([Installation Guide](./JLINK-README.md))
在使用本项目之前,请确保已安装以下工具:
- Git用于克隆本仓库([安装指南](./GIT-README.md))
- Visual Studio Code + PlatformIO ([安装指南](./VSCode-README.md))
- J-Link (for firmware upload and debugging) ([安装指南](./JLINK-README.md))
## Installation 安装
You need to have Visual Studio Code with PlatformIO installed tested with PlatformIO Core v.6.1.16).
1) Copy the folders under `.platformio` into your .platformio folder (ie: `C:\Users\<USER>\.platformio`)
#### 1. Install AT32 Platform in PlatformIO
#### 在PlatformIO中安装平台AT32 MCU平台
1.Copy the folders under `.platformio` into your .platformio folder (ie: `C:\Users\<USER>\.platformio`)
<br/>将 .platformio 下的文件夹复制到您的 .platformio 文件夹中(即:`C:\Users\<用户名>\.platformio`
#### Install AT32 Configurations for J-Link (last update from ArteryICPProgrammer V3.0.19)
In order to make the J-Link software aware of the new device, copy the folder `JLinkDevices` in the the central JLinkDevices folder (Windows): `C:\Users\<USER>\AppData\Roaming\SEGGER\`
Restart VS Code, then go to PlatformIO → Platforms and check whether the target chip platform has been installed correctly. If it appears as shown below, the installation is successful.
<br/>重启VS Code然后进入PlatformIO→Platforms检查目标芯片平台是否已经正确安装。如果出现如下所示则说明安装成功。
![VSCode Platform](Docs/AT32_Install.jpg "VSCode Platform")
#### 2. Install AT32 Configurations for J-Link (last update from ArteryICPProgrammer V3.0.19)
#### 为J-Link安装AT32配置最近更新自ArteryICPProgrammer V3.0.19
Before proceeding, make sure J-Link software (including JLink.exe) is installed.
In order to let the J-Link software work with AT32 MCUs under PlatformIO, copy the folder `JLinkDevices` in the the main JLinkDevices folder (Windows):
`C:\Users\<USER>\AppData\Roaming\SEGGER\`
<br>在此之前请确保已安装J-Link软件包括JLink.exe
为了让J-Link软件在PlatformIO下与AT32 mcu一起工作请复制主JLinkDevices文件夹中的文件夹'JLinkDevices' Windows:
`C:\Users\<USER>\AppData\Roaming\SEGGER\`
If the SEGGER folder does not exists, create it.
<br>为了使J-Link软件能够识别新设备请复制中央JLinkDevices文件夹Windows中的“JLinkDevices”文件夹“C:\Users\<USER> \AppData\Roaming\SEGGER\”。
Currently available:
目前可用:
- AT32F435xGx
- AT32F437xGx
More details about custom device configuration for J-Link are available [here](https://wiki.segger.com/J-Link_Device_Support_Kit).
有关J-Link的自定义设备配置的更多详细信息可供参考[here](https://wiki.segger.com/J-Link_Device_Support_Kit).
## Usage Instructions 使用说明
3) Open Visual Studio Code, you should see AT32 Platform among the available platforms
<br>打开 Visual Studio Code在可用平台中应该可以看到 AT32 平台
1) Open one of the example folder and try to compile / upload
<br>打开示例文件夹之一并尝试编译代码/上传到 MCU
# Upload Firmware on MCU 上传固件
# First Project
1. Copy one of the available sample folder to make a new project.
2. Open the copied folder in VS Code and wait that the PlatformIO Extension starts.
3. Hit the Build button and check that the building succeed.
## Info about Platform.ini Project Configuration File
`[env:(write here project name)]
platform = at32
framework = cmsis
board = generic_f435 ;or: generic_f403a
build_flags = -I include
monitor_speed = 921600
upload_protocol = jlink ;or: serial
debug_tool = jlink`
## Upload Firmware on MCU 上传固件
Available upload methods: `serial bootloader` (PA9, PA10), `dfu`, `jlink` (check the configuration guide [here](https://github.com/martinloren/Artery-AT32-PlatformIO/blob/main/JLINK.md) )<br>
可用的上传方法串行引导加载程序PA9、PA10、dfu、jlink
1) Set it in the file `platformio.ini` in the Project folder, complete configuration options as in example project *cmsis-blink*<br>
@@ -48,8 +89,8 @@ Notes 备注:
硬件浮点单元 (FPU)
- C/C++ compilation<br>
C/C++ 编译
- 224K Max SRAM (for AT32F403A)<br>
224K 最大SRAM (AT32F403A)
- 224K Max SRAM for AT32F403 / 512K for AT32F435<br>
224K 最大SRAMAT32F403512K为AT32F435
# TO-DO List 待办事项清单
- none

15
VSCode-README.md Normal file
View File

@@ -0,0 +1,15 @@
## VS Code PlantformIO Installation 安装
1. Install Visual Studio Code and PlatformIO
(tested with PlatformIO Core v6.1.16).
<br/>安装 Visual Studio Code 并安装 PlatformIO基于 PlatformIO Core v6.1.16 测试)。
Download VS Code from:
https://code.visualstudio.com/
2. After installing Visual Studio Code, install the PlatformIO extension.
The installation steps are shown below:
<br/>安装 Visual Studio Code 后,请安装 PlatformIO 扩展。
安装步骤如图所示:
![VSCode PlatformIO](Docs/VSCode_PlatformIO_install.jpg)