Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/cellular/README.md@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 # Mbed cellular connectivity
kenjiArai 0:5b88d5760320 2
kenjiArai 0:5b88d5760320 3 This is the Github repo for Mbed cellular connectivity:
kenjiArai 0:5b88d5760320 4
kenjiArai 0:5b88d5760320 5 framework/
kenjiArai 0:5b88d5760320 6 API Application Programming Interface for cellular connectivity
kenjiArai 0:5b88d5760320 7 AT AT implementation based on 3GPP TS 27.007 specification
kenjiArai 0:5b88d5760320 8 common Common and utility sources
kenjiArai 0:5b88d5760320 9 device Implementation of cellular device and state machine
kenjiArai 0:5b88d5760320 10 targets Vendor specific cellular module adaptations
kenjiArai 0:5b88d5760320 11
kenjiArai 0:5b88d5760320 12 **Note:** Application developers should use only the `API` folder.
kenjiArai 0:5b88d5760320 13
kenjiArai 0:5b88d5760320 14 ## Known limitations
kenjiArai 0:5b88d5760320 15
kenjiArai 0:5b88d5760320 16 **Please note that this is a first release of Cellular framework and is subject to further development in future.**
kenjiArai 0:5b88d5760320 17
kenjiArai 0:5b88d5760320 18 ## Supported modules
kenjiArai 0:5b88d5760320 19
kenjiArai 0:5b88d5760320 20 You can find currently supported cellular modules in the `framework/targets/` folder, where we also add support for new cellular modules.
kenjiArai 0:5b88d5760320 21
kenjiArai 0:5b88d5760320 22 ## Cellular configuration
kenjiArai 0:5b88d5760320 23
kenjiArai 0:5b88d5760320 24 You can change cellular defaults in the `mbed_lib.json` configuration file.
kenjiArai 0:5b88d5760320 25
kenjiArai 0:5b88d5760320 26 ## Debug traces
kenjiArai 0:5b88d5760320 27
kenjiArai 0:5b88d5760320 28 You can define the debug tracing level in the `mbed_app.json` configuration file:
kenjiArai 1:9db0e321a9f4 29
kenjiArai 0:5b88d5760320 30 ```
kenjiArai 0:5b88d5760320 31 "target_overrides": {
kenjiArai 0:5b88d5760320 32 "*": {
kenjiArai 0:5b88d5760320 33 "mbed-trace.enable": true,
kenjiArai 0:5b88d5760320 34 "platform.stdio-convert-newlines": true,
kenjiArai 0:5b88d5760320 35 "platform.stdio-baud-rate": 115200,
kenjiArai 0:5b88d5760320 36 "platform.default-serial-baud-rate": 115200
kenjiArai 0:5b88d5760320 37 }
kenjiArai 0:5b88d5760320 38 },
kenjiArai 0:5b88d5760320 39 "config": {
kenjiArai 0:5b88d5760320 40 "trace-level": {
kenjiArai 0:5b88d5760320 41 "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
kenjiArai 0:5b88d5760320 42 "macro_name": "MBED_TRACE_MAX_LEVEL",
kenjiArai 0:5b88d5760320 43 "value": "TRACE_LEVEL_INFO"
kenjiArai 0:5b88d5760320 44 }
kenjiArai 0:5b88d5760320 45 }
kenjiArai 0:5b88d5760320 46 ```
kenjiArai 0:5b88d5760320 47
kenjiArai 0:5b88d5760320 48 ## Greentea tests
kenjiArai 0:5b88d5760320 49
kenjiArai 1:9db0e321a9f4 50 Cellular connectivity can be tested with generic Mbed OS netsocket and network interface tests found in Mbed OS root `TESTS` directory. For more information, see `TESTS/netsocket/README.md` and `TESTS/network/interface/README.md`.
kenjiArai 0:5b88d5760320 51
kenjiArai 0:5b88d5760320 52 ## Unit tests
kenjiArai 0:5b88d5760320 53
kenjiArai 1:9db0e321a9f4 54 Cellular unit tests are in Mbed OS root `UNITTESTS/features/cellular`.