Amazon FreeRTOS
User 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.

Downloading Amazon FreeRTOS

You can download Amazon FreeRTOS from the Amazon FreeRTOS console or from GitHub.

If you are following the Quick Connect workflow in the Amazon FreeRTOS console, follow the download instructions in the workflow on the console, and ignore the following procedures.

To download Amazon FreeRTOS from the Amazon FreeRTOS console

  1. Go to the Amazon FreeRTOS console.

  2. Under Predefined configurations, find Connect to AWS IoT- Platform, and then choose Download.

  3. Unzip the downloaded file to a folder, and make a note of the folder path. In the tutorials, this folder is referred to as <amazon-freertos>.

    Note

    The maximum length of a file path on Microsoft Windows is 260 characters. The longest path in the Amazon FreeRTOS download is 122 characters. To accommodate the files in the Amazon FreeRTOS projects, make sure that the path to the <amazon-freertos> directory is fewer than 98 characters long. For example, C:\Users\Username\Dev\AmazonFreeRTOS works, but C:\Users\Username\Documents\Development\Projects\AmazonFreeRTOS causes build failures.

Note

If you are getting started with the Cypress CYW954907AEVAL1F or CYW943907AEVAL1F development kits, you must download Amazon FreeRTOS from GitHub. Configurations of Amazon FreeRTOS for these boards are currently not available from the Amazon FreeRTOS console.

To download Amazon FreeRTOS from GitHub

  1. Browse to the Amazon FreeRTOS GitHub repository.

  2. Choose Clone or download.

  3. From the command line on your computer, clone the repository to a directory on your host machine.

    git clone https://github.com/aws/amazon-freertos.git
  4. From the amazon-freertos directory, check out the branch that you want to use.

Note

The maximum length of a file path on Microsoft Windows is 260 characters. Lengthy Amazon FreeRTOS download directory paths can cause build failures.

In the Getting Started documentation, the path to the Amazon FreeRTOS download directory is referred to as <amazon-freertos>.

After you download Amazon FreeRTOS, you can continue to Configuring the Amazon FreeRTOS Demos.