Use the IDT for FreeRTOS user interface to run the FreeRTOS qualification suite 2.0 (FRQ 2.0) - FreeRTOS
PrerequisitesConfigure AWS credentialsOpen the IDT for FreeRTOS UICreate a new configurationModify an existing configurationRun qualification tests

Use the IDT for FreeRTOS user interface to run the FreeRTOS qualification suite 2.0 (FRQ 2.0)

AWS IoT Device Tester for FreeRTOS (IDT for FreeRTOS) includes a web-based user interface (UI) where you can interact with the IDT command line application and related configuration files. You use the IDT for FreeRTOS UI to create a new configuration, or modify an existing one, for your device. You can also use the UI to call the IDT application and run the FreeRTOS tests against your device.

For information about how to use the command line to run qualification tests, see Preparing to test your microcontroller board for the first time.

This section describes the prerequisites for the IDT for FreeRTOS UI and how to run qualifications tests from the UI.

Prerequisites

To run tests through the AWS IoT Device Tester (IDT) for FreeRTOS UI, you must complete the prerequisites on the Prerequisites page for IDT FreeRTOS Qualification (FRQ) 2.x.

Configure AWS credentials

You must configure your IAM user credentials for the AWS user you created in Create and configure an AWS account. You can specify your credentials in one of two ways:

  • In a credentials file

  • As environment variables

IDT uses the same credentials file as the AWS CLI. For more information, see Configuration and credential files.

The location of the credentials file varies based on the operating system you use:

  • macOS and Linux – ~/.aws/credentials

  • Windows – C:\Users\UserName\.aws\credentials

Add your AWS credentials to the credentials file in the following format:

[default]
aws_access_key_id = your_access_key_id
aws_secret_access_key = your_secret_access_key
Note

If you don't use the default AWS profile, you must specify the profile name in the IDT for FreeRTOS UI. For more information about profiles, see Named profiles.

Environment variables are variables maintained by the operating system and used by system commands. They're not saved if you close the SSH session. The IDT for FreeRTOS UI uses the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables to store your AWS credentials.

To set these variables on Linux, macOS, or Unix, use export:

export AWS_ACCESS_KEY_ID=your_access_key_id
export AWS_SECRET_ACCESS_KEY=your_secret_access_key

To set these variables on Windows, use set:

set AWS_ACCESS_KEY_ID=your_access_key_id
set AWS_SECRET_ACCESS_KEY=your_secret_access_key

Open the IDT for FreeRTOS UI

To open the IDT for FreeRTOS UI

  1. Download a supported IDT for FreeRTOS version. Then extract the downloaded archive to a directory that you have read and write permissions for.

  2. Navigate to the IDT for FreeRTOS installation directory:

    cd devicetester-extract-location/bin

  3. Run the following command to open the IDT for FreeRTOS UI:

    Linux
    .devicetester_ui_linux_x86-64
    Windows
    ./devicetester_ui_win_x64-64
    macOS
    ./devicetester_ui_mac_x86-64
    Note

    In macOS, to allow your system to run the UI, go to System Preferences -> Security & Privacy. When you run the tests, you may need to do this three more times. this

    The IDT for FreeRTOS UI opens in your default browser. The latest three major versions of the following browsers support the UI:

    • Google Chrome

    • Mozilla Firefox

    • Microsoft Edge

    • Apple Safari for macOS

    Note

    For a better experience, we recommend Google Chrome or Mozilla Firefox to access the IDT for FreeRTOS UI. Microsoft Internet Explorer isn't supported by the UI.

    Important

    You must configure your AWS credentials before you open the UI. If you haven't configured your credentials, close the IDT for FreeRTOS UI browser window, follow the steps in Configure AWS credentials, and then reopen the IDT for FreeRTOS UI.

Create a new configuration

If you're a first-time user, you must create a new configuration to set up the JSON configuration files that IDT for FreeRTOS requires to run tests. You can then run tests or modify the created configuration.

For examples of the config.json, device.json, and userdata.json files, see Preparing to test your microcontroller board for the first time.

To create a new configuration

  1. In the IDT for FreeRTOS UI, open the navigation menu, and choose Create new configuration.

  2. Follow the configuration wizard to enter the IDT configuration settings used to run qualification tests. The wizard configures the following settings in JSON configuration files located in the devicetester-extract-location/config directory.

    • Device settings – The device pool settings for the devices to be tested. These settings are configured in the id and sku fields, and the devices block for the device pool in the config.json file.

    • AWS account settings – The AWS account information that IDT for FreeRTOS uses to create AWS resources during test runs. These settings are configured in the config.json file.

    • FreeRTOS implementation – The absolute path to the FreeRTOS repository and ported code, and the FreeRTOS version you want to run IDT FRQ on. The paths to the execution and parameter config header files from the FreeRTOS-Libraries-Integration-Tests GitHub repository. The build and flash commands for your hardware that allow IDT to build and flash tests onto your board automatically. These settings are configured in the userdata.json file.

    • PKCS #11 labels and Echo server – The PKCS #11 labels that correspond to the keys provisioned in your hardware based on the key functionality and key provisioning method. The echo server configuration settings for the Transport Interface tests. These settings are configured in the userdata.json and device.json files.

    • Over-the-air (OTA) updates – The settings that control OTA functionality tests. These settings are configured in the features block of the device.json and userdata.json files.

  3. On the Review page, verify your configuration information.

After you finish reviewing your configuration, to run your qualification tests, choose Run tests.

Modify an existing configuration

If you have already set up configuration files for IDT for FreeRTOS, you can use the IDT for FreeRTOS UI to modify your existing configuration. The existing configuration files must be located in the devicetester-extract-location/config directory.

To modify a configuration

  1. In the IDT for FreeRTOS UI, open the navigation menu, and choose Edit existing configuration.

    The configuration dashboard displays information about your existing configuration settings. If a configuration is incorrect or unavailable, the status for that configuration is Error validating configuration.

  2. To modify an existing configuration setting, complete the following steps:

    1. Choose the name of a configuration setting to open its settings page.

    2. Modify the settings, and then choose Save to regenerate the corresponding configuration file.

  3. To modify the IDT for FreeRTOS test run settings, choose IDT test run settings in the edit view:

After you finish modifying your configuration, verify that all of your configuration settings pass validation. If the status for each configuration setting is Valid, you can run your qualification tests with this configuration.

Run qualification tests

After you create a configuration for the IDT for FreeRTOS UI you can run your qualification tests.

To run qualification tests

  1. In the navigation menu, choose Run tests.

  2. Choose Start tests to start the test run. By default, all applicable tests are run for your device configuration. IDT for FreeRTOS generates a qualification report when all tests finish.

IDT for FreeRTOS runs the qualification tests. It then displays the test run summary and any errors in the Test runner console. After the test run is complete, you can view the test results and logs from the following locations:

  • Test results are located in the devicetester-extract-location/results/execution-id directory.

  • Test logs are located in the devicetester-extract-location/results/execution-id/logs directory.

For more information about test results and logs, see Understanding results and logs.