isabella232 / amazon-freertos

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)

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 Amazon FreeRTOS, refer to the Getting Started section of Amazon 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 Amazon FreeRTOS, refer to the Amazon FreeRTOS User Guide.

Supported Hardware

For additional boards that are supported for Amazon FreeRTOS, please visit the AWS Device Catalog

The following MCU boards are supported for Amazon FreeRTOS:

1. Texas Instruments - CC3220SF-LAUNCHXL.
   • Getting Started Guide
   • IDEs: Code Composer Studio, IAR Embedded Workbench
2. STMicroelectronics - STM32L4 Discovery kit IoT node.
   • Getting Started Guide
   • IDE: STM32 System Workbench
3. NXP - LPC54018 IoT Module.
   • Getting Started Guide
   • IDEs: IAR Embedded Workbench, MCUXpresso IDE
4. Microchip - Curiosity PIC32MZEF.
   • Getting Started Guide
   • IDE: MPLAB X IDE
5. Espressif - ESP32-DevKitC, ESP-WROVER-KIT.
   • Getting Started Guide
6. Infineon - Infineon XMC4800 IoT Connectivity Kit
   • Getting Started Guide
   • IDE: DAVE
7. Xilinx - Xilinx Zynq-7000 based MicroZed Industrial IoT Bundle
   • Getting Started Guide
   • IDE: Xilinx SDK
8. MediaTek - MediaTek MT7697Hx Development Kit
   • Getting Started Guide
   • IDE: Keil uVision
9. Renesas - Renesas Starter Kit+ for RX65N-2MB
   • Getting Started Guide
   • IDE: e2 studio
10. Cypress CYW54907 - Cypress CYW954907AEVAL1F Evaluation Kit
    • Getting Started Guide
    • IDE: WICED Studio
11. Cypress CYW43907 - Cypress CYW943907AEVAL1F Evaluation Kit
    • Getting Started Guide
    • IDE: WICED Studio
12. Marvell MW320 - Marvell MW320 AWS IoT Starter Kit
    • Getting Started Guide
13. Marvell MW322 - Marvell MW322 AWS IoT Starter Kit
    • Getting Started Guide
14. Nordic nRF52840 DK - nRF52840 DK Development kit
    • Getting Started Guide
15. Nuvoton - NuMaker-IoT-M487
    • Getting Started Guide
16. Windows Simulator - To evaluate Amazon 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.