DEPRECATED
Announcement:
As of November 18th, 2022, this repository is deprecated. The contents of this repository will remain available but we will no longer provide updates or accept new contributions and pull requests. We recommend you start here for creating a new project. If you have an existing FreeRTOS project based on this repository, see the migration guide.
Over the years, AWS has improved the modularity of the FreeRTOS libraries and repository structure to make it easier for you to build and update FreeRTOS-based projects. This repository deprecation aligns with some of these significant initiatives:
- We decomposed libraries to include them in their individual repositories and removed interdependencies between each library giving you the flexibility to choose the FreeRTOS libraries and project structure that suits your project and toolchain.
- We split libraries that are AWS dependent and FreeRTOS dependent into separate repositories giving you the option to mix and match libraries that are specific to your board and use case.
- We provided feature stability, security patches, and critical bug fixes through the Long Term Support (LTS) libraries.
Have more questions? Post them in the FreeRTOS forum.
FreeRTOS AWS Reference Integrations
Cloning
This repo uses Git Submodules to bring in dependent components.
Note: If you download the ZIP file provided by GitHub UI, you will not get the contents of the submodules. (The ZIP file is also not a valid git repository)
If using Windows, because this repository and its submodules contain symbolic links, set core.symlinks to true with the following command:
git config --global core.symlinks true
In addition to this, either enable Developer Mode or, whenever using a git command that writes to the system (e.g. git pull, git clone, and git submodule update --init --recursive), use a console elevated as administrator so that git can properly create symbolic links for this repository. Otherwise, symbolic links will be written as normal files with the symbolic links' paths in them as text. This gives more explanation.
To clone using HTTPS:
git clone https://github.com/aws/amazon-freertos.git --recurse-submodules
Using SSH:
git clone [email protected]:aws/amazon-freertos.git --recurse-submodules
If you have downloaded the repo without using the --recurse-submodules argument, you need to run:
git submodule update --init --recursive
Important branches to know
master --> Development is done continuously on this branch
release --> Fully tested released source code
release-candidate --> Preview of upcoming release
feature/* --> Alpha/beta of an upcoming feature
Getting Started
For more information on FreeRTOS, refer to the Getting Started section of FreeRTOS webpage.
To directly access the Getting Started Guide for supported hardware platforms, click the corresponding link in the Supported Hardware section below.
For detailed documentation on FreeRTOS, refer to the FreeRTOS User Guide.
AWS Collection of Metrics
The demos that connect to AWS IoT report metrics to AWS about the operating system, and the MQTT client library used by sending a specially formatted string in the username field of the MQTT CONNECT packet. These metrics help AWS IoT improve security and provide better technical support. Providing these metrics is optional for users, and these can be disabled by updating the following configuration macros in the demos/include/aws_iot_metrics.h file:
#define AWS_IOT_METRICS_STRING NULL
#define AWS_IOT_METRICS_STRING_LENGTH 0U
Format
The format of the username string with metrics is:
<Actual_Username>?SDK=<OS_Name>&Version=<OS_Version>MQTTLib=<MQTT_Library_name>@<MQTT_Library_version>
where
- Actual_Username is the actual username used for authentication (if a username/password is used for authentication).
- OS_Name is the Operating System the application is running on.
- OS_Version is the version number of the Operating System.
- MQTT_Library_name is the MQTT Client library being used.
- MQTT_Library_version is the version of the MQTT Client library being used.
FreeRTOS Qualified Boards
For a complete list of boards that have been qualified for FreeRTOS by AWS Partners, please visit the AWS Partner Device Catalog
In addition, AWS supports the following boards with FreeRTOS Build Integration and maintains them with each release:
- Texas Instruments - CC3220SF-LAUNCHXL.
- STMicroelectronics - STM32L4 Discovery kit IoT node.
- NXP - LPC54018 IoT Module,
- Espressif - ESP32-DevKitC, ESP-WROVER-KIT, ESP32-WROOM-32SE, ESP32-S2-SAOLA-1
- Infineon - Infineon XMC4800 IoT Connectivity Kit, Optiga TrustX
- Xilinx - Xilinx Zynq-7000 based MicroZed Industrial IoT Bundle
- MediaTek - MediaTek MT7697Hx Development Kit
- Renesas - Renesas Starter Kit+ for RX65N-2MB
- Cypress CYW54907 - Cypress CYW954907AEVAL1F Evaluation Kit
- Cypress CYW43907 - Cypress CYW943907AEVAL1F Evaluation Kit
- Cypress PSoC 64 - PSoC 64 Standard Secure AWS Wi-Fi Bluetooth Pioneer Kit
- NXP MW320 - MW320 AWS IoT Starter Kit
- NXP MW322 - MW322 AWS IoT Starter Kit
- Nordic nRF52840 DK - nRF52840 DK Development kit
- Nuvoton - NuMaker-IoT-M487
- Windows Simulator - To evaluate FreeRTOS without using MCU-based hardware, you can use the Windows Simulator.
- Requirements: Microsoft Windows 7 or newer, with at least a dual core and a hard-wired Ethernet connection
- Getting Started Guide
- IDE: Visual Studio Community Edition
amazon-freeRTOS/projects
The ./projects folder contains the IDE test and demo projects for each vendor and their boards. The majority of boards can be built with both IDE and cmake (there are some exceptions!). Please refer to the Getting Started Guides above for board specific instructions.
Mbed TLS License
This repository uses Mbed TLS under Apache 2.0.
amazon-freerTOS/vendors License
The ./vendors directory contains content that may be subject to different license terms. For vendor licensing information, see the LICENSE files or source header documentation for each vendor directory.
CBMC
The tools/cbmc/proofs directory contains CBMC proofs.
To learn more about CBMC and proofs specifically, review the training material here.
In order to run these proofs you will need to install CBMC and other tools by following the instructions here.