简体中文

English

简体中文

English

外观

​

软件安装 ​

  首先我们需要安装工具需要保证已经安装git，并且python版本大于3.9，如是都没有安装这些软件可以参考疑难解答

SDK拉取 ​

  在编程前我们需要进行拉取黄山派的SDK包SiFli-SDK Gitee仓库

  首先我们需要再你需要的地方创建一个文件夹，然后打开终端，切换到要保存 SiFli-SDK 的工作目录，使用 git clone 命令克隆远程仓库。打开终端，运行以下命令：

shell
mkdir -p D:\OpenSiFli
cd D:\OpenSiFli
git clone --recursive https://gitee.com/SiFli/sifli-sdk -b release/v2.4

  其中-b参数代表指定分支，一般来说SiFli-SDK 的 release/ 分支是最新的稳定版本，在这里我们选择 release/v2.4 分支。

  注：这里保存SDK的路径按照自己的需要自定义。

  如下图所示：

  注：如果不是通过命令拉下来的，那就不需要上面的操作。

安装工具 ​

  除了 SiFli-SDK 本身，还需要为支持 SF32 的项目安装 SiFli-SDK 使用的各种工具，比如编译器、调试器、Python 包等。

  首先我们需要进入刚刚下载好的SDK包中，如下图所示：

  注：根据自己的存放路径进入 /SiFli-SDK 文件夹，随便看一下 install.ps1 文件是否存在。

  打开 powershell 终端，执行下面的命令(国内下载可能比较慢，因此可以增加镜像加速,命令在本小节后面)

c
.\install.ps1

  如下图所示：

注：下载时间较长，请耐心等待。

  报错：如果您之前没有运行过powershell脚本或者执行.\install.ps1脚本出现类似如下错误的话：

  无法将“install.ps1”项识别为 cmdlet、函数、脚本文件或可运行程序的名称。请检查名称的拼写，如果包括路径，请确保路径正确，然后重试。

  请使用管理员权限重新打开powershell，并执行如下命令：

c
Set-ExecutionPolicy RemoteSigned

⚠️ 运行 install.ps1 脚本

  一定要等运行完毕才能执行下一步，不要直接关闭powershell、不要直接关闭powershell、不要直接关闭powershell。重要的事情说三遍

自定义工具安装路径（可选） ​

⚠️ Windows用户可以参考下面的命令:

  本步骤中介绍的脚本将 SiFli-SDK 所需的编译工具默认安装在用户的根目录中，即 *inx 系统中的 $HOME/.sifli 目录，或者是windows下的C:\Users<name>.sifli。我们可以选择将工具安装到其他目录中，但请在运行安装脚本前，导出环境变量 SIFLI_SDK_TOOLS_PATH。注意，请确保用户账号已经具备了读写该路径的权限。

c
$env:SIFLI_SDK_TOOLS_PATH="D:\SIFLI\tools"
.\install.ps1

.\export.ps1

  如果修改了 SIFLI_SDK_TOOLS_PATH 变量，请在运行任意 SiFli-SDK 工具或脚本前，将该变量导出到环境变量中。

  对Windows用户来说，如果你的用户名中包含空格、汉字等非英文字符，则强烈建议设置SIFLI_SDK_TOOLS_PATH用来指定工具安装路径，否则可能会导致安装失败或编译错误。建议将该路径设置为纯英文路径，例如 D:\SIFLI\tools。

  如未导出环境变量，大多数 shell 将不支持在变量赋值中使用 SIFLI_SDK_TOOLS_PATH，例如 SIFLI_SDK_TOOLS_PATH="$HOME/required_sdk_tools_path" ./install.ps1。因为即便在源脚本中导出或修改了该变量，当前的执行环境也不受变量赋值影响。

  注：若网络环境不是很好，请使用下面的国内加速命令。

  按照上述说明设置过自定义工具安装路径，那么在运行 export.ps1 脚本之前必须设置

c
cd C:\OpenSiFli\SiFli-SDK
$env:SIFLI_SDK_TOOLS_PATH="D:\SIFLI\tools"
.\export.ps1

国内加速 ​

  国内下载可能比较慢，因此可以增加镜像加速，完整的命令如下所示：

shell
$env:SIFLI_SDK_GITHUB_ASSETS="downloads.sifli.com/github_assets"
$env:PIP_INDEX_URL="https://mirrors.ustc.edu.cn/pypi/simple"
.\install.ps1

设置环境变量 ​

终端 ​

  在SDK的根目录的终端窗口运行以下命令：

c
.\export.ps1

⚠️关于环境加载说明

每次打开新的 PowerShell 时，都需要运行 export.ps1 脚本，因为这是设置所需环境变量的必要步骤。

  运行接口如下图所示：

VScode ​

  可以在vscode中按下 Ctrl+（可能存在快捷键冲突）, 打开设置，点击右上角的切换到json

  搜索 terminal.integrated.profiles.windows 按照如下方式增加配置，注意将最后的export.ps1文件位置改成你的SDK路径，如下图所示

c
"SF32": {
    "path": "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
    "args": [
        "-ExecutionPolicy",
        "Bypass",
        "-NoExit",
        "-File",
        "D:\\SIFLI\\SiFli-SDK\\export.ps1"
    ]
}

注：

  这是我的电脑的存放文件的路径 “D:\SIFLI\SiFli-SDK\export.ps1” 修改为您电脑中实际存放该文件的路径

  如是在VScode 的 json 设置中没有找到 terminal.integrated.profiles.windows 参考开源爱好者提供的解决方法 疑难解答

  之后就可以在任意的vscode工程中，打开一个新的终端。然后在下拉框中点击SF32即可

环境验证 ​

  我们按照环境的要求安装好依赖包，并配置好环境变量。需要进入到RT-Thread版本的hello_world示例的 project 目录下，如下图所示：

c
cd example\get-started\hello_world\rtt\project

  接下来我们该编译文件，命令如下所示：

c
scons --board=sf32lb52-lchspi-ulp -j8

注：

  • 其中sf32lb52-lchspi-ulp为立创黄山派的名称，后续开发板的名称都以此为准。
  • -j8 为编译速度，8为线程数，一般来说可以设置为 CPU 的线程数或者更少。

  编译完结果如下图所示：

  注：若是出现下面报错是子模块没有初始化，需要执行下面的命令：

c
git submodule update --init --recursive

  报错内容，如下图所示：

下载程序 ​

  首先我们需要对开发板进行硬件连接。如下图所示：

  • 5-6脚用来测试VBAT路径功耗，可以把电池和充电芯片与下游断开。
  • 7-8脚用来测试VSYS路径功耗，可以把VSYS与下游断开
  • 11-12脚用来测试VCC_3V3路径功耗，可以把VCC_3V3与下游断开
  • 正常运行时要求：5-6、7-8和11-12脚加跳线帽短接，不要插错了，不要插错了，不插错了，重要的事情说三遍。

接好跳线帽后，连接开发板的Type-C与电脑的USB接口即可，如下图所示：

  接好后，我们打开设备管理器，查看是串口号，如下图所示：

  接下来我们在终端里面输入下面的命令：

c
build_sf32lb52-lchspi-ulp_hcpu\uart_download.bat

  下载程序到开发板，当提示please input serial port number ,这里就该输入我们刚刚查看端口号，我这里是 COM12 ，输入 12 即可。

  下载完毕后，我们打开串口助手，波特率需要设置为 1000000 然后勾选串口助手的流控控制里的RTS，然后再取消，即可实现芯片复位。

  然后取消RTS即可。

  至此我们的环境搭建及验证就完成了。