Skip to content

Commit b35a11f

Browse files
andysun2015andysun2015
authored
Remove the demo onboarded on FreeRTOS and modify the doc (#8)
* Remove the demo onboarded on FreeRTOS and modify the doc * Remove unused folder
1 parent e051a29 commit b35a11f

21 files changed

Lines changed: 110 additions & 4018 deletions

‎README.md‎

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,8 @@ FreeRTOS offers a suite of networking stacks designed for IoT applications. App
66

77
The demos in this project demonstrate how to establish mutually authenticated MQTT connections to MQTT brokers, such as AWS IoT Core, by using cellular connectivity. The demos use the [Cellular Library](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Library/raw/main/doc/document/cellular.zip) sub-moduled from an external project. The FreeRTOS Cellular Library exposes the capability of a few popular cellular modems through a uniform API.
88

9-
1. [Quectel BG96](https://www.quectel.com/product/lte-bg96-cat-m1-nb1-egprs/)
10-
2. [Sierra Wireless HL7802](https://www.sierrawireless.com/products-and-solutions/embedded-solutions/products/hl7802/)
11-
3. [U-Blox Sara-R4](https://www.u-blox.com/en/product/sara-r4-series)
12-
4. [SIMCOM SIM7080](https://cn.simcom.com/product/SIM7080G.html)
9+
1. [1nce Zero Touch Provisioning](https://1nce.com/en/help-center/tutorials-documentations/1nce-connectivity-suite/)
10+
1. [SIMCOM SIM7080](https://cn.simcom.com/product/SIM7080G.html)
1311

1412
The MQTT and HTTP libraries of FreeRTOS use an abstract [Transport Interface](https://github.com/FreeRTOS/coreMQTT/blob/main/source/interface/transport_interface.h) to send/receive data in a generic way. The demos in this project offer a [implementation](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/blob/master/source/coreMQTT/using_mbedtls.c) of the Transport Interface on top of the uniform API exposed by the FreeRTOS Cellular Library.
1513

@@ -81,9 +79,6 @@ git submodule update --init --recursive
8179

8280
The demo project files for Visual Studio are named *xyz*_mqtt_mutual_auth_demo.sln, where *xyz *is the name of the cellular modem. They can be found on [Github](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/tree/main/projects) in the following directory:
8381

84-
* [projects/bg96_mqtt_mutual_auth_demo](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/tree/master/projects/bg96_mqtt_mutual_auth_demo)
85-
* [projects/hl7802_mqtt_mutual_auth_demo](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/tree/master/projects/hl7802_mqtt_mutual_auth_demo)
86-
* [projects/sara_r4_mqtt_mutual_auth_demo](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/tree/master/projects/sara_r4_mqtt_mutual_auth_demo)
8782
* [projects/sim70x0_mqtt_mutual_auth_demo](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/tree/master/projects/sim70x0_mqtt_mutual_auth_demo)
8883

8984
There is also a demo for 1nce zero touch provisioning with BG96 modem:
@@ -100,9 +95,6 @@ There is also a demo for 1nce zero touch provisioning with BG96 modem:
10095
│ └── ThirdParty
10196
│ └── mbedtls ( submodule : mbedtls )
10297
├── projects
103-
│ ├── bg96_mqtt_mutual_auth_demo ( demo project for Quectel BG96 )
104-
│ ├── hl7802_mqtt_mutual_auth_demo ( demo project for Sierra Wireless HL7802 )
105-
│ ├── sara_r4_mqtt_mutual_auth_demo ( demo project for U-Blox Sara-R4 )
10698
│ ├── sim70x0_mqtt_mutual_auth_demo ( demo project for SIMCOM sim7080/sim7090 )
10799
│ └── 1nce_bg96_zero_touch_provisioning_demo ( demo project for 1nce zero touch provisioning with BG96 )
108100
└── source
@@ -139,11 +131,6 @@ The following parameters in the cellular configuration, [cellular_config.h](http
139131
| CELLULAR_PDN_CONTEXT_ID | PDN context id for cellular network. | Default value is CELLULAR_PDN_CONTEXT_ID_MIN. |
140132
| CELLULAR_PDN_CONNECT_TIMEOUT | PDN connect timeout for network registration. | Default value is 100000 milliseconds. |
141133

142-
Note
143-
144-
> The U-Blox SARA-R4 series support setting mobile network operators.
145-
Set **CELLULAR_CONFIG_SARA_R4_SET_MNO_PROFILE **in [cellular_config.h](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo/blob/main/source/cellular/sara_r4/cellular_config.h) according to your mobile network operator.
146-
147134

148135

149136
### **Configure MQTT broker**

‎lib/cellular‎

‎projects/1nce_bg96_zero_touch_provisioning_demo/WIN32.vcxproj‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@
1212
</ItemGroup>
1313
<ItemGroup>
1414
<ClInclude Include="..\..\lib\backoff_algorithm\source\include\backoff_algorithm.h" />
15-
<ClInclude Include="..\..\lib\cellular\common\include\cellular_at_core.h" />
16-
<ClInclude Include="..\..\lib\cellular\common\include\cellular_common.h" />
17-
<ClInclude Include="..\..\lib\cellular\common\include\cellular_common_api.h" />
18-
<ClInclude Include="..\..\lib\cellular\common\include\cellular_common_portable.h" />
19-
<ClInclude Include="..\..\lib\cellular\common\include\private\cellular_common_internal.h" />
20-
<ClInclude Include="..\..\lib\cellular\common\include\private\cellular_internal.h" />
21-
<ClInclude Include="..\..\lib\cellular\common\include\private\cellular_pkthandler_internal.h" />
22-
<ClInclude Include="..\..\lib\cellular\common\include\private\cellular_pktio_internal.h" />
23-
<ClInclude Include="..\..\lib\cellular\include\cellular_api.h" />
24-
<ClInclude Include="..\..\lib\cellular\include\cellular_comm_interface.h" />
25-
<ClInclude Include="..\..\lib\cellular\include\cellular_config_defaults.h" />
26-
<ClInclude Include="..\..\lib\cellular\include\cellular_types.h" />
2715
<ClInclude Include="..\..\lib\cellular\modules\bg96\cellular_bg96.h" />
16+
<ClInclude Include="..\..\lib\cellular\source\include\cellular_api.h" />
17+
<ClInclude Include="..\..\lib\cellular\source\include\cellular_config_defaults.h" />
18+
<ClInclude Include="..\..\lib\cellular\source\include\cellular_types.h" />
19+
<ClInclude Include="..\..\lib\cellular\source\include\common\cellular_at_core.h" />
20+
<ClInclude Include="..\..\lib\cellular\source\include\common\cellular_common.h" />
21+
<ClInclude Include="..\..\lib\cellular\source\include\common\cellular_common_api.h" />
22+
<ClInclude Include="..\..\lib\cellular\source\include\common\cellular_common_portable.h" />
23+
<ClInclude Include="..\..\lib\cellular\source\include\private\cellular_common_internal.h" />
24+
<ClInclude Include="..\..\lib\cellular\source\include\private\cellular_internal.h" />
25+
<ClInclude Include="..\..\lib\cellular\source\include\private\cellular_pkthandler_internal.h" />
26+
<ClInclude Include="..\..\lib\cellular\source\include\private\cellular_pktio_internal.h" />
27+
<ClInclude Include="..\..\lib\cellular\source\interface\cellular_comm_interface.h" />
2828
<ClInclude Include="..\..\lib\coreMQTT\source\include\core_mqtt.h" />
2929
<ClInclude Include="..\..\lib\coreMQTT\source\include\core_mqtt_config_defaults.h" />
3030
<ClInclude Include="..\..\lib\coreMQTT\source\include\core_mqtt_serializer.h" />
@@ -143,17 +143,17 @@
143143
</ItemGroup>
144144
<ItemGroup>
145145
<ClCompile Include="..\..\lib\backoff_algorithm\source\backoff_algorithm.c" />
146-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_3gpp_api.c" />
147-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_3gpp_urc_handler.c" />
148-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_at_core.c" />
149-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_common.c" />
150-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_common_api.c" />
151-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_pkthandler.c" />
152-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_pktio.c" />
153146
<ClCompile Include="..\..\lib\cellular\modules\bg96\cellular_bg96.c" />
154147
<ClCompile Include="..\..\lib\cellular\modules\bg96\cellular_bg96_api.c" />
155148
<ClCompile Include="..\..\lib\cellular\modules\bg96\cellular_bg96_urc_handler.c" />
156149
<ClCompile Include="..\..\lib\cellular\modules\bg96\cellular_bg96_wrapper.c" />
150+
<ClCompile Include="..\..\lib\cellular\source\cellular_3gpp_api.c" />
151+
<ClCompile Include="..\..\lib\cellular\source\cellular_3gpp_urc_handler.c" />
152+
<ClCompile Include="..\..\lib\cellular\source\cellular_at_core.c" />
153+
<ClCompile Include="..\..\lib\cellular\source\cellular_common.c" />
154+
<ClCompile Include="..\..\lib\cellular\source\cellular_common_api.c" />
155+
<ClCompile Include="..\..\lib\cellular\source\cellular_pkthandler.c" />
156+
<ClCompile Include="..\..\lib\cellular\source\cellular_pktio.c" />
157157
<ClCompile Include="..\..\lib\coreMQTT\source\core_mqtt.c" />
158158
<ClCompile Include="..\..\lib\coreMQTT\source\core_mqtt_serializer.c" />
159159
<ClCompile Include="..\..\lib\coreMQTT\source\core_mqtt_state.c" />
@@ -308,7 +308,7 @@
308308
</Midl>
309309
<ClCompile>
310310
<Optimization>Disabled</Optimization>
311-
<AdditionalIncludeDirectories>.\..\..\lib\cellular\include;.\..\..\lib\cellular\common\include;.\..\..\lib\cellular\common\include\private;.\..\..\lib\FreeRTOS\portable\MSVC-MingW;.\..\..\lib\FreeRTOS\include;.\..\..\lib\coreMQTT\source\portable;.\..\..\lib\coreMQTT\source\include;.\..\..\lib\coreMQTT\source\interface;.\..\..\lib\ThirdParty\mbedtls\include;.\..\..\lib\backoff_algorithm\source\include;.\..\..\source;.\..\..\source\coreMQTT;.\..\..\source\FreeRTOS;.\..\..\source\mbedtls;.\..\..\source\cellular;.\..\..\source\cellular\bg96;.;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
311+
<AdditionalIncludeDirectories>.\..\..\lib\cellular\source\include;.\..\..\lib\cellular\source\interface;.\..\..\lib\cellular\source\include\common;.\..\..\lib\cellular\source\include\private;.\..\..\lib\FreeRTOS\portable\MSVC-MingW;.\..\..\lib\FreeRTOS\include;.\..\..\lib\coreMQTT\source\portable;.\..\..\lib\coreMQTT\source\include;.\..\..\lib\coreMQTT\source\interface;.\..\..\lib\ThirdParty\mbedtls\include;.\..\..\lib\backoff_algorithm\source\include;.\..\..\source;.\..\..\source\coreMQTT;.\..\..\source\FreeRTOS;.\..\..\source\mbedtls;.\..\..\source\cellular;.\..\..\source\cellular\bg96;.;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
312312
<PreprocessorDefinitions>USE_1NCE_ZERO_TOUCH_PROVISIONING;MBEDTLS_CONFIG_FILE="mbedtls_config.h";WIN32;_DEBUG;_CONSOLE;_WIN32_WINNT=0x0500;WINVER=0x400;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
313313
<MinimalRebuild>false</MinimalRebuild>
314314
<BasicRuntimeChecks>EnableFastChecks</BasicRuntimeChecks>

‎projects/1nce_bg96_zero_touch_provisioning_demo/WIN32.vcxproj.filters‎

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -84,42 +84,6 @@
8484
</Filter>
8585
</ItemGroup>
8686
<ItemGroup>
87-
<ClInclude Include="..\..\lib\cellular\common\include\cellular_common.h">
88-
<Filter>lib\cellular\common\include</Filter>
89-
</ClInclude>
90-
<ClInclude Include="..\..\lib\cellular\common\include\cellular_common_api.h">
91-
<Filter>lib\cellular\common\include</Filter>
92-
</ClInclude>
93-
<ClInclude Include="..\..\lib\cellular\common\include\cellular_common_portable.h">
94-
<Filter>lib\cellular\common\include</Filter>
95-
</ClInclude>
96-
<ClInclude Include="..\..\lib\cellular\common\include\cellular_at_core.h">
97-
<Filter>lib\cellular\common\include</Filter>
98-
</ClInclude>
99-
<ClInclude Include="..\..\lib\cellular\common\include\private\cellular_internal.h">
100-
<Filter>lib\cellular\common\include\private</Filter>
101-
</ClInclude>
102-
<ClInclude Include="..\..\lib\cellular\common\include\private\cellular_pkthandler_internal.h">
103-
<Filter>lib\cellular\common\include\private</Filter>
104-
</ClInclude>
105-
<ClInclude Include="..\..\lib\cellular\common\include\private\cellular_pktio_internal.h">
106-
<Filter>lib\cellular\common\include\private</Filter>
107-
</ClInclude>
108-
<ClInclude Include="..\..\lib\cellular\common\include\private\cellular_common_internal.h">
109-
<Filter>lib\cellular\common\include\private</Filter>
110-
</ClInclude>
111-
<ClInclude Include="..\..\lib\cellular\include\cellular_comm_interface.h">
112-
<Filter>lib\cellular\include</Filter>
113-
</ClInclude>
114-
<ClInclude Include="..\..\lib\cellular\include\cellular_config_defaults.h">
115-
<Filter>lib\cellular\include</Filter>
116-
</ClInclude>
117-
<ClInclude Include="..\..\lib\cellular\include\cellular_types.h">
118-
<Filter>lib\cellular\include</Filter>
119-
</ClInclude>
120-
<ClInclude Include="..\..\lib\cellular\include\cellular_api.h">
121-
<Filter>lib\cellular\include</Filter>
122-
</ClInclude>
12387
<ClInclude Include="..\..\lib\cellular\modules\bg96\cellular_bg96.h">
12488
<Filter>lib\cellular\modules\bg96</Filter>
12589
</ClInclude>
@@ -471,29 +435,44 @@
471435
<ClInclude Include="..\..\lib\ThirdParty\mbedtls\library\ssl_invasive.h">
472436
<Filter>lib\ThirdParty\mbedtls\library</Filter>
473437
</ClInclude>
438+
<ClInclude Include="..\..\lib\cellular\source\include\private\cellular_common_internal.h">
439+
<Filter>lib\cellular\common\include\private</Filter>
440+
</ClInclude>
441+
<ClInclude Include="..\..\lib\cellular\source\include\private\cellular_pkthandler_internal.h">
442+
<Filter>lib\cellular\common\include\private</Filter>
443+
</ClInclude>
444+
<ClInclude Include="..\..\lib\cellular\source\include\private\cellular_pktio_internal.h">
445+
<Filter>lib\cellular\common\include\private</Filter>
446+
</ClInclude>
447+
<ClInclude Include="..\..\lib\cellular\source\include\private\cellular_internal.h">
448+
<Filter>lib\cellular\common\include\private</Filter>
449+
</ClInclude>
450+
<ClInclude Include="..\..\lib\cellular\source\include\common\cellular_at_core.h">
451+
<Filter>lib\cellular\common\include</Filter>
452+
</ClInclude>
453+
<ClInclude Include="..\..\lib\cellular\source\include\common\cellular_common.h">
454+
<Filter>lib\cellular\common\include</Filter>
455+
</ClInclude>
456+
<ClInclude Include="..\..\lib\cellular\source\include\common\cellular_common_api.h">
457+
<Filter>lib\cellular\common\include</Filter>
458+
</ClInclude>
459+
<ClInclude Include="..\..\lib\cellular\source\include\common\cellular_common_portable.h">
460+
<Filter>lib\cellular\common\include</Filter>
461+
</ClInclude>
462+
<ClInclude Include="..\..\lib\cellular\source\include\cellular_api.h">
463+
<Filter>lib\cellular\include</Filter>
464+
</ClInclude>
465+
<ClInclude Include="..\..\lib\cellular\source\include\cellular_config_defaults.h">
466+
<Filter>lib\cellular\include</Filter>
467+
</ClInclude>
468+
<ClInclude Include="..\..\lib\cellular\source\include\cellular_types.h">
469+
<Filter>lib\cellular\include</Filter>
470+
</ClInclude>
471+
<ClInclude Include="..\..\lib\cellular\source\interface\cellular_comm_interface.h">
472+
<Filter>lib\cellular\include</Filter>
473+
</ClInclude>
474474
</ItemGroup>
475475
<ItemGroup>
476-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_common.c">
477-
<Filter>lib\cellular\common\src</Filter>
478-
</ClCompile>
479-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_common_api.c">
480-
<Filter>lib\cellular\common\src</Filter>
481-
</ClCompile>
482-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_pkthandler.c">
483-
<Filter>lib\cellular\common\src</Filter>
484-
</ClCompile>
485-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_pktio.c">
486-
<Filter>lib\cellular\common\src</Filter>
487-
</ClCompile>
488-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_3gpp_api.c">
489-
<Filter>lib\cellular\common\src</Filter>
490-
</ClCompile>
491-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_3gpp_urc_handler.c">
492-
<Filter>lib\cellular\common\src</Filter>
493-
</ClCompile>
494-
<ClCompile Include="..\..\lib\cellular\common\src\cellular_at_core.c">
495-
<Filter>lib\cellular\common\src</Filter>
496-
</ClCompile>
497476
<ClCompile Include="..\..\lib\cellular\modules\bg96\cellular_bg96_api.c">
498477
<Filter>lib\cellular\modules\bg96</Filter>
499478
</ClCompile>
@@ -824,5 +803,26 @@
824803
<ClCompile Include="..\..\lib\ThirdParty\mbedtls\library\xtea.c">
825804
<Filter>lib\ThirdParty\mbedtls\library</Filter>
826805
</ClCompile>
806+
<ClCompile Include="..\..\lib\cellular\source\cellular_3gpp_api.c">
807+
<Filter>lib\cellular\common\src</Filter>
808+
</ClCompile>
809+
<ClCompile Include="..\..\lib\cellular\source\cellular_3gpp_urc_handler.c">
810+
<Filter>lib\cellular\common\src</Filter>
811+
</ClCompile>
812+
<ClCompile Include="..\..\lib\cellular\source\cellular_at_core.c">
813+
<Filter>lib\cellular\common\src</Filter>
814+
</ClCompile>
815+
<ClCompile Include="..\..\lib\cellular\source\cellular_common.c">
816+
<Filter>lib\cellular\common\src</Filter>
817+
</ClCompile>
818+
<ClCompile Include="..\..\lib\cellular\source\cellular_common_api.c">
819+
<Filter>lib\cellular\common\src</Filter>
820+
</ClCompile>
821+
<ClCompile Include="..\..\lib\cellular\source\cellular_pkthandler.c">
822+
<Filter>lib\cellular\common\src</Filter>
823+
</ClCompile>
824+
<ClCompile Include="..\..\lib\cellular\source\cellular_pktio.c">
825+
<Filter>lib\cellular\common\src</Filter>
826+
</ClCompile>
827827
</ItemGroup>
828828
</Project>

0 commit comments

Comments
 (0)