embedded/FreeRTOS
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS.git synced 2026-08-01 02:33:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update plain text demo to use local broker (#142)

Browse Source
This commit is contained in:
leegeth
2020-07-15 09:03:54 -07:00
committed by GitHub
parent 5ee5e2a95d
commit ba170799ca
4 changed files with 85 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_light_weight/demo_config.h
View File

@@ -75,19 +75,28 @@
* https://github.com/eclipse/mosquitto/blob/master/readme-windows.txt and
* https://github.com/eclipse/mosquitto/blob/master/readme.md
* 3. Verify that Mosquitto server is running locally and listening on port
* 1883 by
* a. Opening Power Shell.
* b. Typing in command `netstat -a -p TCP | grep 1883` to check if there
* 1883 by following the steps below.
* a. Open Power Shell.
* b. Type in command `netstat -a -p TCP | grep 1883` to check if there
* is an active connection listening on port 1883.
* c. Verify that there is an output as shown below
* `TCP 0.0.0.0:1883 <HOST-NAME>:0 LISTENING`
* d. If there is no output please go through the Mosquitto documentation
* d. If there is no output on step c,go through the Mosquitto documentation
* listed above to check if the installation was successful.
* 4.After verifying that a Mosquitto broker is running successfully, update
* 4. Make sure the Mosquitto broker is allowed to communicate through
* Windows Firewall. The instructions for allowing an application on Windows 10
* Defender Firewall can be found at the link below.
* https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall
* After running this MQTT example, consider disabling the Mosquitto broker to
* communicate through Windows Firewall for avoiding unwanted network traffic
* to your machine.
* 5. After verifying that a Mosquitto broker is running successfully, update
* the config democonfigMQTT_BROKER_ENDPOINT to the local IP address of the
* Windows host machine. Please note that "localhost" or address "127.0.0.1"
* will not work as this example is running on a Windows Simulator and not on
* Windows host natively.
* Windows host natively. Also note that, if the Windows host is using a
* Virtual Private Network(VPN), connection to the Mosquitto broker may not
* work.
*
* As an alternative option, a publicly hosted Mosquitto broker can also be
* used as an MQTT broker end point. This can be done by updating the config

16
FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_plain_text/DemoTasks/PlaintextMQTTExample.c
View File

@@ -60,6 +60,14 @@
/* Transport interface include. */
#include "transport_interface_freertos.h"
/*-----------------------------------------------------------*/
/* Compile time error for undefined configs. */
#ifndef democonfigMQTT_BROKER_ENDPOINT
#error "Define the config democonfigMQTT_BROKER_ENDPOINT by following the instructions in file demo_config.h."
#endif
/*-----------------------------------------------------------*/
/* Default values for configs. */
#ifndef democonfigCLIENT_IDENTIFIER
@@ -76,13 +84,7 @@
*/
#define democonfigCLIENT_IDENTIFIER "testClient"__TIME__
#endif
#ifndef democonfigMQTT_BROKER_ENDPOINT
/**
* @brief Details of the MQTT broker to connect to.
*/
#define democonfigMQTT_BROKER_ENDPOINT "test.mosquitto.org"
#endif
#ifndef democonfigMQTT_BROKER_PORT
/**
@@ -91,6 +93,8 @@
#define democonfigMQTT_BROKER_PORT ( 1883 )
#endif
/*-----------------------------------------------------------*/
/**
* @brief Timeout for receiving CONNACK packet in milliseconds.
*/

39
FreeRTOS-Plus/Demo/FreeRTOS-IoT-Libraries-LTS-Beta2/mqtt/mqtt_plain_text/demo_config.h
View File

@@ -65,6 +65,45 @@
/**
* @brief MQTT broker end point to connect to.
*
* @note For running this demo an MQTT broker, which can be run locally on
* the same host is recommended. Any MQTT broker, which can be run on a Windows
* host can be used for this demo. However, the instructions below are for
* setting up a local Mosquitto broker on a Windows host.
* 1. Download Mosquitto from https://mosquitto.org/download/
* 2. Install Mosquitto as a Windows service by running the installer.
* More details about installing as a Windows service can be found at
* https://github.com/eclipse/mosquitto/blob/master/readme-windows.txt and
* https://github.com/eclipse/mosquitto/blob/master/readme.md
* 3. Verify that Mosquitto server is running locally and listening on port
* 1883 by following the steps below.
* a. Open Power Shell.
* b. Type in command `netstat -a -p TCP | grep 1883` to check if there
* is an active connection listening on port 1883.
* c. Verify that there is an output as shown below
* `TCP 0.0.0.0:1883 <HOST-NAME>:0 LISTENING`
* d. If there is no output on step c,go through the Mosquitto documentation
* listed above to check if the installation was successful.
* 4. Make sure the Mosquitto broker is allowed to communicate through
* Windows Firewall. The instructions for allowing an application on Windows 10
* Defender Firewall can be found at the link below.
* https://support.microsoft.com/en-us/help/4558235/windows-10-allow-an-app-through-microsoft-defender-firewall
* After running this MQTT example, consider disabling the Mosquitto broker to
* communicate through Windows Firewall for avoiding unwanted network traffic
* to your machine.
* 5. After verifying that a Mosquitto broker is running successfully, update
* the config democonfigMQTT_BROKER_ENDPOINT to the local IP address of the
* Windows host machine. Please note that "localhost" or address "127.0.0.1"
* will not work as this example is running on a Windows Simulator and not on
* Windows host natively. Also note that, if the Windows host is using a
* Virtual Private Network(VPN), connection to the Mosquitto broker may not
* work.
*
* As an alternative option, a publicly hosted Mosquitto broker can also be
* used as an MQTT broker end point. This can be done by updating the config
* democonfigMQTT_BROKER_ENDPOINT to "test.mosquitto.org". However, this is not
* recommended due the possible downtimes of the broker as indicated by the
* documentation in https://test.mosquitto.org/.
*
* #define democonfigMQTT_BROKER_ENDPOINT "insert here."
*/

35
FreeRTOS-Plus/Source/FreeRTOS-IoT-Libraries-LTS-Beta2/abstractions/platform/freertos/transport_interface_freertos.c
View File

@@ -57,20 +57,6 @@ BaseType_t Transport_FreeRTOS_Connect( NetworkContext_t * pNetworkContext,
LogError( ( "Failed to create new socket." ) );
socketStatus = -1;
}
else
{
LogDebug( ( "Created new TCP socket." ) );
socketStatus = FreeRTOS_setsockopt( tcpSocket,
0,
FREERTOS_SO_RCVTIMEO,
&receiveTimeout,
sizeof( TickType_t ) );
if( socketStatus != 0 )
{
LogError( ( "Failed to set socket receive timeout." ) );
}
}
if( socketStatus == 0 )
{
@@ -91,6 +77,27 @@ BaseType_t Transport_FreeRTOS_Connect( NetworkContext_t * pNetworkContext,
if( socketStatus == 0 )
{
socketStatus = FreeRTOS_connect( tcpSocket, &serverAddress, sizeof( serverAddress ) );
if( socketStatus != 0 )
{
LogError( ( "Failed to connect to %s. FreeRTOS_connect returned with status=%d.",
pHostName,
socketStatus ) );
}
}
if( socketStatus == 0 )
{
socketStatus = FreeRTOS_setsockopt( tcpSocket,
0,
FREERTOS_SO_RCVTIMEO,
&receiveTimeout,
sizeof( TickType_t ) );
if( socketStatus != 0 )
{
LogError( ( "Failed to set socket receive timeout." ) );
}
}
/* Clean up on failure. */