IC:

概述

在SDK中，有两种类型的示例：

类型	路径	描述
应用示例	{SDK}\component\example	xml, ssl, …
外设示例	{SDK}\component\example\peripheral	ADC, UART, I2C, SPI, Timer, …

本章介绍两种SDK示例的内容，以及如何编译它们。

应用示例

每个应用示例的文件夹中，包含c代码源文件、头文件和 README.txt。请根据 README.txt 确认每个示例的详细配置。

备注

所有Realtek Ameba SoC共用同一份应用示例，请参照 README.txt 来获取不同Ameba SoC的详细配置信息。

应用示例的入口函数是 app_example()，每个应用示例都有自己的 app_example()。

当编译应用示例时，位于 {SDK}\amebadplus_gcc_project\project_km4\src 路径下的 main.c 文件中的 app_example() 会自动被替换。

// default main
int main(void)
{
   ...
   app_example();
   ...
   /* enable schedule, start kernel */
   vTaskStartSchedule();
}

应用示例默认运行在KM4上。运行步骤如下：

例如：如果想编译 XML 示例并启动 XML 示例线程，步骤如下：

当编译应用示例时，位于 {SDK}\amebalite_gcc_project\project_km4\src 或 {SDK}\amebalite_gcc_project\project_kr4\src 路径下的 main.c 文件中的 app_example() 会自动被替换。

// default main
int main(void)
{
   ...
   app_example();
   ...
   /* enable schedule, start kernel */
   vTaskStartSchedule();
}

应用示例默认运行在 AP（KM4/KR4）上。运行步骤如下：

例如：如果想编译 XML 示例并启动 XML 示例线程，步骤如下：

当编译应用示例时，位于 {SDK}\amebalite_gcc_project\project_km4\src 或 {SDK}\amebalite_gcc_project\project_kr4\src 路径下的 main.c 文件中的 app_example() 会自动被替换。

// default main
int main(void)
{
   ...
   app_example();
   ...
   /* enable schedule, start kernel */
   vTaskStartSchedule();
}

应用示例默认运行在 AP（KM4/KR4）上。运行步骤如下：

例如：如果想编译 XML 示例并启动 XML 示例线程，步骤如下：

当编译应用示例时，位于 {SDK}\amebasmart_gcc_project\project_ap\src 路径下的 main.c 文件中的 app_example() 会自动被替换。

// default main
int main(void)
{
   ...
   app_example();
   ...
   /* enable schedule, start kernel */
   vTaskStartSchedule();
}

应用示例默认运行在CA32上。运行步骤如下：

例如：如果想编译 XML 示例并启动 XML 示例线程，步骤如下：

外设示例为外设功能演示程序。大部分外设示例包含以下两种类型，开发者可根据项目需求自由选择。

类型	路径	描述
mbed	{SDK}\component\example\peripheral\{peripheral}\mbed	使用mbed框架API
raw	{SDK}\component\example\peripheral\{peripheral}\raw	使用底层驱动API

每个示例文件夹中包含以下核心文件：

外设示例通常运行在KM4上。运行步骤如下：

阅读示例目录下的 README.txt 文件，确认软硬件配置要求。
用示例中的 main.c 文件替换 {SDK}\amebadplus_gcc_project\project_km4\src 目录下的 main.c 文件。
（可选）必要时，将 main.c 中提及的其他头文件也复制到 {SDK}\amebadplus_gcc_project\project_km4\src 目录。
使用 make 目录重新编译工程。

外设示例通常运行在AP（KM4 或 KR4）上。运行步骤如下：

阅读示例目录下的 README.txt 文件，确认软硬件配置要求。
用示例中的 main.c 文件替换 {SDK}\amebalite_gcc_project\project_km4\src 或 \amebalite_gcc_project\project_kr4\src 目录下的 main.c 文件。
（可选）必要时，将 main.c 中提及的其他头文件也复制到 {SDK}\amebalite_gcc_project\project_km4\src 或 \amebalite_gcc_project\project_kr4\src 目录。
使用 make 目录重新编译工程。

外设示例通常运行在AP（KM4 或 KR4）上。运行步骤如下：

阅读示例目录下的 README.txt 文件，确认软硬件配置要求。
用示例中的 main.c 文件替换 {SDK}\amebalite_gcc_project\project_km4\src 或 \amebalite_gcc_project\project_kr4\src 目录下的 main.c 文件。
（可选）必要时，将 main.c 中提及的其他头文件也复制到 {SDK}\amebalite_gcc_project\project_km4\src 或 \amebalite_gcc_project\project_kr4\src 目录。
使用 make 目录重新编译工程。

外设示例通常运行在CA32上。运行步骤如下：

阅读示例目录下的 README.txt 文件，确认软硬件配置要求。
用示例中的 main.c 文件替换 {SDK}\amebasmart_gcc_project\project_ap\src 目录下的 main.c 文件。
（可选）必要时，将 main.c 中提及的其他头文件也复制到 {SDK}\amebasmart_gcc_project\project_ap\src 目录。
使用 make 目录重新编译工程。