Skip to content

Commit 9b4db25

Browse files
author
Ari Parkkila
committed
Added cellular readme
1 parent 92a872b commit 9b4db25

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

features/cellular/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Mbed Cellular Connectivity
2+
3+
This is the Github repo for Mbed cellular connectivity:
4+
5+
easy_cellular/
6+
EasyCellularConnection Simplified cellular usage based on CellularBase.h
7+
CellularConnectionUtil An utility class for cellular connection
8+
9+
framework/
10+
API Application Programming Interface for cellular connectivity
11+
AT AT implementation based on 3GPP TS 27.007 specification
12+
common Common and utility sources
13+
mux MUX implementation based on 3GPP TS 27.010 specification
14+
targets Vendor specific cellular module adaptations
15+
16+
## Known Limitations
17+
18+
**Please note that as a first release framework is subject to change and may break code that uses it.**
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.
21+
22+
## Supported Modules
23+
24+
Currently supported cellular modules can be found in the framework/targets/ folder, where also support for new cellular modules are added.
25+
26+
## Cellular Configuration
27+
28+
Cellular defaults can be changed in mbed_app.json configuration file:
29+
30+
"config": {
31+
"cellular_plmn": {
32+
"help": "PLMN selection, 0=auto",
33+
"value": 0
34+
},
35+
"apn": {
36+
"help": "Access point name, e.g. internet",
37+
"value": "\"internet\""
38+
},
39+
"cellular_sim_pin": {
40+
"help": "PIN code",
41+
"value": "\"1234\""
42+
}
43+
}
44+
45+
## Debug Traces
46+
47+
Debug tracing level can be defined in mbed_app.json configuration file:
48+
49+
"target_overrides": {
50+
"*": {
51+
"target.features_add": ["COMMON_PAL"],
52+
"mbed-trace.enable": true,
53+
"platform.stdio-convert-newlines": true,
54+
"platform.stdio-baud-rate": 115200,
55+
"platform.default-serial-baud-rate": 115200
56+
}
57+
},
58+
"config": {
59+
"trace-level": {
60+
"help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
61+
"macro_name": "MBED_TRACE_MAX_LEVEL",
62+
"value": "TRACE_LEVEL_INFO"
63+
}
64+
}

0 commit comments

Comments
 (0)