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.

Amazon FreeRTOS Demos

Amazon FreeRTOS includes some demo applications in the demos folder, under the main Amazon FreeRTOS directory. All of the examples that can be executed by Amazon FreeRTOS appear in the common folder, under demos. There is also a folder for each Amazon FreeRTOS-qualified platform under the demos folder. If you use the Amazon FreeRTOS console, only the target platform you choose has a subdirectory under demos.

Before you try the demo applications, we recommend that you complete the tutorial in Getting Started with Amazon FreeRTOS. It shows you how to set up and run the Hello World MQTT demo.

Running the Amazon FreeRTOS Demos

The following topics show you how to set up and run the Amazon FreeRTOS demos:

The DEMO_RUNNER_RunDemos() function, located in <amazon-freertos>/demos/demo_runner/iot_demo_runner.c, initializes a detached thread on which a single demo application runs. By default, DEMO_RUNNER_RunDemos() only calls the starts the Hello World MQTT demo. Depending on the configuration you selected when you downloaded Amazon FreeRTOS, and depending on where you downloaded Amazon FreeRTOS, the other example runner functions might start by default. To enable a demo application, open <amazon-freertos>/vendors/<vendor>/boards/<board>/aws_demos/config_files/aws_demo_config.h, and define the demo that you want to run.


Be aware that not all combinations of examples work together. Depending on the combination, the software might fail to execute on the selected target due to memory constraints. We recommend that you run one demo at a time.

Configuring the Demos

The demos have been configured to get you started quickly. You might want to change some of the configurations for your project to create a version that runs on your platform. You can find configuration files at vendors/<vendor>/boards/<board>/aws_demos/config_files.