Skip to content

Commit 3f8ab4d

Browse files
Add library version at the top of the file. (#54)
* Add library version at the top of the file. * update change log * Update typo in changelog * Update the PR number for "Resolve ublox sara r4 build warnings". Co-authored-by: chinglee-iot <[email protected]>
1 parent ac28f25 commit 3f8ab4d

File tree

117 files changed

+1370
-1458
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+1370
-1458
lines changed

CHANGELOG.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
# Change Log for FreeRTOS Cellular Interface Library
22

3+
## v1.1.0 (November 2021)
4+
### Updates
5+
- [#40](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/40) Fix the module logging mechanism foramt.
6+
- [#53](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/53) Use the stdint.h header file for integer types.
7+
- [#55](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/55) Add function for validating the prefix character of cellular module response.
8+
- [#57](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/57) Fix unknown type issue.
9+
10+
### Other
11+
- [#52](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/52) Resolve ublox sara r4 build warnings.
12+
- [#42](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/42) Fix spelling check failure in CI tools.
13+
- [#43](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/43) [#46](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/46) [#54](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/54) Minor documentation updates.
14+
- [#48](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/pull/48) Header Guards for C++ linkage.
15+
316
## v1.0.0 (September 2021)
417

518
This is the first release of the FreeRTOS Cellular Interface library in this repository.
619

7-
The FreeRTOS Cellular Interface library provides an implementation of the standard AT commands for the [3GPP TS v27.007](https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1515) and support for the 3 cellular modems [Quectel BG96](https://www.quectel.com/product/bg96.htm), [Sierra Wireless HL7802](https://www.sierrawireless.com/products-and-solutions/embedded-solutions/products/hl7802/) and [U-Blox Sara-R4](https://www.u-blox.com/en/product/sara-r4-series).
20+
The FreeRTOS Cellular Interface library provides an implementation of the standard AT commands for the [3GPP TS v27.007](https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1515) and support for the 3 cellular modems [Quectel BG96](https://www.quectel.com/product/bg96.htm), [Sierra Wireless HL7802](https://www.sierrawireless.com/products-and-solutions/embedded-solutions/products/hl7802/) and [U-Blox Sara-R4](https://www.u-blox.com/en/product/sara-r4-series).

docs/doxygen/config.doxyfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = "FreeRTOS: FreeRTOS Cellular Library"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = v1.0.0
41+
PROJECT_NUMBER = v1.1.0
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

modules/bg96/cellular_bg96.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/* The config header is always included first. */

modules/bg96/cellular_bg96.h

+25
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1+
/*
2+
* FreeRTOS-Cellular-Interface v1.1.0
3+
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4+
*
5+
* Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
* this software and associated documentation files (the "Software"), to deal in
7+
* the Software without restriction, including without limitation the rights to
8+
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
* the Software, and to permit persons to whom the Software is furnished to do so,
10+
* subject to the following conditions:
11+
*
12+
* The above copyright notice and this permission notice shall be included in all
13+
* copies or substantial portions of the Software.
14+
*
15+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21+
*
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
24+
*/
25+
126
#ifndef __CELLULAR_BG96_H__
227
#define __CELLULAR_BG96_H__
328

modules/bg96/cellular_bg96_api.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/* Standard includes. */

modules/bg96/cellular_bg96_urc_handler.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
#include "cellular_config.h"

modules/bg96/cellular_bg96_wrapper.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/* The config header is always included first. */

modules/hl7802/cellular_hl7802.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/* The config header is always included first. */

modules/hl7802/cellular_hl7802.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
#ifndef __CELLULAR_HL7802_H__

modules/hl7802/cellular_hl7802_api.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
#include "cellular_config.h"

modules/hl7802/cellular_hl7802_urc_handler.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
#include "cellular_config.h"

modules/hl7802/cellular_hl7802_wrapper.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/* The config header is always included first. */

modules/sara_r4/cellular_r4.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
#include "cellular_config.h"

modules/sara_r4/cellular_r4.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
#ifndef __CELLULAR_R4_H__

modules/sara_r4/cellular_r4_api.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525
#include "cellular_config.h"
2626
#include "cellular_config_defaults.h"

modules/sara_r4/cellular_r4_urc_handler.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
#include "cellular_config.h"

modules/sara_r4/cellular_r4_wrapper.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/* The config header is always included first. */

source/cellular_3gpp_api.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/**

source/cellular_3gpp_urc_handler.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/**

source/cellular_at_core.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/**

source/cellular_common.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* FreeRTOS Cellular Preview Release
2+
* FreeRTOS-Cellular-Interface v1.1.0
33
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -19,8 +19,8 @@
1919
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2020
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121
*
22-
* http://aws.amazon.com/freertos
23-
* http://www.FreeRTOS.org
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
2424
*/
2525

2626
/**

0 commit comments

Comments
 (0)