RT-AK 之 STM32 插件快速上手（附源码）

╰+攻爆jí腚メ 2022-10-13 05:15 217阅读 0赞

### 文章目录 ###

*  0. RT-AK 简介
 *  1. 准备工作
 *   *  1.1 X-CUBE-AI 介绍
     *  1.2 X-CUBE-AI 解压
     *  1.3 ART-PI BSP
 *  2. 执行步骤
 *   *  step1 运行 \`rt\_ai\_tools/aitools.py\`
     *   *  运行命令
         *  运行命令其他参数补充说明
         *  运行参数详细说明
     *  step2 编译和烧录
     *   *  RT-Thread Studio 编译和烧录
         *  示例应用代码提供
 *  3. 完整的示例工程

*本项目为 `RT-AK` 的一个实战 `DEMO`。*

*致力于做一个保姆级教程。*

*本教程 RT-AK 适配目标平台：STM32*

# 0. RT-AK 简介 #

> 目前该项目为 RT-AK 的示例 Demo，基于 ART-PI 硬件平台和 Mnist 数据集。

*  `RT-AK`: `RT-Thread AI Toolkit`，`RT-Thread AI` 套件。
 *  Github:
    
    https://github.com/RT-Thread/RT-AK

`RT-AK` 是 `RT-Thread` 团队为 `RT-Thread` 实时操作系统所开发的 `AI` 套件，能够一键将 `AI` 模型部署到 `RT-Thread` 项目中，让用户可以 在统一的 `API` 之上进行业务代码开发，又能在目标平台上获极致优化的性能，从而更简单方便地开发端侧 `AI` 应用程序。

在 `RT-AK` 支持下，仅需要一行命令，`python aitools.py --model xxx...`，即可将 `AI` 模型部署到 `RT-Thread` 系统中：

详细的命令请查阅：\[如何运行 aitools.py\](\# step1 运行 `rt_ai_tools/aitools.py`)

--------------------

**我们将致力于降低嵌入式 AI 落地的难度和门槛**

# 1. 准备工作 #

*  Windows 10
 *  Python >= 3.7

准备以下四份**重要重要重要**的材料：

<table> 
 <thead> 
  <tr> 
   <th align="center">Index</th> 
   <th align="center">Prepare</th> 
   <th>Example</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">1</td> 
   <td align="center">硬件以及 <code>BSP</code></td> 
   <td><code>ART-PI BSP</code></td> 
  </tr> 
  <tr> 
   <td align="center">2</td> 
   <td align="center">神经网络模型</td> 
   <td><code>./rt_ai_tools/Model/keras_mnist.h5</code></td> 
  </tr> 
  <tr> 
   <td align="center">3</td> 
   <td align="center"><code>STM32 AI</code> 插件</td> 
   <td><code>X-CUBE-AI</code> 下载解压，下文有介绍</td> 
  </tr> 
  <tr> 
   <td align="center">4</td> 
   <td align="center"><code>RT-AK</code></td> 
   <td><code>RT-AK</code> 代码克隆到本地</td> 
  </tr> 
 </tbody> 
</table>

## 1.1 X-CUBE-AI 介绍 ##

*  下载地址：https://www.st.com/zh/embedded-software/x-cube-ai.html
 *  版本：V5.2.0
    
    > **TO DO LIST**: 最新的版本是 V6.0.0，目前使用的是 V5.2.0，稍后的 RT-AK 将会更新

`X-CUBE-AI` 是 `STM32Cube.AI` 生态系统的 `STM32Cube` 扩展软件包的一部分，能够自动转换预训练的神经网络。

![6abe8d9a5f10bc2308fd0ef0bfe2f53d.png][]

X-CUBE-AI

![0e6bf7fd21f173cfd8a9ecda9df6f1c8.png][]

下载界面

## 1.2 X-CUBE-AI 解压 ##

![8a08798d912daa14b45658611c0e087e.png][]

下载后的文件夹界面

其中：

*  `stm32ai-windows-5.2.0.zip` 是我们所需要，该文件夹里面存放的是 `X-CUBE-AI` 模型转换软件： `stm32ai`
 *  `STMxxx.pack` 是 `STM32Cube.AI` 的静态库文件，**无需解压，已经存在**，位于 `./RT-AK/rt_ai_tools/platforms/stm32/X-CUBE-AI.5.2.0`

解压 `stm32ai-windows-5.2.0.zip` 。

在这里我将其解压到：`D:\Program Files (x86)\stm32ai-windows-5.2.0` ，可以在该路径下看见有一个 `windows` 文件夹。

**记下该路径，重要重要重要**

![d2004425d64ea28e7f87135d3a3e9966.png][]

STM32: X-CUBE-AI 解压路径

## 1.3 ART-PI BSP ##

1.  先打开 `RT-Thread Studio`
2.  新建 `ART-PI BSP`
    
    > 如果在开发版的地方，没有找到 `STM32H750-RT-ART-PI`，请查阅：
    > 
    > https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi/blob/master/documents/UM5002-RT-Thread%20ART-Pi%20%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C.md

![20210409182318.png][]RT-Thread Studio 新建 ART-PI

# 2. 执行步骤 #

## step1 运行 `rt_ai_tools/aitools.py` ##

> 代码将会自动使用 `STM32Cube.AI` 的模型转换工具，获得一个集成了 AI 的 BSP
> 
> 对，就是这么硬核，一步肝到位！

内部的流程请看源码或者 `plugin_stm32` 仓库下的 `readme` 文档

### 运行命令 ###

进入 `edge-ai/RTAK/tools` 路径，运行 `aitools.py`。

![image-20210412194422222][]

# 运行命令
    python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=stm32 --ext_tools=<your_x-cube-ai_path> --clear
    
    # 示例
    python aitools.py --project="D:\RT-ThreadStudio\workspace\test" --model="./Models/keras_mnist.h5" --platform=stm32 --ext_tools="D:\Program Files (x86)\stm32ai-windows-5.2.0\windows" --clear

运行到该步骤操作已经结束，后续是补充说明。

![image-20210414174056329][]

### 运行命令其他参数补充说明 ###

# 指定转换模型的名称，--model_name 默认为 network
    python aitools.py --project=<your_project_path> --model=<your_model_path>  --model_name=<model_name>  --platform=stm32 --ext_tools=<your_x-cube-ai_path>
    
    # 保存运行 stm32ai 线程过程中产生的文件，--clear 默认为空
    # 如果存在，则将会删除 `stm32ai` 运行时产生的工作文件夹，即`--stm_out`
    python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=stm32 --ext_tools=<your_x-cube-ai_path>
    
    # 指定保存运行日志, --log 默认为空
    python aitools.py --project=<your_project_path> --model=<your_model_path> --log=./log.log --platform=stm32 --ext_tools=<your_x-cube-ai_path>
    
    # 指定保存的文件夹名称，--stm_out 默认是当天时间，比如 './20210223'
    python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=stm32 --ext_tools=<your_x-cube-ai_path> --stm_out <new_dir>
    
    # 指定生成的 c-model 名，--c_model_name 默认是network
    python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=stm32 --ext_tools=<your_x-cube-ai_path> --c_model_name=<new_model_name>

### 运行参数详细说明 ###

*  主函数参数部分

<table> 
 <thead> 
  <tr> 
   <th>Parameter</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>--log</code></td> 
   <td><code>log</code> 日志存放路径，默认是空，如果有，则将保存log日志文件，例如：<code>./log.log</code></td> 
  </tr> 
  <tr> 
   <td><code>--project</code></td> 
   <td><code>OS+BSP</code> 项目工程文件夹，默认为空，<strong>需要用户指定</strong></td> 
  </tr> 
  <tr> 
   <td><code>--model</code></td> 
   <td>神经网络模型文件路径，默认为 <code>./Models/keras_mnist.h5</code></td> 
  </tr> 
  <tr> 
   <td><code>--model_name</code></td> 
   <td>神经网络模型转换后新的模型名，默认是 <code>network</code></td> 
  </tr> 
  <tr> 
   <td><code>--rt_ai_lib</code></td> 
   <td><code>RT-Thread</code> 官方提供的 <code>RT-AK Lib</code> ，默认是 <code>../rt_ai_lib</code></td> 
  </tr> 
  <tr> 
   <td><code>--platform</code></td> 
   <td>指定硬件平台信息，目前支持：<code>stm32</code>、<code>k210</code>，默认是 <code>example</code></td> 
  </tr> 
 </tbody> 
</table>

*  STM32 平台插件参数部分

<table> 
 <thead> 
  <tr> 
   <th>Parameter</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong><code>--ext_tools</code></strong></td> 
   <td><strong><code>X-CUBE-AI</code> 存放路径，模型转换工具，内有 <code>stm32ai</code> 可执行软件，需要用户指定</strong></td> 
  </tr> 
  <tr> 
   <td><code>--cube_ai</code></td> 
   <td><code>X-CUBE-AI</code> 运行所需的静态库，默认为<code>./platforms/stm32/X-CUBE-AI.5.2.0</code></td> 
  </tr> 
  <tr> 
   <td><code>--rt_ai_example</code></td> 
   <td>存放<code>rt_ai_&lt;model_name&gt;_model.c</code> 示例文件，默认是 <code>./platforms/stm32/docs</code></td> 
  </tr> 
  <tr> 
   <td><code>--stm_out</code></td> 
   <td>经过 <code>stm32ai</code> 线程处理之后产生的中间文件夹路径，默认是当天的时间戳命名</td> 
  </tr> 
  <tr> 
   <td><code>--workspace</code></td> 
   <td><code>stm32ai</code> 运行时产生的临时工作区，默认是<code>./stm32ai_ws</code></td> 
  </tr> 
  <tr> 
   <td><code>--val_data</code></td> 
   <td>默认为空，即使用内部自生成的随机数据集，允许用户自定义测试数据集，</td> 
  </tr> 
  <tr> 
   <td><code>--compress</code></td> 
   <td>表示将应用的全局压缩因子，仅应用在全连接层，可选 “1|4|8”，默认值：<code>1</code></td> 
  </tr> 
  <tr> 
   <td><code>--batches</code></td> 
   <td>指示生成了多少随机数据样本，默认是<code>10</code></td> 
  </tr> 
  <tr> 
   <td><code>--mode</code></td> 
   <td>“analyze|validate” 模式（可选）+”generate“模式（必须有），<code>1</code>表示选中，在<code>{'001', '011', '101', '111'}</code>中选一个，默认是 <code>001</code></td> 
  </tr> 
  <tr> 
   <td><strong>–network</strong></td> 
   <td><strong>在 <code>Documents</code> 中的模板文件的模型名，默认是 <code>mnist</code></strong></td> 
  </tr> 
  <tr> 
   <td><strong>–enable_rt_lib</strong></td> 
   <td><strong>在 <code>project/rtconfgi.h</code> 中打开宏定义，默认是 <code>RT_AI_USE_CUBE</code></strong></td> 
  </tr> 
  <tr> 
   <td>–clear</td> 
   <td>是否需要删除 <code>stm32ai</code> 生成的中间文件夹 <code>stm_out</code> ，默认为<code>False</code></td> 
  </tr> 
 </tbody> 
</table>

## step2 编译和烧录 ##

本教程仅展示 `RT-Thread Studio` 编译，另外还支持以下几种编译方式：

*  `Keil`
 *  基于 `RT-Thread Env` 的 `Scons`
 *  不基于 `RT-Thread Env` 的`Scons`

### RT-Thread Studio 编译和烧录 ###

在 `RT-Thread Studio` 中，找到项目工程，右键，

**更新软件包 + 刷新工程**，

然后编译（![8cdfc0aa9294cf7a6fcdbc45629b3bed.png][]），

最后烧录加显示。

![39ba4fc366a5ec32cac930a91449f6fd.png][]

![编译成功][cbc45a0a87aaac39ff11115f7617f4a3.png]

![5037fa441e350e29f9bbaa15b92d540f.png][]

这时候你就已经成功获得了一个集成了 `AI` 和 `RT-Thread` 的新的 `ART-Pi BSP`，

就可以`RT-Thread` 系统上做应用开发啦。

### 示例应用代码提供 ###

我们提供了一份运行模型推理的示例代码 mnist\_app.c：

http://117.143.63.254:9012/www/RT-AK/mnist\_app.zip：

1.  下载解压，放置到 `<BSP>/applications` 路径下

![image-20210409192729527][]

1.  选中 `RT-Thread Studio` 中的 项目工程，右击刷新

![image-20210409193019579][]

1.  编译烧录，
2.  输入命令：`mnsit_app`

![image-20210409192638719][]

--------------------

# 3. 完整的示例工程 #

完整的示例工程仓库地址：

下载即可食用

https://github.com/EdgeAIWithRTT/Project3-Mnist\_Cube\_RTT/tree/master/Mnist\_RTT

[6abe8d9a5f10bc2308fd0ef0bfe2f53d.png]: /images/20221005/ff92c88a5eb947a4b4db523d2d7d3815.png
[0e6bf7fd21f173cfd8a9ecda9df6f1c8.png]: /images/20221005/d8766128cd754cd498af5315db303cd5.png
[8a08798d912daa14b45658611c0e087e.png]: /images/20221005/847c130be22c4d338cf2f7be68989725.png
[d2004425d64ea28e7f87135d3a3e9966.png]: /images/20221005/46926ef284774c3ab059ea34c133770f.png
[20210409182318.png]: /images/20221005/4ed379d1f0a04460bf9ff2d963fdf96a.png
[image-20210412194422222]: /images/20221005/d39b9d3da40840e6b652386d0d86c92d.png
[image-20210414174056329]: /images/20221005/ba01348f8abb4a8e9274f30642bea795.png
[8cdfc0aa9294cf7a6fcdbc45629b3bed.png]: /images/20221005/719b81423def4d01b3af27a58a7af940.png
[39ba4fc366a5ec32cac930a91449f6fd.png]: /images/20221005/9587e054856341449ff675b1e69b350c.png
[cbc45a0a87aaac39ff11115f7617f4a3.png]: /images/20221005/0be3e904fa1f490992e1f39b40272273.png
[5037fa441e350e29f9bbaa15b92d540f.png]: /images/20221005/4082448cec2948cd8c0a5b36386093b2.png
[image-20210409192729527]: /images/20221005/ea02ff9a8ada4de68476cfcbd2108739.png
[image-20210409193019579]: /images/20221005/0310c573cfee4a7b947882f7b050c4a4.png
[image-20210409192638719]: /images/20221005/553d2cc31d214b71915f6125cbae390e.png