Skip to content

Latest commit

 

History

History
121 lines (97 loc) · 9.12 KB

README.md

File metadata and controls

121 lines (97 loc) · 9.12 KB
Raw

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)

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:

  1. Texas Instruments - CC3220SF-LAUNCHXL.
  2. STMicroelectronics - STM32L4 Discovery kit IoT node.
  3. NXP - LPC54018 IoT Module,
  4. Microchip - Curiosity PIC32MZEF.
  5. Espressif - ESP32-DevKitC, ESP-WROVER-KIT, ESP32-WROOM-32SE
  6. Infineon - Infineon XMC4800 IoT Connectivity Kit, Optiga TrustX
  7. Xilinx - Xilinx Zynq-7000 based MicroZed Industrial IoT Bundle
  8. MediaTek - MediaTek MT7697Hx Development Kit
  9. Renesas - Renesas Starter Kit+ for RX65N-2MB
  10. Cypress CYW54907 - Cypress CYW954907AEVAL1F Evaluation Kit
  11. Cypress CYW43907 - Cypress CYW943907AEVAL1F Evaluation Kit
  12. Cypress PSoC 64 - PSoC 64 Standard Secure AWS Wi-Fi Bluetooth Pioneer Kit
  13. NXP MW320 - MW320 AWS IoT Starter Kit
  14. NXP MW322 - MW322 AWS IoT Starter Kit
  15. Nordic nRF52840 DK - nRF52840 DK Development kit
  16. Nuvoton - NuMaker-IoT-M487
  17. Windows Simulator - To evaluate FreeRTOS without using MCU-based hardware, you can use the Windows Simulator.

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