You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: features/cellular/README.md
+16-18Lines changed: 16 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
# Mbed Cellular Connectivity
1
+
# Mbed cellular connectivity
2
2
3
3
This is the Github repo for Mbed cellular connectivity:
4
4
5
5
easy_cellular/
6
-
EasyCellularConnection Simplified cellular usage based on CellularBase.h
7
-
CellularConnectionUtil An utility class for cellular connection
6
+
EasyCellularConnection Simplified cellular usage based on `CellularBase.h`
7
+
CellularConnectionUtil A utility class for cellular connection
8
8
9
9
framework/
10
10
API Application Programming Interface for cellular connectivity
@@ -13,19 +13,19 @@ This is the Github repo for Mbed cellular connectivity:
13
13
mux MUX implementation based on 3GPP TS 27.010 specification
14
14
targets Vendor specific cellular module adaptations
15
15
16
-
## Known Limitations
16
+
## Known limitations
17
17
18
-
**Please note that as a first release framework is subject to change and may break code that uses it.**
18
+
**Please note that as a first release framework, this content is subject to change and may break code that uses it.**
19
19
20
-
Only UDP is supported when using AT commands to control sockets in an IP stack built into the cellular modem. If TCP is required use PPP/LWIP stack.
20
+
Only UDP is supported when using AT commands to control sockets in an IP stack built into the cellular modem. If TCP is required, use the PPP/LWIP stack.
21
21
22
-
## Supported Modules
22
+
## Supported modules
23
23
24
-
Currently supported cellular modules can be found in the framework/targets/ folder, where also support for new cellular modules are added.
24
+
You can find currently supported cellular modules in the `framework/targets/` folder, where we also add support for new cellular modules.
25
25
26
-
## Cellular Configuration
26
+
## Cellular configuration
27
27
28
-
Cellular defaults can be changed in mbed_app.json configuration file:
28
+
You can change cellular defaults in the `mbed_app.json` configuration file:
29
29
30
30
"config": {
31
31
"cellular_plmn": {
@@ -42,9 +42,9 @@ Cellular defaults can be changed in mbed_app.json configuration file:
42
42
}
43
43
}
44
44
45
-
## Debug Traces
45
+
## Debug traces
46
46
47
-
Debug tracing level can be defined in mbed_app.json configuration file:
47
+
You can define the debug tracing level in the `mbed_app.json` configuration file:
48
48
49
49
"target_overrides": {
50
50
"*": {
@@ -65,12 +65,10 @@ Debug tracing level can be defined in mbed_app.json configuration file:
65
65
66
66
## Unit tests
67
67
68
-
UNITTESTS folder contains unittests for Cellular specific classes. Unittests are based on stubbing method and some of the platform headers has been hacked under target_h/ folder to get things working.
69
-
70
-
You can run those tests locally by running ./run_tests script under UNITTESTS/ folder.
71
-
72
-
you will need at least following applications: cpputest, gcov and lcov (genhtml) for running the tests.
73
-
After run_tests script has been run you can find test results under UNITTESTS/results folder and line & function coverages under UNITTESTS/coverages folder
68
+
The `UNITTESTS` folder contains unit tests for cellular specific classes. Unit tests are based on the stubbing method.
74
69
70
+
You can run those tests locally by running `./run_tests` script under the `UNITTESTS/` folder.
75
71
72
+
You need the following applications: `cpputest`, `gcov` and `lcov` (genhtml) for running the tests.
76
73
74
+
After you have run the `run_tests` script, you can find test results under `UNITTESTS/results` folder and line and function coverages under the `UNITTESTS/coverages` folder.
0 commit comments