当前文档版本为 v0.9.1，您可以访问当前页面的 开发中 版本以获取最近可能的更新。

App Launcher for PAN108x

1 概述

Zephyr App Launcher (以下简称ZAL) 是 Shanghai Panchip Microelectronics Co.,Ltd. 为 PAN1080 SDK 提供的入口界面软件，其设计目标是以 Windows GUI 的方式，简化 PAN1080 SDK 中 App（例程与测试用例等）的编译烧录过程，同时提供了通向 IDE 集成开发环境（VS Code）的入口。

2 获取并打开软件

  1. ZAL是绿色软件，无需安装，默认集成到 PAN1080 Development Kit 中，位于<PAN1080-DK>\05_TOOLS目录下：

    image

    ZAL 工具目录

  2. 进入ZAL-win32-x64-v<*>子目录，找到ZephyrAppLauncher-v<*>.exe：

    image

    ZAL 可执行文件

  3. 双击ZephyrAppLauncher-v<*>.exe，打开后界面如下：

    image

    打开 ZAL 主界面

注：

  1. ZAL目前只提供 Windows x64 版本；

  2. 为后续使用方便，可以采用如下方式为ZAL创建快捷入口（以 Win10 系统为例）：

    • 固定到任务栏：直接将ZephyrAppLauncher-v<*>.exe文件拖拽到 Window 任务栏；

    • 固定到开始菜单：在ZephyrAppLauncher.exe图标上点击右键，选择固定到“开始”屏幕；

    • 创建桌面快捷方式：在ZephyrAppLauncher.exe图标上点击右键，选择发送到 -> 桌面快捷方式；

3 功能介绍

下面详细介绍Zephyr App Launcher for PAN1080（ZAL）的具体功能及使用方法。

3.1 工具配置

第一次使用，需要先指定如下两个路径信息：

  1. 配置 PAN108x 编译工具链 Toolchain 的路径；

  2. 配置 PAN108x DK 开发包的路径；

image

ZAL 工具配置

3.1.1 编译工具链选择

  1. 点击 Toolchain Path 行末的...按钮，打开目录选择对话框；

  2. 点击路径一栏，进入 05_TOOLS 目录下的 Toolchain 子目录；

  3. 点击右下角选择文件夹按钮；

image

指定编译工具链所在的目录

如果配置成功，则可以看到 Toolchain Path 的路径框背景颜色变为白色：

3.1.2 PAN1080 DK 选择

  1. 点击 PAN108x-DK Path 行末的...按钮，打开目录选择对话框；

  2. 点击路径一栏，进入 PAN1080-DK 根目录；

  3. 点击右下角选择文件夹按钮；

image

指定 PAN1080-DK 所在的目录

如果配置成功，则可以看到 PAN108x-DK Path 的路径框背景颜色变为白色，同时下方的 Board 选择、Project 选择、Build、Rebuild、Flash、Open IDE 等按钮变为可操作状态：

image

成功识别 PAN1080-DK

3.2 Board 选择

Board 下拉列表中显示了<PAN1080-DK>\01_SDK\zephyr\boards\arm目录下的所有开发板：

image

Board 选择

以上图为例，可以看到当前选择的 PAN1080-DK 开发包中，默认支持的 5 个 EVB 开发板：

  • pan1083xa1_evb：表示主控是封装为 QFN32 4x4、Flash 大小为 512KB 的 PAN1083 EVB

  • pan108xxa1_evb：表示主控是封装为 32 pin、Flash 大小为 512KB 的 PAN1080/PAN1081/PAN1082 EVB

  • pan108xxa3_evb：表示主控是封装为 48 pin、Flash 大小为 512KB 的 PAN108x EVB

  • pan108xxb1_evb：表示主控是封装为 32 pin、Flash 大小为 1MB 的 PAN108x EVB

  • pan108xxb1_mesh_dongle：表示主控是封装为 32 pin、Flash 大小为 1MB 的 PAN108x Mesh Dongle Board

  • pan108xxb5_evb：表示主控是封装为 64 pin、Flash 大小为 1MB 的 PAN108x EVB

3.3 Project 与 Config 选择

Project 下拉列表中显示了<PAN1080-DK>\01_SDK\zephyr\samples_panchip及<PAN1080-DK>\01_SDK\zephyr\tests_panchip目录下的所有的 App Project：

image

Project 选择

Config 下拉列表中显示了当前 App Project 的所有普通 Config 或 Overlay Config 文件：

image

Project Config 选择

注：Config 选择菜单右侧有一个名为 U 的小按钮，可以用于 Update Board/Project/Config 列表，例如当我们在 samples_panchip 目录下新增了一个 Project，在不重新打开 ZAL 工具的条件下，点击此按钮即可将新增的 Project 更新至列表中。

3.4 自定义 App 工程目录

ZAL 工具默认只会扫描 zephyr\samples_panchip 和 zephyr\tests_panchip 两个目录下的 App 工程，而从 ZAL v1.5.0 版本开始，我们新增了用户自定义 App 路径的功能，用户可以根据自己的需要将自己开发的 App 项目指定到任意目录中。

作为演示，此处以pan1080-dk-internal目录顶层为例，复制了一个basic_custom文件夹(来源：pan1080-dk-internal\01_SDK\zephyr\samples_panchip\basic)，该文件夹中包含许多子项目：

image

用于自定义路径 app 演示的 demo

添加自定义 app 路径后，新增的 app 项目显示如下：

image

自定义路径 app 下拉列表

3.5 输出目录

在执行 Build / Rebuild 操作时，ZAL会自动创建输出目录；在执行 Flash 操作时，ZAL会从自动创建的输出目录中查找编译生成的 Image 文件进行烧录。

ZAL根据不同的 Board 和 Project 选择生成不同名称的输出目录，规则为output_folder = <PAN108x-DK>\01_SDK\build\<app_name>_<conf_name>_<board_name>，其中：

  1. <PAN108x-DK>表示前面工具配置阶段设置的PAN108x-DK Path目录；

  2. <app_name>表示前面 Project 选择阶段设置目录，例如当我们选择 Project 为<01_SDK\zephyr\samples_panchip\basic\synchronization>时，<app_name>表示 synchronization；

  3. <conf_name>表示前面 Config 选择阶段设置的 App Config（*.conf）文件名；

  4. <board_name>表示前面 Board 选择阶段设置的 Board 名称；

3.6 基本功能：Build

Board 和 Project 选择完成后，点击 Build 按钮，即可开始编译（增量编译），软件底部 Log 窗口会显示编译过程，完成后如下图所示：

image

Build 按钮功能

注：Build 按钮含有增量编译的功能，即如果当前选择的Board+Project+Config：

  1. 之前没有编译过，则会执行重新编译命令；

  2. 如果之前编译过，则会执行增量编译命令；

  3. 在编译过程中，Build 按钮会变成 Cancel 按钮，点击后可以强制停止编译

3.7 基本功能：Rebuild

点击 Rebuild 按钮，即可开始重新编译，软件底部 Log 窗口会显示编译过程，完成后如下图所示：

image

Rebuild 按钮功能

注：在编译过程中，Rebuild 按钮会变成 Cancel 按钮，点击后可以强制停止编译

3.8 基本功能：Flash

点击 Flash 按钮，即可开始烧录，软件底部 Log 窗口会显示烧录指令，稍后会弹出 JLink 烧录过程对话框，如下图所示：

image

Flash 按钮功能

3.9 基本功能：Erase

点击 Erase 按钮，即可开始擦除全部 Flash，软件底部 Log 窗口会显示擦除指令，稍后会弹出 JLink 擦除过程对话框，如下图所示：

image

Erase 按钮功能

3.10 基本功能：Open IDE

点击 Open IDE 按钮，即可使用 Toolchain 中自带的 VS Code 打开当前选择的 App 工程，如果打开成功，则软件状态栏右下角会提示“Open VS Code success”，如下图所示：

image

Open IDE 按钮功能

VS Code 打开成功：

image

成功打开 VS Code

注：第一次打开 VS Code 的速度可能会比较慢，只要状态栏提示打开成功，就说明 VS Code 程序已被成功唤起，只需耐心等待片刻即可。

3.11 基本功能：Open Build Output Folder

点击 Open Output Folader 按钮，即可打开当前工程的编译输出目录，软件底部状态栏会显示打开成功，如下图所示：

image

Open Output Folder 按钮

3.12 快捷键

ZAL支持常用操作的快捷键功能。在软件主界面中，按住键盘 Alt 键，可以看到菜单栏和功能按钮名称中的某个字符下方出现下划线，即表示此菜单或功能按钮支持快捷键：

image

工具快捷键

目前软件支持的快捷键功能及其对应键位如下：

功能

快捷键

Build

Alt + B

Rebuild

Alt + R

Flash

Alt + F

Erase

Alt + E

Open IDE

Alt + I

Open Output Folder

Alt + O

Update

Alt + U

Help

Alt + H

4 Tips

  1. ZAL第一次打开后，会在自身目录中创建一个名为 config.ini 的配置文件，用来记录软件的一些设置，比如配置的路径信息、当前选择的 Board 和 Project 信息、甚至软件的窗口大小和位置等，以方便软件后续打开使用。

  2. ZAL是绿色软件，其本身可以被拷贝到任何目录中，只需注意把ZAL所在的目录（名为ZAL-win32-x64）整体拷贝即可。

  3. 在SDK快速入门文档中编译工具链配置部分我们提到，编译工具链Toolchain目录，需要解压缩到<PAN1080-DK>\05_TOOLS目录下方能正常使用；而实际上，此要求是为了保证命令行编译功能（<PAN1080-DK>\01_SDK\PAN1080 SDK CLI）能够正常使用而提出的。单就ZAL工具来说，Toolchain目录可以存放在 PC 中的任意目录中（需要注意路径中不能有中文或空格），例如，我们可以把Toolchain目录解压到与<PAN1080-DK>同级的目录中，并将其重命名：

    image

    将编译工具链目录移动到其他地方

    然后在ZAL中配置修改后的Toolchain目录即可：

    image

    重新指定编译工具链目录

    注：将Toolchain移到<PAN1080-DK>外面，带来的好处是不需要每次更新 PAN1080-DK 的时候，都重新解压一份Toolchain放到<PAN1080-DK>\05_TOOLS目录下，而是可以直接使用ZAL，只需配置正确的路径即可。但需要注意，这样做将使得我们后面只能使用ZAL来编译 App 程序，无法再使用命令行编译进行编译。

  4. 当点击Open IDE按钮，打开 VS Code 时，若当前选择的 Project 是第一次打开，则会默认打开当前 App 的 main.c 文件；若当前选择的 Project 不是第一次打开，则会恢复上一次 Project 关闭时的文件打开状态。