Skip to content

Commit d35316b

Browse files
Add link to labs repo (#46)
Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>
1 parent 5ffad27 commit d35316b

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Most cellular modems implement more or less the AT commands defined by the [3GPP
2828
The common component that implements the 3GPP TS v27.007 standard has been written in compliance of the following code quality criteria:
2929

3030
* GNU Complexity scores are not over 8.
31-
* MISRA coding standard. Any deviations from the MISRA C:2012 guidelines are documented in source code comments marked by `coverity`.
31+
* MISRA coding standard. Any deviations from the MISRA C:2012 guidelines are documented in source code comments marked by "`coverity`".
3232

3333
## Getting Started
3434

@@ -74,11 +74,11 @@ FreeRTOS Cellular Interface now supports AT commands, TCP offloaded Cellular abs
7474
In order to port the [common component](https://www.freertos.org/Documentation/api-ref/cellular_common/index.html):
7575

7676
1. Implement the cellular modem porting interface defined in [cellular_common_portable.h](https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/tree/main/source/include/common/cellular_common_portable.h).
77-
2. Implement the subset of Cellular Library APIs that use vendor-specific (non-3GPP) AT commands. The APIs to be implemented are the ones not marked with an “o” in [this table](https://www.freertos.org/Documentation/api-ref/cellular_common/cellular_common_APIs.html).
78-
3. Implement Cellular Library callback functions that handle vendor-specific (non-3GPP) Unsolicited Result Code (URC). The URC handlers to be implemented are the ones not marked with an “o” in [this table](https://www.freertos.org/Documentation/api-ref/cellular_common/cellular_common_URC_handlers.html).
77+
2. Implement the subset of Cellular Library APIs that use vendor-specific (non-3GPP) AT commands. The APIs to be implemented are the ones not marked with an "o" in [this table](https://www.freertos.org/Documentation/api-ref/cellular_common/cellular_common_APIs.html).
78+
3. Implement Cellular Library callback functions that handle vendor-specific (non-3GPP) Unsolicited Result Code (URC). The URC handlers to be implemented are the ones not marked with an "o" in [this table](https://www.freertos.org/Documentation/api-ref/cellular_common/cellular_common_URC_handlers.html).
7979

8080
The [Cellular common APIs document](https://www.freertos.org/Documentation/api-ref/cellular_common/index.html) provides detail information required in each steps.
81-
It is recommended that you start by cloning the implementation of one of the existing modems, then make modifications where your modems vendor-specific (non-3GPP) AT commands are different.
81+
It is recommended that you start by cloning the implementation of one of the existing modems, then make modifications where your modem's vendor-specific (non-3GPP) AT commands are different.
8282

8383
Current Example Implementations:
8484

@@ -115,6 +115,10 @@ git submodule update --checkout --init --recursive --test/unit-test/CMock
115115

116116
1. Run `cd build && ctest` to execute all tests and view the test run summary.
117117

118+
## Reference examples
119+
120+
Please refer to the [FreeRTOS Cellular Demos repository](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-Cellular-Demo) for reference examples.
121+
118122
## Generating documentation
119123

120124
The Doxygen references were created using Doxygen version 1.9.2. To generate the
@@ -126,4 +130,4 @@ doxygen docs/doxygen/config.doxyfile
126130

127131
## Contributing
128132

129-
See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on contributing.
133+
See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on contributing.

0 commit comments

Comments
 (0)