Quick start instructions
FreeRTOS.org has been ported to many different architectures and compilers. Each port is accompanied by a pre-configured demo application to get you up and running quickly. Better still, each demo application is accompanied by a documentation page providing full information on locating the demo project source code, building the demo project, and configuring the target hardware.
To get up an running in minutes - follow these easy instructions:
- Locate the relevant documentation page:
Expand the "Supported Devices" menu (see image on right) to reveal a list of microcontroller vendors that are supported by FreeRTOS. Clicking a vendor name will take you to a list of documentation pages specific to that vendor.
Refer to the Modifying a demo application to run on different hardware page should a pre-configured port not be available for your development board.
- Obtaining the source code:
Download the FreeRTOS .zip file. This contains the kernel source code and demo projects for every official port. Unzip the files into a convenient directory.
- Building the project:
Follow the instruction on the port documentation page to locate, open and build the demo project.
- Running the demo application:
Follow the instructions on the port documentation page to setup the target hardware, download and execute the demo application. The same documentation page will provide information on the functionality of the demo application so you know if it is executing correctly or not.
That is it! Also see the FreeRTOS eBooks for an additional and valuable resource.
Port documentation pages are grouped by device manufacturer. Expand the list of supported devices, then click the manufacturer of interest to be taken to a list of demo documentation pages.
Next steps - further reading
The simplest way to create your own FreeRTOS application is to base it on the demo application that is provided for your chosen port. Once you have the demo application running, incrementally remove the demo functions and source files and replace them with your own application code.Following are some shortcuts to valuable information for the serious developer:
- The API reference is accessible through the API Reference menu. For example, the image on the right shows how to access documentation on all the FreeRTOS Task Control functions. A pdf Reference Manual is also available.
- Understanding the FreeRTOS directory structure.
- An introduction to the demo application projects.
- Modifying a demo application to run on different hardware.
- Understanding the FreeRTOS license.
- FAQ: My application does not run, what could be wrong?
- Obtaining free support.
- Obtaining commercial support and development services.
Locating documentation for the FreeRTOS API