espressif/FreeRTOS
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS.git synced 2025-06-23 01:21:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix wrong comments in shadow_demo_helpers.c (#392)

Browse Source 
* Fix wrong comments in shadow_demo_helpers.c

* Fix file brief description in shadow_demo_helpers.c

* Revise the comment for democonfigMQTT_BROKER_ENDPOINT
This commit is contained in:
andysun2015
2020-11-09 12:21:35 +08:00
committed by GitHub
parent b302a81ffd
commit 54d549cd0e
2 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
FreeRTOS-Plus/Demo/AWS/Device_Shadow_Windows_Simulator/Device_Shadow_Demo/DemoTasks/shadow_demo_helpers.c
View File

@ -27,9 +27,9 @@
* do MQTT operations over a mutually authenticated TLS connection. * do MQTT operations over a mutually authenticated TLS connection.
* *
* A mutually authenticated TLS connection is used to connect to the AWS IoT * A mutually authenticated TLS connection is used to connect to the AWS IoT
* MQTT message broker in this example. Define ROOT_CA_CERT_PATH, * MQTT message broker in this example. Define democonfigCLIENT_PRIVATE_KEY_PEM,
* CLIENT_CERT_PATH, and CLIENT_PRIVATE_KEY_PATH in demo_config.h to achieve * democonfigCLIENT_CERTIFICATE_PEM, and democonfigMQTT_BROKER_ENDPOINT in
* mutual authentication. * demo_config.h to achieve mutual authentication.
*/ */
/* Standard includes. */ /* Standard includes. */
@ -58,17 +58,20 @@
/*------------- Demo configurations -------------------------*/ /*------------- Demo configurations -------------------------*/
/** Note: The device client certificate and private key credentials are /** Note: The device client certificate and private key credentials are
* obtained by the transport interface implementation (with Secure Sockets) * obtained by the TLS transport interface implementation from the
* from the demos/include/aws_clientcredential_keys.h file. * demo_config.h file.
*
* The following macros SHOULD be defined for this demo which uses both server
* and client authentications for TLS session:
* - keyCLIENT_CERTIFICATE_PEM for client certificate.
* - keyCLIENT_PRIVATE_KEY_PEM for client private key.
*/ */
#ifndef democonfigCLIENT_PRIVATE_KEY_PEM
#error "Please define client private key(democonfigCLIENT_PRIVATE_KEY_PEM) in demo_config.h."
#endif
#ifndef democonfigCLIENT_CERTIFICATE_PEM
#error "Please define client certificate(democonfigCLIENT_CERTIFICATE_PEM) in demo_config.h."
#endif
#ifndef democonfigMQTT_BROKER_ENDPOINT #ifndef democonfigMQTT_BROKER_ENDPOINT
#define democonfigMQTT_BROKER_ENDPOINT clientcredentialMQTT_BROKER_ENDPOINT #error "Please define democonfigMQTT_BROKER_ENDPOINT in demo_config.h."
#endif #endif
#ifndef democonfigMQTT_BROKER_PORT #ifndef democonfigMQTT_BROKER_PORT
@ -76,9 +79,8 @@
/** /**
* @brief The port to use for the demo. * @brief The port to use for the demo.
*/ */
#define democonfigMQTT_BROKER_PORT clientcredentialMQTT_BROKER_PORT #define democonfigMQTT_BROKER_PORT ( 8883 )
#endif #endif
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
/** /**

2
FreeRTOS-Plus/Demo/AWS/Device_Shadow_Windows_Simulator/Device_Shadow_Demo/demo_config.h
View File

@ -45,7 +45,7 @@
/* Logging configuration for the Demo. */ /* Logging configuration for the Demo. */
#ifndef LIBRARY_LOG_NAME #ifndef LIBRARY_LOG_NAME
#define LIBRARY_LOG_NAME "MQTTDemo" #define LIBRARY_LOG_NAME "ShadowDemo"
#endif #endif
#ifndef LIBRARY_LOG_LEVEL #ifndef LIBRARY_LOG_LEVEL