takashi kadono / Mbed OS Nucleo446_SSD1331

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ssd1331

mbed-os/features/cellular/README.md@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 # Mbed cellular connectivity
kadonotakashi 0:8fdf9a60065b 2
kadonotakashi 0:8fdf9a60065b 3 This is the Github repo for Mbed cellular connectivity:
kadonotakashi 0:8fdf9a60065b 4
kadonotakashi 0:8fdf9a60065b 5 easy_cellular/
kadonotakashi 0:8fdf9a60065b 6 EasyCellularConnection Simplified cellular usage based on `CellularBase.h`
kadonotakashi 0:8fdf9a60065b 7 CellularConnectionUtil A utility class for cellular connection
kadonotakashi 0:8fdf9a60065b 8
kadonotakashi 0:8fdf9a60065b 9 framework/
kadonotakashi 0:8fdf9a60065b 10 API Application Programming Interface for cellular connectivity
kadonotakashi 0:8fdf9a60065b 11 AT AT implementation based on 3GPP TS 27.007 specification
kadonotakashi 0:8fdf9a60065b 12 common Common and utility sources
kadonotakashi 0:8fdf9a60065b 13 targets Vendor specific cellular module adaptations
kadonotakashi 0:8fdf9a60065b 14
kadonotakashi 0:8fdf9a60065b 15 TESTS Cellular Greentea test
kadonotakashi 0:8fdf9a60065b 16
kadonotakashi 0:8fdf9a60065b 17 UNITTESTS Cellular unit test
kadonotakashi 0:8fdf9a60065b 18
kadonotakashi 0:8fdf9a60065b 19 ## Known limitations
kadonotakashi 0:8fdf9a60065b 20
kadonotakashi 0:8fdf9a60065b 21 **Please note that this is a first release of Cellular framework and is subject to further development in future.**
kadonotakashi 0:8fdf9a60065b 22
kadonotakashi 0:8fdf9a60065b 23 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.
kadonotakashi 0:8fdf9a60065b 24
kadonotakashi 0:8fdf9a60065b 25 ## Supported modules
kadonotakashi 0:8fdf9a60065b 26
kadonotakashi 0:8fdf9a60065b 27 You can find currently supported cellular modules in the `framework/targets/` folder, where we also add support for new cellular modules.
kadonotakashi 0:8fdf9a60065b 28
kadonotakashi 0:8fdf9a60065b 29 ## Cellular configuration
kadonotakashi 0:8fdf9a60065b 30
kadonotakashi 0:8fdf9a60065b 31 You can change cellular defaults in the `mbed_lib.json` configuration file.
kadonotakashi 0:8fdf9a60065b 32
kadonotakashi 0:8fdf9a60065b 33 You can also override cellular defaults in the `mbed_app.json` configuration file:
kadonotakashi 0:8fdf9a60065b 34
kadonotakashi 0:8fdf9a60065b 35 "config": {
kadonotakashi 0:8fdf9a60065b 36 "cellular_plmn": {
kadonotakashi 0:8fdf9a60065b 37 "help": "PLMN selection, 0=auto",
kadonotakashi 0:8fdf9a60065b 38 "value": 0
kadonotakashi 0:8fdf9a60065b 39 },
kadonotakashi 0:8fdf9a60065b 40 "apn": {
kadonotakashi 0:8fdf9a60065b 41 "help": "Access point name, e.g. internet",
kadonotakashi 0:8fdf9a60065b 42 "value": "\"internet\""
kadonotakashi 0:8fdf9a60065b 43 },
kadonotakashi 0:8fdf9a60065b 44 "cellular_sim_pin": {
kadonotakashi 0:8fdf9a60065b 45 "help": "PIN code",
kadonotakashi 0:8fdf9a60065b 46 "value": "\"1234\""
kadonotakashi 0:8fdf9a60065b 47 }
kadonotakashi 0:8fdf9a60065b 48 }
kadonotakashi 0:8fdf9a60065b 49
kadonotakashi 0:8fdf9a60065b 50 ## Debug traces
kadonotakashi 0:8fdf9a60065b 51
kadonotakashi 0:8fdf9a60065b 52 You can define the debug tracing level in the `mbed_app.json` configuration file:
kadonotakashi 0:8fdf9a60065b 53
kadonotakashi 0:8fdf9a60065b 54 "target_overrides": {
kadonotakashi 0:8fdf9a60065b 55 "*": {
kadonotakashi 0:8fdf9a60065b 56 "target.features_add": ["COMMON_PAL"],
kadonotakashi 0:8fdf9a60065b 57 "mbed-trace.enable": true,
kadonotakashi 0:8fdf9a60065b 58 "platform.stdio-convert-newlines": true,
kadonotakashi 0:8fdf9a60065b 59 "platform.stdio-baud-rate": 115200,
kadonotakashi 0:8fdf9a60065b 60 "platform.default-serial-baud-rate": 115200
kadonotakashi 0:8fdf9a60065b 61 }
kadonotakashi 0:8fdf9a60065b 62 },
kadonotakashi 0:8fdf9a60065b 63 "config": {
kadonotakashi 0:8fdf9a60065b 64 "trace-level": {
kadonotakashi 0:8fdf9a60065b 65 "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
kadonotakashi 0:8fdf9a60065b 66 "macro_name": "MBED_TRACE_MAX_LEVEL",
kadonotakashi 0:8fdf9a60065b 67 "value": "TRACE_LEVEL_INFO"
kadonotakashi 0:8fdf9a60065b 68 }
kadonotakashi 0:8fdf9a60065b 69 }
kadonotakashi 0:8fdf9a60065b 70
kadonotakashi 0:8fdf9a60065b 71 ## Greentea tests
kadonotakashi 0:8fdf9a60065b 72
kadonotakashi 0:8fdf9a60065b 73 The `TESTS` folder contains Greentea tests for cellular specific classes. You need to give relevant configuration file with `--app-config` parameter, e.g.:
kadonotakashi 0:8fdf9a60065b 74
kadonotakashi 0:8fdf9a60065b 75 mbed test -n features-cellular-tests-* --app-config features\cellular\TESTS\socket\udp\template_mbed_app.json.txt -v
kadonotakashi 0:8fdf9a60065b 76
kadonotakashi 0:8fdf9a60065b 77 Note that Greentea tests use SIM PIN so you need to change that or your SIM card may get locked.
kadonotakashi 0:8fdf9a60065b 78
kadonotakashi 0:8fdf9a60065b 79 ## Unit tests
kadonotakashi 0:8fdf9a60065b 80
kadonotakashi 0:8fdf9a60065b 81 The `UNITTESTS` folder contains unit tests for cellular specific classes. Unit tests are based on the stubbing method.
kadonotakashi 0:8fdf9a60065b 82
kadonotakashi 0:8fdf9a60065b 83 You can run those tests locally by running `./run_tests` script under the `UNITTESTS/` folder.
kadonotakashi 0:8fdf9a60065b 84
kadonotakashi 0:8fdf9a60065b 85 You need the following applications: `cpputest`, `gcov` and `lcov` (genhtml) for running the tests.
kadonotakashi 0:8fdf9a60065b 86
kadonotakashi 0:8fdf9a60065b 87 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.