git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/readme.txt

   1 *** IMPORTANT NOTE ***\r
   2 \r
   3 FreeRTOS-Labs contains libraries and demos that are fully functional, but\r
   4 undergoing optimizations or refactoring to improve memory usage, modularity,\r
   5 documentation, demo usability, or test coverage.  At this time the projects ARE\r
   6 A WORK IN PROGRESS and will be released in the main FreeRTOS directories of the\r
   7 download following full review and completion of the documentation.\r
   8 \r
   9 \r
  10 \r
  11 *** INTRODUCTION ***\r
  12 \r
  13 This distribution currently contains demos from the FreeRTOS task pool library,\r
  14 MQTT library, HTTPS Client library, Shadow library, and Jobs library.\r
  15 \r
  16 The pre-configured projects use the FreeRTOS kernel Windows port (often\r
  17 called the Windows simulator) to enable their evaluation using the free Visual\r
  18 Studio tools and without needing specific microcontroller hardware.\r
  19 \r
  20 \r
  21 \r
  22 *** INSTRUCTIONS ***\r
  23 \r
  24 Instructions for configuring and using the FreeRTOS IoT libraries are in the\r
  25 following links:\r
  26 \r
  27   + https://www.FreeRTOS.org/task-pool/\r
  28   + https://www.FreeRTOS.org/mqtt/\r
  29   + https://www.freertos.org/https/\r
  30   + https://www.FreeRTOS.org/shadow/\r
  31   + https://www.FreeRTOS.org/jobs/\r
  32 \r
  33 \r
  34 *** LOCATING THE EXAMPLE PROJECTS ***\r
  35 \r
  36 The Visual Studio projects for each of the FreeRTOS IoT library examples are\r
  37 located in sub-directories of the following top-level directories:\r
  38 \r
  39   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/utilities\r
  40   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/mqtt\r
  41   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/https\r
  42   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/shadow\r
  43   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/jobs\r
  44 \r
  45 \r
  46 *** ADDITIONAL INFORMATION ***\r
  47 \r
  48 See http://www.freertos.org/a00017.html for full details of the FreeRTOS\r
  49 directory structure\r
  50 \r
  51 See also -\r
  52 http://www.freertos.org/FreeRTOS-quick-start-guide.html\r
  53 http://www.freertos.org/FAQHelp.html\r