本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 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 UI 中指定設定檔名稱。如需設定檔的詳細資訊，請參閱[組態和登入資料檔案設定](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 中，開啟導覽功能表，然後選擇**建立新組態**。
**重要**  
您必須先設定 AWS 登入資料，才能開啟 UI。如果您尚未設定登入資料，請關閉 IDT-FreeRTOS UI 瀏覽器視窗，遵循 中的步驟[設定 AWS 登入資料](#configure-aws-credentials)，然後重新開啟 IDT-FreeRTOS UI。

1. 遵循組態精靈來輸入用於執行資格測試的 IDT 組態設定。精靈會在位於 `devicetester-extract-location/config`目錄中的 JSON 組態檔案中設定下列設定。
   + **AWS settings**—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`欄位中設定，以及 `device.json` 檔案中裝置集區的 `devices`區塊。
   + **網路**：測試裝置網路通訊支援的設定。這些設定是在 `device.json` 檔案的 `features` 區塊，以及 檔案的 `clientWifiConfig`和 `testWifiConfig`區塊中設定`userdata.json`。
   + **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` 檔案的 `features`區塊和 `resource.json`檔案中設定。
   + **OTA** - 執行 OTA 功能測試的設定。這些設定是在 `device.json` 檔案的 `features`區塊和 `userdata.json`檔案中設定。

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 會執行資格測試，並在測試**執行器**主控台中顯示測試執行摘要和任何錯誤。測試執行完成後，您可以從下列位置檢視測試結果和日誌：
+ 測試結果位於 `devicetester-extract-location/results/execution-id`目錄中。
+ 測試日誌位於 `devicetester-extract-location/results/execution-id/logs`目錄中。

如需測試結果和日誌的詳細資訊，請參閱 [檢視 IDT for FreeRTOS 結果](view-results-frq.md)和 [檢視 IDT for FreeRTOS 日誌](view-logs-frq.md)。