diff --git a/Docs/AT32_Install.jpg b/Docs/AT32_Install.jpg new file mode 100644 index 0000000..4b6a58f Binary files /dev/null and b/Docs/AT32_Install.jpg differ diff --git a/Docs/Jlink_driver.jpg b/Docs/Jlink_driver.jpg new file mode 100644 index 0000000..21697dd Binary files /dev/null and b/Docs/Jlink_driver.jpg differ diff --git a/Docs/VPN-set.jpg b/Docs/VPN-set.jpg new file mode 100644 index 0000000..2b2c4bc Binary files /dev/null and b/Docs/VPN-set.jpg differ diff --git a/Docs/VSCode_PlatformIO_install.jpg b/Docs/VSCode_PlatformIO_install.jpg new file mode 100644 index 0000000..d192e24 Binary files /dev/null and b/Docs/VSCode_PlatformIO_install.jpg differ diff --git a/Docs/build-succeed.jpg b/Docs/build-succeed.jpg new file mode 100644 index 0000000..08ca0b1 Binary files /dev/null and b/Docs/build-succeed.jpg differ diff --git a/Docs/failed.jpg b/Docs/failed.jpg new file mode 100644 index 0000000..1388c30 Binary files /dev/null and b/Docs/failed.jpg differ diff --git a/Docs/git-step1.jpg b/Docs/git-step1.jpg new file mode 100644 index 0000000..ffe81d1 Binary files /dev/null and b/Docs/git-step1.jpg differ diff --git a/Docs/git-step2.jpg b/Docs/git-step2.jpg new file mode 100644 index 0000000..f9ad847 Binary files /dev/null and b/Docs/git-step2.jpg differ diff --git a/Docs/git-step3.jpg b/Docs/git-step3.jpg new file mode 100644 index 0000000..3b036cc Binary files /dev/null and b/Docs/git-step3.jpg differ diff --git a/Docs/git-step4.jpg b/Docs/git-step4.jpg new file mode 100644 index 0000000..2f66f89 Binary files /dev/null and b/Docs/git-step4.jpg differ diff --git a/Docs/git-success.jpg b/Docs/git-success.jpg new file mode 100644 index 0000000..bebc057 Binary files /dev/null and b/Docs/git-success.jpg differ diff --git a/Docs/jlink_port.jpg b/Docs/jlink_port.jpg new file mode 100644 index 0000000..ca23979 Binary files /dev/null and b/Docs/jlink_port.jpg differ diff --git a/Docs/success.jpg b/Docs/success.jpg new file mode 100644 index 0000000..33d7993 Binary files /dev/null and b/Docs/success.jpg differ diff --git a/Docs/upload-succeed.jpg b/Docs/upload-succeed.jpg new file mode 100644 index 0000000..dcf1dfe Binary files /dev/null and b/Docs/upload-succeed.jpg differ diff --git a/GIT-README.md b/GIT-README.md new file mode 100644 index 0000000..1bdc487 --- /dev/null +++ b/GIT-README.md @@ -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: +
克隆这个存储库需要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. +
在安装过程中，确保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. +
如果出现如下图所示错误（无法连接 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. +
项目现在可以成功编译了。 +![VSCode Platform](Docs/git-success.jpg "VSCode Platform") + + diff --git a/JLINK-README.md b/JLINK-README.md new file mode 100644 index 0000000..1c92fd9 --- /dev/null +++ b/JLINK-README.md @@ -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. +
在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. +
如果“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. +
安装完成后，请拔出并重新连接J-Link设备。 +![MCU Comparison](Docs/Jlink_port.jpg "MCU Comparison") \ No newline at end of file diff --git a/README.md b/README.md index e264aa0..b614517 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,76 @@ # Artery-AT32-PlatformIO - PlatformIO platform and framework for developing the new Artery AT32 MCU.
雅特力科技AT32芯片 PlatformIO 平台和框架。 + PlatformIO platform and framework for developing the new Artery AT32 MCU under VS Code!
雅特力科技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)**. -
Version 版本: 2024-12 +
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\\.platformio`) +#### 1. Install AT32 Platform in PlatformIO +#### 在PlatformIO中安装平台（AT32 MCU平台） + 1.Copy the folders under `.platformio` into your .platformio folder (ie: `C:\Users\\.platformio`)
将 .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\\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. +
重启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\\AppData\Roaming\SEGGER\` +
在此之前，请确保已安装J-Link软件（包括JLink.exe）。 +为了让J-Link软件在PlatformIO下与AT32 mcu一起工作，请复制主JLinkDevices文件夹中的文件夹'JLinkDevices' （Windows）: +`C:\Users\\AppData\Roaming\SEGGER\` +If the SEGGER folder does not exists, create it. +
为了使J-Link软件能够识别新设备，请复制中央JLinkDevices文件夹（Windows）中的“JLinkDevices”文件夹：“C:\Users\ \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 -
打开 Visual Studio Code，在可用平台中应该可以看到 AT32 平台 -1) Open one of the example folder and try to compile / upload -
打开示例文件夹之一并尝试编译代码/上传到 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) )
可用的上传方法：串行引导加载程序（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*
@@ -48,8 +89,8 @@ Notes 备注: 硬件浮点单元 (FPU) - C/C++ compilation
C/C++ 编译 -- 224K Max SRAM (for AT32F403A)
-224K 最大SRAM (AT32F403A) +- 224K Max SRAM for AT32F403 / 512K for AT32F435
+224K 最大SRAM为AT32F403，512K为AT32F435 # TO-DO List 待办事项清单 - none diff --git a/VSCode-README.md b/VSCode-README.md new file mode 100644 index 0000000..5c5ef8d --- /dev/null +++ b/VSCode-README.md @@ -0,0 +1,15 @@ +## VS Code PlantformIO Installation 安装 + +1. Install Visual Studio Code and PlatformIO + (tested with PlatformIO Core v6.1.16). +
安装 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: +
安装 Visual Studio Code 后，请安装 PlatformIO 扩展。 + 安装步骤如图所示： + +![VSCode PlatformIO](Docs/VSCode_PlatformIO_install.jpg) \ No newline at end of file