本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 开始使用 IDT-FreeRTOS UI
<a name="dev-tester-ui-getting-started"></a>

本节介绍如何使用 IDT-FreeRTOS UI 来创建或修改配置，然后介绍了如何运行测试。

**Topics**
+ [

## 配置 AWS 凭证
](#configure-aws-credentials)
+ [

## 打开 IDT-FreeRTOS UI
](#open-idt-ui)
+ [

## 创建新的配置
](#create-new-configuration)
+ [

## 修改现有配置
](#modify-existing-configuration)
+ [

## 运行资格认证测试
](#run-tests-from-ui)

## 配置 AWS 凭证
<a name="configure-aws-credentials"></a>

您必须为在中创建的 AWS 用户配置凭据[创建和配置 AWS 账户](dev-tester-ui-prereqs.md#ui-config-aws-account)。您可以采用以下两种方法之一来指定凭证：
+ 在凭证文件中
+ 作为环境变量

### 使用 AWS 凭证文件配置凭证
<a name="config-cred-file"></a>

IDT 使用与 AWS CLI相同的凭证文件。有关更多信息，请参阅[配置和凭证文件](https://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html)。

凭证文件的位置因您使用的操作系统而异：
+ macOS、Linux：`~/.aws/credentials`
+ Windows：`C:\Users\UserName\.aws\credentials`

按以下格式将您的 AWS 凭证添加到`credentials`文件中：

```
[default]
aws_access_key_id = <your_access_key_id>
aws_secret_access_key = <your_secret_access_key>
```

**注意**  
如果您不使用`default` AWS 配置文件，请务必在 IDT-FreeRTOS 用户界面中指定配置文件名称。有关配置文件的更多信息，请参阅[配置和凭证文件设置](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html)。

### 使用环境变量配置 AWS 凭证
<a name="config-env-vars"></a>

环境变量是由操作系统维护且由系统命令使用的变量。如果您关闭 SSH 会话，则不会保存。IDT-FreeRTOS UI 使用 `AWS_ACCESS_KEY_ID` 和 `AWS_SECRET_ACCESS_KEY` 环境变量来存储您的 AWS 凭证。

要在 Linux、macOS 或 Unix 上设置这些变量，请使用 **export**：

```
export AWS_ACCESS_KEY_ID=<your_access_key_id>
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
```

要在 Windows 上设置这些变量，请使用 **set**：

```
set AWS_ACCESS_KEY_ID=<your_access_key_id>
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>
```

## 打开 IDT-FreeRTOS UI
<a name="open-idt-ui"></a>

**打开 IDT-FreeRTOS UI**

1. 下载支持的 IDT-FreeRTOS 版本，并将下载的存档提取到文件系统上您有读写权限的位置。

1. 运行以下命令以导航到 IDT-FreeRTOS 安装目录：

   ```
   cd devicetester-extract-location/bin 
   ```

1. 运行以下命令以打开 IDT-FreeRTOS UI：

------
#### [ Linux ]

   ```
   .devicetestergui_linux_x86-64.exe
   ```

------
#### [ Windows ]

   ```
   ./devicetestergui_win_x64-64
   ```

------
#### [ macOS ]

   ```
   ./devicetestergui_mac_x86-64
   ```

**注意**  
在 Mac 上，要允许您的系统运行此 UI，请转到**系统首选项 -> 安全和隐私**。当您运行测试时，可能需要再执行三次。

------

   IDT-FreeRTOS UI 将在您的默认浏览器中打开。有关支持的浏览器的信息，请参阅[使用支持的 Web 浏览器](dev-tester-ui-prereqs.md#idt-ui-supported-web-browser)。

## 创建新的配置
<a name="create-new-configuration"></a>

如果您是首次使用的用户，则必须创建一个新配置来设置 IDT-FreeRTOS 运行测试所需的 JSON 配置文件。然后，您可以运行测试或修改已创建的配置。

有关 `config.json`、`device.json` 和 `userdata.json` 文件的示例，请参阅[首次测试微控制器主板](qual-steps.md)。有关仅用于运行低功耗蓝牙 (BLE) 测试的 `resource.json` 文件的示例，请参阅[运行低功耗蓝牙测试](afr-bridgekeeper-dt-bt.md)。

**创建新的配置**

1. 在 IDT-FreeRTOS UI 中，打开导航菜单，然后选择**创建新配置**。
**重要**  
在打开 UI 之前，您必须配置您的 AWS 凭据。如果您尚未配置凭证，请关闭 IDT-FreeRTOS UI 浏览器窗口，按照[配置 AWS 凭证](#configure-aws-credentials)中的步骤操作，然后重新打开 IDT-FreeRTOS UI。

1. 按照配置向导输入用于运行资格认证测试的 IDT 配置设置。该向导在 `devicetester-extract-location/config` 目录中的 JSON 配置文件中配置以下设置。
   + **AWS 设置** — IDT-FreeRTOS 在测试运行期间用于创建 AWS 资源 AWS 账户 的信息。这些设置在 `config.json` 文件中进行配置。
   + **FreeRTOS 存储库** – FreeRTOS 存储库和移植代码的绝对路径，以及您要执行的资格认证类型。这些设置在 `userdata.json` 文件中进行配置。

     在运行资格认证测试之前，必须为设备移植 FreeRTOS。有关更多信息，请参阅[《FreeRTOS 移植指南》](https://docs.aws.amazon.com/freertos/latest/portingguide/)。
   + **构建和刷写** – 适用于您的硬件的构建和刷写命令，允许 IDT 在您的主板上自动构建和刷写测试。这些设置在 `userdata.json` 文件中进行配置。
   + **设备** – 要测试的设备的设备池设置。这些设置在 `id` 和 `sku` 字段中配置，设备池的 `devices` 数据块位于 `device.json` 文件中。
   + **网络** – 用于测试您的设备是否支持网络通信的设置。这些设置在 `device.json` 文件的 `features` 数据块中，以及 `userdata.json` 文件的 `clientWifiConfig` 和 `testWifiConfig` 数据块中配置。
   + **Echo 服务器** – 用于安全套接字测试的 Echo 服务器配置设置。这些设置在 `userdata.json` 文件中进行配置。

     有关 Echo 服务器配置的更多信息，请参阅 [https://docs.aws.amazon.com/freertos/latest/portingguide/afr-echo-server.html](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-echo-server.html)。
   + **CMake**—（可选）运行 CMake 生成功能测试的设置。只有当您使用 CMake 作为构建系统时，才需要此配置。这些设置在 `userdata.json` 文件中进行配置。
   + **BLE** – 运行低功耗蓝牙功能测试的设置。这些设置在 `device.json` 文件和 `resource.json` 文件的 `features` 数据块中配置。
   + **OTA** – 运行 OTA 功能测试的设置。这些设置在 `device.json` 文件和 `userdata.json` 文件的 `features` 数据块中配置。

1.  在**审核**页面上，验证您的配置信息。

审核配置完成后，要运行资格认证测试，请选择**运行测试**。

## 修改现有配置
<a name="modify-existing-configuration"></a>

如果您已经为 IDT 设置了配置文件，则可以使用 IDT-FreeRTOS UI 修改现有配置。确保您的现有配置文件在 `devicetester-extract-location/config` 目录中可用。

**修改新的配置**

1. 在 IDT-FreeRTOS UI 中，打开导航菜单，然后选择**编辑现有配置**。

   配置控制面板会显示有关现有配置设置的信息。如果配置不正确或不可用，则配置的状态为 `Error validating configuration`。

1. 要修改现有配置设置，请完成以下步骤：

   1. 选择配置设置的名称以打开其设置页面。

   1. 修改设置，然后选择**保存**，以便重新生成相应的配置文件。

修改配置完成后，请确认所有配置设置均可通过验证。如果每个配置设置的状态为 `Valid`，则可以使用此配置运行资格认证测试。

## 运行资格认证测试
<a name="run-tests-from-ui"></a>

为 IDT-FreeRTOS 创建配置后，即可开始运行资格认证测试。

**运行资格认证测试**

1. 验证配置。

1. 在导航菜单中，选择**运行测试**。

1. 要开始运行测试，请选择**开始测试**。

IDT-FreeRTOS 运行资格认证测试，并在 **Test Runner** 控制台中显示测试运行摘要和所有错误。测试运行完成后，您可以从以下位置查看测试结果和日志：
+ 测试结果位于 `devicetester-extract-location/results/execution-id` 目录中。
+ 测试日志位于 `devicetester-extract-location/results/execution-id/logs` 目录中。

有关测试结果和日志的更多信息，请参阅[查看适用于 FreeRTOS 的 IDT 的结果](view-results-frq.md)和[查看适用于 FreeRTOS 的 IDT 的日志](view-logs-frq.md)。