mbed-os/connectivity/cellular
Jamie Smith 97c267219a
Fix all Doxygen errors and make any future errors fatal (#118)
* Start working on fixing doxygen warnings

* Upgrade doxyfile to Doxygen 1.9.1

* Clean up some unmatched groups and add some exclusions

* Fix docs for rtos::ThisThread not showing up

* Fix up KV store docs

* Fix incorrect @files, some more incorrect groups

* Fix lots of broken links

* Start fixing mbedtls groups

* Fix more mbedtls docs

* Fix remaining mbedtls files with missing or incorrect grouping

* Fix a huge amount of PSA docs errors

* Fix a few more mbedtls docs errors

* Fix __cplusplus not defined for docs, clean up call in callback typedef, fix some docs errors

* Fix some broken doc links in HAL headers

* Fix more PSA doc errors

* Fix some doxygen errors in networking code

* Fix lots of network related doc errors

* Try and fix some CI failures

* Use Doxygen Action instead of doxygen in Mbed container to get the right version

* Try removing docs check

* Add first part of doxygen action

* Add next part of doxygen action

* Fix yaml syntax error

* Add in license check fix

* Try using verbose scancode

* Fix some more docs issues, workaround scancode-toolkit#3179

* Clean up the LoRaRadio get_state() function on each implementation.  Also fix some other compile and doc errors.

* Fix all remaining doxygen errors

* Fix escaping, for realsies this time

* Remove Doxygen unsupported config options, fix some more get_status() declarations

* Fix some UNITTESTS build errors

* Fix one more compile error

* Another unittest error
2022-12-30 18:41:41 -05:00
..
include Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
source Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
tests/UNITTESTS Fix all Doxygen errors and make any future errors fatal (#118) 2022-12-30 18:41:41 -05:00
.gitignore Move cellular framework into connectivity 2020-07-22 11:05:49 +01:00
CMakeLists.txt Rename inconsistently named testing-related variables. Also fix STM32CUBE not working from application code. 2022-09-14 00:25:29 -07:00
README.md Remove Cellular dependency in netsocket 2020-12-03 18:16:33 +01:00
mbed_lib.json Cellular: Add AT handler buffer size to configuration 2021-06-15 15:03:57 +02:00

README.md

Mbed cellular connectivity

This is the Github repo for Mbed cellular connectivity:

framework/
    API         Application Programming Interface for cellular connectivity
    AT          AT implementation based on 3GPP TS 27.007 specification
    common      Common and utility sources
    device      Implementation of cellular device and state machine
    targets     Vendor specific cellular module adaptations

Note: Application developers should use only the API folder.

Known limitations

Please note that this is a first release of Cellular framework and is subject to further development in future.

Supported modules

You can find currently supported cellular modules in the framework/targets/ folder, where we also add support for new cellular modules.

Cellular configuration

You can change cellular defaults in the mbed_lib.json configuration file.

Debug traces

You can define the debug tracing level in the mbed_app.json configuration file:

"target_overrides": {
    "*": {
        "mbed-trace.enable": true,
        "platform.stdio-convert-newlines": true,
        "platform.stdio-baud-rate": 115200,
        "platform.default-serial-baud-rate": 115200
    }
},
"config": {
    "trace-level": {
        "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
        "macro_name": "MBED_TRACE_MAX_LEVEL",
        "value": "TRACE_LEVEL_INFO"
    }
}

Greentea tests

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.

Unit tests

Cellular unit tests are in Mbed OS root UNITTESTS/connectivity/cellular.

Dependency with netsocket

If you create a .mbedignore file with

connectivity/cellular*
connectivity/drivers/cellular*

MBED_CONF_CELLULAR_PRESENT will not be set