Multiple tidy up and corrections preparing for release (#390)

* Update to the WolfSSL FIPS ready demo:  Add a debug break point into the configASSERT() implementation along with a comment telling users how to update the integrity check hash if they hit the breakpoint.

* Updates in the root directory:  Remove "New - Stream and Message Buffers.url" as the feature is no longer new, and edit the readme.md file as the repo now contains 'core' libraries in addition to 'FreeRTOS+' libraries.

* FreeRTOS-Plus/Source/Utilities:  Add readme files and links to documentation.

* Application-Protocols:  Add readme and URL links.

* Remove Index.html from the end of a URL in the readme.txt file.

* Demo-IP-Protocols:  Add readme.txt files and code comments saying the protocols are not intended for production use.

* coreMQTT:  Remove links to deprecated documentation, add readme and correct links to documentation.

* General:  Correct URLs in source files and .url files.

* Update readme.txt
This commit is contained in:
RichardBarry 2020-11-09 14:50:33 -08:00 committed by GitHub
parent df082944e0
commit 5d3b3cb1c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 119 additions and 42 deletions

View file

@ -26,7 +26,7 @@
*/
/***
* See https://www.FreeRTOS.org/mqtt_lts/index.html for configuration and usage instructions.
* See https://www.FreeRTOS.org/coremqtt for configuration and usage instructions.
***/
/* Standard includes. */
@ -107,7 +107,7 @@ static UBaseType_t ulNextRand;
int main( void )
{
/***
* See https://www.FreeRTOS.org/mqtt_lts/index.html for configuration and usage instructions.
* See https://www.FreeRTOS.org/coremqtt for configuration and usage instructions.
***/
/* Miscellaneous initialization including preparing the logging and seeding

View file

@ -1,5 +0,0 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/

View file

@ -1,5 +0,0 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/

View file

@ -0,0 +1,11 @@
The multi threaded example creates an MQTT agent (or daemon task). It is thread
safe because only the agent task is allowed to access the coreMQTT API - hence
the API is only accessed from one FreeRTOS task. Other tasks and interrupts
needing to interact with the MQTT agent do so through a thread safe queue.
We are generalising this technique for future coreMQTT releases, which will have
a re-usable agent component.
! Plain text examples are for ease of evaluation only - product devices should
! always use authenticated and encrypted communication. Never send private or
! sensitive data on an unencrypted connection.

View file

@ -1,5 +0,0 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/

View file

@ -1,5 +0,0 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/

View file

@ -1,5 +0,0 @@
[{000214A0-0000-0000-C000-000000000046}]
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/

View file

@ -0,0 +1,15 @@
The subdirectories of this directory contain multiple examples that demonstrate
coreMQTT using in both single and multi-threaded scenarios, as well as with
both plain text and authenticated and encrypted network interfaces.
The multi threaded example creates an MQTT agent (or daemon task). It is thread
safe because only the agent task is allowed to access the coreMQTT API - hence
the API is only accessed from one FreeRTOS task. Other tasks and interrupts
needing to interact with the MQTT agent do so through a thread safe queue.
We are generalising this technique for future coreMQTT releases, which will have
a re-usable agent component.
! Plain text examples are for ease of evaluation only - product devices should
! always use authenticated and encrypted communication. Never send private or
! sensitive data on an unencrypted connection.

View file

@ -2,4 +2,4 @@
Prop3=19,11
[InternetShortcut]
IDList=
URL=https://www.freertos.org/mqtt_lts/
URL=https://www.freertos.org/coremqtt/index.html