Amazon FreeRTOS
Qualification Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Getting Started Guide Template

Write an overview that provides a brief description of the board. This section should answer the following questions:

  • Which hardware is required to run the Amazon FreeRTOS Hello World demo?

    Provide links to pages on your company website for more detail.

  • Which IDEs are supported for developing applications for the board?

    Provide links to IDE user guides and download pages.

  • Which toolchains and other software utilities are required for development?

    Provide links to user guides and download pages.

  • Are there any other prerequisites for getting started with Amazon FreeRTOS on the board?

    Provide links to purchasing pages, user guides, and download pages.

Setting Up Your Hardware

In this section, provide instructions for setting up the platform's hardware. Make sure that you provide links to any user guides or other documentation for setting up hardware.

These instructions include the following:

  • Configuring jumper settings.

  • Downloading and installing drivers.

    Provide links to download pages and other documentation for supported driver versions.

  • Connecting the board to a computer.

  • Any other steps required to set up the hardware.

Setting Up the Development Environment

In this section, provide instructions for setting up the platform's supported development environment. Make sure that you provide links to any download pages, user guides, or other documentation for each item.

These instructions include the following:

  • Establishing a serial connection.

  • Downloading and installing the toolchain.

  • Downloading and installing a supported IDE.

  • Any other software that is required to develop and debug applications for the device.

Build and Run the Amazon FreeRTOS Demo Project

Build the Amazon FreeRTOS Demo

In this section, provide instructions for building the Amazon FreeRTOS demo code in a supported IDE, or with supported command line tools.

Note

You must provide instructions for building the demo application on your board with CMake.

Run the Amazon FreeRTOS Demo Project

In this section, provide instructions for flashing and running the Amazon FreeRTOS demo code on your board.

Debugging

In this section, provide instructions for using on-board or external debuggers.

Troubleshooting

In this section, provide troubleshooting tips for resolving common or potential problems.