diff --git a/FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/readme.txt b/FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/readme.txt index 9c6dfc90fd..94921b99e5 100755 --- a/FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/readme.txt +++ b/FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/readme.txt @@ -1,26 +1,28 @@ *** INTRODUCTION *** -Development is now underway that will enable us to provide long-term support (LTS) -releases of FreeRTOS. An LTS release is maintained separately from the main -codebase. Typically, no new features are added after release, but critical bugs -and security vulnerabilities are patched for years after launch. +We are currently working to improve the modularity and memory usage of new +FreeRTOS IoT libraries before releasing the libraries into the main FreeRTOS +download with long term support (LTS). https://freertos.org/ltsroadmap.html +contains a description of the libraries that target modularity and code quality +criteria. An LTS release is only updated with bug and vulnerability patches, +not new features. This zip file contains (among other updates) a +work-in-progress snapshot of the MQTT library, which is near completion. The +MQTT library is now much easier to bring into any project, including projects +that do not use FreeRTOS. -We are currently working to improve modularity and memory usage of FreeRTOS -libraries to ensure the FreeRTOS LTS release helps our users cover a wider set of use cases. - -For additional details on LTS and the supported libraries, -refer to https://freertos.org/ltsroadmap.html +The zip file also contains significant enhancements to the over the air (OTA) +update agent. Specifically, it is now possible to pause and resume an +in-progress update. *** INSTRUCTIONS *** The pre-configured projects use the FreeRTOS kernel Windows port (often called the Windows simulator) to enable their evaluation using the free Visual Studio tools and without needing specific microcontroller hardware. - -Additional details can be found at: https://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html +provides additional information on using the Windows port. -Instructions for configuring and using the FreeRTOS IoT libraries are in the -following links: +The following links provide instructions on using the FreeRTOS IoT +libraries: + https://www.FreeRTOS.org/mqtt/ + https://www.FreeRTOS.org/https/ @@ -35,6 +37,11 @@ following links: The Visual Studio projects for each of the FreeRTOS IoT library examples are located in sub-directories of the following top-level directories: + Demos using the refactored MQTT library: + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_plain_text + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_light_weight + + Demos not yet updated to the refactored MQTT library: + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/mqtt + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/https + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/shadow diff --git a/FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/readme.txt b/FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/readme.txt index 896684594b..94921b99e5 100644 --- a/FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/readme.txt +++ b/FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/readme.txt @@ -1,28 +1,35 @@ *** INTRODUCTION *** -Development is now underway that will enable us to provide long-term support (LTS) -releases of FreeRTOS. An LTS release is maintained separately from the main -codebase. Typically, no new features are added after release, but critical bugs -and security vulnerabilities are patched for years after launch. +We are currently working to improve the modularity and memory usage of new +FreeRTOS IoT libraries before releasing the libraries into the main FreeRTOS +download with long term support (LTS). https://freertos.org/ltsroadmap.html +contains a description of the libraries that target modularity and code quality +criteria. An LTS release is only updated with bug and vulnerability patches, +not new features. This zip file contains (among other updates) a +work-in-progress snapshot of the MQTT library, which is near completion. The +MQTT library is now much easier to bring into any project, including projects +that do not use FreeRTOS. -We are currently working to improve modularity and memory usage of FreeRTOS -libraries to ensure the FreeRTOS LTS release helps our users cover a wider set of use cases. - -For additional details on LTS and the supported libraries, -refer to https://freertos.org/ltsroadmap.html +The zip file also contains significant enhancements to the over the air (OTA) +update agent. Specifically, it is now possible to pause and resume an +in-progress update. *** INSTRUCTIONS *** The pre-configured projects use the FreeRTOS kernel Windows port (often called the Windows simulator) to enable their evaluation using the free Visual Studio tools and without needing specific microcontroller hardware. - -Additional details can be found at: https://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html +provides additional information on using the Windows port. -Instructions for configuring and using the FreeRTOS IoT libraries are in the -following links: +The following links provide instructions on using the FreeRTOS IoT +libraries: + https://www.FreeRTOS.org/mqtt/ + + https://www.FreeRTOS.org/https/ + + https://www.FreeRTOS.org/shadow/ + + https://www.FreeRTOS.org/jobs/ + + https://www.FreeRTOS.org/ota/ + + https://www.FreeRTOS.org/pkcs11/ *** LOCATING THE EXAMPLE PROJECTS *** @@ -30,7 +37,17 @@ following links: The Visual Studio projects for each of the FreeRTOS IoT library examples are located in sub-directories of the following top-level directories: - + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt + Demos using the refactored MQTT library: + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_plain_text + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_light_weight + + Demos not yet updated to the refactored MQTT library: + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/mqtt + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/https + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/shadow + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/jobs + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/ota + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/pkcs11 *** ADDITIONAL INFORMATION *** diff --git a/FreeRTOS-Plus/Demo/readme.txt b/FreeRTOS-Plus/Demo/readme.txt index d3276f6d4c..94921b99e5 100755 --- a/FreeRTOS-Plus/Demo/readme.txt +++ b/FreeRTOS-Plus/Demo/readme.txt @@ -1,26 +1,28 @@ *** INTRODUCTION *** -Development is now underway that will enable us to provide long-term support (LTS) -releases of FreeRTOS. An LTS release is maintained separately from the main -codebase. Typically, no new features are added after release, but critical bugs -and security vulnerabilities are patched for years after launch. +We are currently working to improve the modularity and memory usage of new +FreeRTOS IoT libraries before releasing the libraries into the main FreeRTOS +download with long term support (LTS). https://freertos.org/ltsroadmap.html +contains a description of the libraries that target modularity and code quality +criteria. An LTS release is only updated with bug and vulnerability patches, +not new features. This zip file contains (among other updates) a +work-in-progress snapshot of the MQTT library, which is near completion. The +MQTT library is now much easier to bring into any project, including projects +that do not use FreeRTOS. -We are currently working to improve modularity and memory usage of FreeRTOS -libraries to ensure the FreeRTOS LTS release helps our users cover a wider set of use cases. - -For additional details on LTS and the supported libraries, -refer to https://freertos.org/ltsroadmap.html +The zip file also contains significant enhancements to the over the air (OTA) +update agent. Specifically, it is now possible to pause and resume an +in-progress update. *** INSTRUCTIONS *** The pre-configured projects use the FreeRTOS kernel Windows port (often called the Windows simulator) to enable their evaluation using the free Visual Studio tools and without needing specific microcontroller hardware. - -Additional details can be found at: https://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html +provides additional information on using the Windows port. -Instructions for configuring and using the FreeRTOS IoT libraries are in the -following links: +The following links provide instructions on using the FreeRTOS IoT +libraries: + https://www.FreeRTOS.org/mqtt/ + https://www.FreeRTOS.org/https/ @@ -35,6 +37,11 @@ following links: The Visual Studio projects for each of the FreeRTOS IoT library examples are located in sub-directories of the following top-level directories: + Demos using the refactored MQTT library: + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_plain_text + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_light_weight + + Demos not yet updated to the refactored MQTT library: + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/mqtt + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/https + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/shadow @@ -51,8 +58,3 @@ directory structure See also - http://www.freertos.org/FreeRTOS-quick-start-guide.html http://www.freertos.org/FAQHelp.html - - -*** Mbed TLS License *** - -This repository uses Mbed TLS under Apache 2.0 diff --git a/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta1/readme.txt b/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta1/readme.txt index 1caf978e24..60392e75fb 100755 --- a/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta1/readme.txt +++ b/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta1/readme.txt @@ -1,53 +1,18 @@ *** INTRODUCTION *** -Development is now underway that will enable us to provide long-term support (LTS) -releases of FreeRTOS. An LTS release is maintained separately from the main -codebase. Typically, no new features are added after release, but critical bugs -and security vulnerabilities are patched for years after launch. +We are currently working to improve the modularity and memory usage of new +FreeRTOS IoT libraries before releasing the libraries into the main FreeRTOS +download with long term support (LTS). https://freertos.org/ltsroadmap.html +contains a description of the libraries that target modularity and code quality +criteria. An LTS release is only updated with bug and vulnerability patches, +not new features. This zip file contains (among other updates) a +work-in-progress snapshot of the MQTT library, which is near completion. The +MQTT library is now much easier to bring into any project, including projects +that do not use FreeRTOS. -We are currently working to improve modularity and memory usage of FreeRTOS -libraries to ensure the FreeRTOS LTS release helps our users cover a wider set of use cases. +The /FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta1 directory contains +the source code of the libraries that are being refactored. -For additional details on LTS and the supported libraries, -refer to https://freertos.org/ltsroadmap.html - -*** INSTRUCTIONS *** -The pre-configured projects use the FreeRTOS kernel Windows port (often -called the Windows simulator) to enable their evaluation using the free Visual -Studio tools and without needing specific microcontroller hardware. - -Additional details can be found at: -https://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html - -Instructions for configuring and using the FreeRTOS IoT libraries are in the -following links: - - + https://www.FreeRTOS.org/mqtt/ - + https://www.FreeRTOS.org/https/ - + https://www.FreeRTOS.org/shadow/ - + https://www.FreeRTOS.org/jobs/ - + https://www.FreeRTOS.org/ota/ - + https://www.FreeRTOS.org/pkcs11/ - - -*** LOCATING THE EXAMPLE PROJECTS *** - -The Visual Studio projects for each of the FreeRTOS IoT library examples are -located in sub-directories of the following top-level directories: - - + /FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/mqtt - + /FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/https - + /FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/shadow - + /FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/jobs - + /FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/ota - + /FreeRTOS-Plus/Demo/FreeRTOS_IoT_Libraries/pkcs11 - - -*** ADDITIONAL INFORMATION *** - -See http://www.freertos.org/a00017.html for full details of the FreeRTOS -directory structure - -See also - -http://www.freertos.org/FreeRTOS-quick-start-guide.html -http://www.freertos.org/FAQHelp.html +The /FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta2 directory contains +the work-in-progress source code of libraries that have already been refactored +(currently the MQTT library). \ No newline at end of file diff --git a/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta2/readme.txt b/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta2/readme.txt new file mode 100644 index 0000000000..60392e75fb --- /dev/null +++ b/FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta2/readme.txt @@ -0,0 +1,18 @@ +*** INTRODUCTION *** + +We are currently working to improve the modularity and memory usage of new +FreeRTOS IoT libraries before releasing the libraries into the main FreeRTOS +download with long term support (LTS). https://freertos.org/ltsroadmap.html +contains a description of the libraries that target modularity and code quality +criteria. An LTS release is only updated with bug and vulnerability patches, +not new features. This zip file contains (among other updates) a +work-in-progress snapshot of the MQTT library, which is near completion. The +MQTT library is now much easier to bring into any project, including projects +that do not use FreeRTOS. + +The /FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta1 directory contains +the source code of the libraries that are being refactored. + +The /FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta2 directory contains +the work-in-progress source code of libraries that have already been refactored +(currently the MQTT library). \ No newline at end of file diff --git a/FreeRTOS-Plus/Source/readme.txt b/FreeRTOS-Plus/Source/readme.txt new file mode 100644 index 0000000000..60392e75fb --- /dev/null +++ b/FreeRTOS-Plus/Source/readme.txt @@ -0,0 +1,18 @@ +*** INTRODUCTION *** + +We are currently working to improve the modularity and memory usage of new +FreeRTOS IoT libraries before releasing the libraries into the main FreeRTOS +download with long term support (LTS). https://freertos.org/ltsroadmap.html +contains a description of the libraries that target modularity and code quality +criteria. An LTS release is only updated with bug and vulnerability patches, +not new features. This zip file contains (among other updates) a +work-in-progress snapshot of the MQTT library, which is near completion. The +MQTT library is now much easier to bring into any project, including projects +that do not use FreeRTOS. + +The /FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta1 directory contains +the source code of the libraries that are being refactored. + +The /FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta2 directory contains +the work-in-progress source code of libraries that have already been refactored +(currently the MQTT library). \ No newline at end of file diff --git a/FreeRTOS-Plus/readme.txt b/FreeRTOS-Plus/readme.txt new file mode 100644 index 0000000000..4b5881e344 --- /dev/null +++ b/FreeRTOS-Plus/readme.txt @@ -0,0 +1,13 @@ +Directories: + ++ The FreeRTOS-Plus/Source directory contains source code for some of the + FreeRTOS+ components. These subdirectories contain further readme files and + links to documentation. + ++ The FreeRTOS-Plus/Demo directory contains a demo application for every most of + the FreeRTOS+ components. Lots of the demo applications use the FreeRTOS + Windows simulator for easy evaluation. Be aware that FreeRTOS is much slower + and not deterministic when executed in a simulated environment. + ++ See http://www.freertos.org/plus + diff --git a/README.md b/README.md index 01a78000c9..5d52c3cc75 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The easiest way to use FreeRTOS is to start with one of the pre-configured demo Additionally, for FreeRTOS kernel feature information refer to the [Developer Documentation](https://www.freertos.org/features.html), and [API Reference](https://www.freertos.org/a00106.html). ### Getting help -If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the [FreeRTOS Community Support Forum](https://forums.freertos.org). +The [FreeRTOS Support Forum](https://forums.freertos.org) is an excellent way to get rapid help from the FreeRTOS maintainers and wider FreeRTOS community. ## Repository structure This repository contains the FreeRTOS Kernel, a number of supplementary libraries, and a comprehensive set of example applications. diff --git a/README_FIRST.txt b/README_FIRST.txt index 4d6a417698..94921b99e5 100755 --- a/README_FIRST.txt +++ b/README_FIRST.txt @@ -1,26 +1,28 @@ *** INTRODUCTION *** -Development is now underway that will enable us to provide long-term support (LTS) -releases of FreeRTOS. An LTS release is maintained separately from the main -codebase. Typically, no new features are added after release, but critical bugs -and security vulnerabilities are patched for years after launch. +We are currently working to improve the modularity and memory usage of new +FreeRTOS IoT libraries before releasing the libraries into the main FreeRTOS +download with long term support (LTS). https://freertos.org/ltsroadmap.html +contains a description of the libraries that target modularity and code quality +criteria. An LTS release is only updated with bug and vulnerability patches, +not new features. This zip file contains (among other updates) a +work-in-progress snapshot of the MQTT library, which is near completion. The +MQTT library is now much easier to bring into any project, including projects +that do not use FreeRTOS. -We are currently working to improve modularity and memory usage of FreeRTOS -libraries to ensure the FreeRTOS LTS release helps our users cover a wider set of use cases. - -For additional details on LTS and the supported libraries, -refer to https://freertos.org/ltsroadmap.html +The zip file also contains significant enhancements to the over the air (OTA) +update agent. Specifically, it is now possible to pause and resume an +in-progress update. *** INSTRUCTIONS *** The pre-configured projects use the FreeRTOS kernel Windows port (often called the Windows simulator) to enable their evaluation using the free Visual Studio tools and without needing specific microcontroller hardware. - -Additional details can be found at: https://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html +provides additional information on using the Windows port. -Instructions for configuring and using the FreeRTOS IoT libraries are in the -following links: +The following links provide instructions on using the FreeRTOS IoT +libraries: + https://www.FreeRTOS.org/mqtt/ + https://www.FreeRTOS.org/https/ @@ -35,6 +37,11 @@ following links: The Visual Studio projects for each of the FreeRTOS IoT library examples are located in sub-directories of the following top-level directories: + Demos using the refactored MQTT library: + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_plain_text + + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_light_weight + + Demos not yet updated to the refactored MQTT library: + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/mqtt + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/https + /FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta1/shadow