Daniel Lee / Mbed OS mbed-os-example-cellular-le910

This is an example based on mbed-os cellular APIs that demonstrates a TCP or UDP echo transaction with a public echo server.

This code is forked from https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-cellular/

This is an example showing how to use Skywire board with LE910-x module.

In this example, I had used the LE910-EUG module for 4G communication. Mbed OS code wasn't changed for LE910-x, because the Telit' HE910 is included mainline code on Mbed OS already. HE910 and LE910 are most similar. Therefore you can use LE910 via HE910 driver. Please check to configure of mbed_app.json, and initialize code for Skywire board of main.cpp.

Open mbed_app.json, you need to define a UART for the MCU to communicate with the xE910 module.

            "TELIT_HE910.tx"                 : "D1",
            "TELIT_HE910.rx"                 : "D0",
            "TELIT_HE910.provide-default"    : true

If you are using Pelion CM, make the following settings:

            "nsapi.default-cellular-apn"     : "\"stream.co.uk\"",
            "nsapi.default-cellular-username": "\"streamip\"",
            "nsapi.default-cellular-password": "\"streamip\"",

For your information, please see Pelion Connectivity Quick start guide.

320

You can find Skywire sensor shield information though NimbeLink site.

Tested with

  • DISCO_L475VG_IOT01A
  • K64F

1. Import the application into your desktop:

 mbed import https://os.mbed.com/users/Daniel_Lee/code/mbed-os-example-cellular-le910/

 cd mbed-os-example-cellular-le910

2. Compile and program:

mbed compile -t GCC_ARM -m DISCO_L475VG_IOT01A

(supported toolchains : GCC_ARM / ARM / IAR)

3. Download binary to a target board

4. Result

mbed-os-example-cellular


Built: Feb  7 2020, 07:02:27
Starting Skywire board with LE910-EUG Demo...
Waiting for Skywire to Boot...
Wait 15 seconds..
Establishing connection


Connection Established.
TCP: connected with echo.mbedcloudtesting.com server
TCP: Sent 4 Bytes to echo.mbedcloudtesting.com
Received from echo server 4 Bytes


Success. Exiting

README.md@46:b872be3e1526, 2019-09-23 (annotated)

Committer:
mbed_official
Date:
Mon Sep 23 09:01:53 2019 +0100
Revision:
46:b872be3e1526
Parent:
45:fcbbda26336a 
Merge pull request #161 from AriParkkila/cell-readme-provide



Update readme and mbed_app.json with profile-default configs

.

Commit copied from https://github.com/ARMmbed/mbed-os-example-cellular

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:4611f6cf2413 1 # Example cellular application for Mbed OS
mbed_official 0:4611f6cf2413 2
mbed_official 0:4611f6cf2413 3 This is an example based on `mbed-os` cellular APIs that demonstrates a TCP or UDP echo transaction with a public echo server.
mbed_official 0:4611f6cf2413 4
mbed_official 34:6f85d44597ac 5 (Note: To see this example in a rendered form you can import into the Arm Mbed Online Compiler, please see [the documentation](https://os.mbed.com/docs/mbed-os/latest/apis/cellular-api.html#cellular-example-connection-establishment).)
mbed_official 34:6f85d44597ac 6
mbed_official 0:4611f6cf2413 7 ## Getting started
mbed_official 0:4611f6cf2413 8
mbed_official 0:4611f6cf2413 9 This particular cellular application uses a cellular network and network-socket APIs that are part of [`mbed-os`](https://github.com/ARMmbed/mbed-os).
mbed_official 0:4611f6cf2413 10
mbed_official 26:348eec457e58 11 The program uses a [cellular modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/cellular/framework/API) using an external IP stack (LWIP) standard 3GPP AT 27.007 AT commands to setup the cellular modem and registers to the network.
mbed_official 0:4611f6cf2413 12
mbed_official 0:4611f6cf2413 13 After registration, the driver opens a point-to-point protocol (PPP) pipe using LWIP with the cellular modem and connects to internet. This driver currently supports UART data connection type only between your cellular modem and MCU.
mbed_official 0:4611f6cf2413 14
mbed_official 34:6f85d44597ac 15 For more information on Arm Mbed OS cellular APIs and porting guide, please visit the [Mbed OS cellular API](https://os.mbed.com/docs/latest/reference/cellular.html) and [contributing documentation](https://os.mbed.com/docs/mbed-os/latest/contributing/index.html).
mbed_official 0:4611f6cf2413 16
mbed_official 0:4611f6cf2413 17 ### Download the application
mbed_official 0:4611f6cf2413 18
mbed_official 0:4611f6cf2413 19 ```sh
mbed_official 0:4611f6cf2413 20 $ mbed import mbed-os-example-cellular
mbed_official 0:4611f6cf2413 21 $ cd mbed-os-example-cellular
mbed_official 0:4611f6cf2413 22
mbed_official 0:4611f6cf2413 23 #OR
mbed_official 0:4611f6cf2413 24
mbed_official 0:4611f6cf2413 25 $ git clone git@github.com:ARMmbed/mbed-os-example-cellular.git
mbed_official 0:4611f6cf2413 26 $ cd mbed-os-example-cellular
mbed_official 0:4611f6cf2413 27 ```
mbed_official 0:4611f6cf2413 28
mbed_official 0:4611f6cf2413 29 ### Change the network and SIM credentials
mbed_official 0:4611f6cf2413 30
mbed_official 46:b872be3e1526 31 See the file `mbed_app.json` in the root directory of your application. This file contains all the user specific configurations your application needs. Provide the pin code for your SIM card, as well as any other cellular settings, or `null` if not used. For example:
mbed_official 0:4611f6cf2413 32
mbed_official 0:4611f6cf2413 33 ```json
mbed_official 46:b872be3e1526 34 "target_overrides": {
mbed_official 46:b872be3e1526 35 "*": {
mbed_official 46:b872be3e1526 36 "nsapi.default-cellular-sim-pin": "\"1234\"",
mbed_official 6:5678c0b6f74e 37 ```
mbed_official 0:4611f6cf2413 38
mbed_official 40:c46ee5b71843 39 ### Selecting socket type (TCP, UDP or NONIP)
mbed_official 0:4611f6cf2413 40
mbed_official 0:4611f6cf2413 41
mbed_official 6:5678c0b6f74e 42 You can choose which socket type the application should use; however, please note that TCP is a more reliable transmission protocol. For example:
mbed_official 0:4611f6cf2413 43
mbed_official 0:4611f6cf2413 44
mbed_official 0:4611f6cf2413 45 ```json
mbed_official 0:4611f6cf2413 46
mbed_official 0:4611f6cf2413 47 "sock-type": "TCP",
mbed_official 0:4611f6cf2413 48
mbed_official 0:4611f6cf2413 49 ```
mbed_official 0:4611f6cf2413 50
mbed_official 0:4611f6cf2413 51 ### Turning modem AT echo trace on
mbed_official 0:4611f6cf2413 52
mbed_official 11:23ea0907186e 53 If you like details and wish to know about all the AT interactions between the modem and your driver, turn on the modem AT echo trace.
mbed_official 0:4611f6cf2413 54
mbed_official 0:4611f6cf2413 55 ```json
mbed_official 11:23ea0907186e 56 "cellular.debug-at": true
mbed_official 0:4611f6cf2413 57 ```
mbed_official 0:4611f6cf2413 58
mbed_official 6:5678c0b6f74e 59 ### Turning on the tracing and trace level
mbed_official 6:5678c0b6f74e 60
mbed_official 6:5678c0b6f74e 61 If you like to add more traces or follow the current ones you can turn traces on by changing `mbed-trace.enable` in mbed_app.json
mbed_official 6:5678c0b6f74e 62
mbed_official 6:5678c0b6f74e 63 ```"target_overrides": {
mbed_official 6:5678c0b6f74e 64 "*": {
mbed_official 11:23ea0907186e 65 "mbed-trace.enable": true,
mbed_official 6:5678c0b6f74e 66 ```
mbed_official 6:5678c0b6f74e 67
mbed_official 6:5678c0b6f74e 68 After you have defined `mbed-trace.enable: true`, you can set trace levels by changing value in `trace-level`
mbed_official 6:5678c0b6f74e 69
mbed_official 6:5678c0b6f74e 70 ```"trace-level": {
mbed_official 6:5678c0b6f74e 71 "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
mbed_official 6:5678c0b6f74e 72 "macro_name": "MBED_TRACE_MAX_LEVEL",
mbed_official 6:5678c0b6f74e 73 "value": "TRACE_LEVEL_INFO"
mbed_official 6:5678c0b6f74e 74 }
mbed_official 6:5678c0b6f74e 75 ```
mbed_official 6:5678c0b6f74e 76
mbed_official 0:4611f6cf2413 77 ### Board support
mbed_official 0:4611f6cf2413 78
mbed_official 34:6f85d44597ac 79 The [cellular modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/cellular/framework/API) in this example uses PPP with an Mbed-supported external IP stack. It supports targets when modem exists on the Mbed Enabled target as opposed to plug-in modules (shields). For more details, please see our [Mbed OS cellular documentation](https://os.mbed.com/docs/mbed-os/latest/apis/cellular-api.html).
mbed_official 0:4611f6cf2413 80
mbed_official 16:bf6ed28b4d08 81 Currently supported boards with onboard modem chips are:
mbed_official 16:bf6ed28b4d08 82
mbed_official 26:348eec457e58 83 [u-blox C027](https://os.mbed.com/platforms/u-blox-C027/)
mbed_official 16:bf6ed28b4d08 84 [MultiTech MTS Dragonfly](https://os.mbed.com/platforms/MTS-Dragonfly/)
mbed_official 16:bf6ed28b4d08 85
mbed_official 46:b872be3e1526 86 For a cellular shield, you need to define which shield to use with `provide-default`, and also how the shield is connected to the Mbed OS board. For example, a generic AT/PPP modem would add from the `GENERIC_AT3GPP/mbed_lib.json` file to your `mbed_app.json`:
mbed_official 46:b872be3e1526 87 ```
mbed_official 46:b872be3e1526 88 "target_overrides": {
mbed_official 46:b872be3e1526 89 "GENERIC_AT3GPP.provide-default": true,
mbed_official 46:b872be3e1526 90 "GENERIC_AT3GPP.tx": "<tx-pinmap>",
mbed_official 46:b872be3e1526 91 "GENERIC_AT3GPP.rx": "<rx-pinmap>"
mbed_official 46:b872be3e1526 92 }
mbed_official 46:b872be3e1526 93 ```
mbed_official 0:4611f6cf2413 94
mbed_official 0:4611f6cf2413 95 ## Compiling the application
mbed_official 0:4611f6cf2413 96
mbed_official 31:fbb094e89746 97 The master branch is for daily development and it uses the latest mbed-os/master release.
mbed_official 28:232da3ce8a88 98
mbed_official 31:fbb094e89746 99 To use older versions update Mbed OS release tag, for example:
mbed_official 28:232da3ce8a88 100
mbed_official 28:232da3ce8a88 101 ```
mbed_official 28:232da3ce8a88 102 mbed releases
mbed_official 28:232da3ce8a88 103 * mbed-os-5.10.4
mbed_official 28:232da3ce8a88 104 ...
mbed_official 28:232da3ce8a88 105 mbed update mbed-os-5.10.4
mbed_official 28:232da3ce8a88 106 ```
mbed_official 28:232da3ce8a88 107
mbed_official 28:232da3ce8a88 108 You may need to use `--clean` option to discard your local changes (use with caution).
mbed_official 28:232da3ce8a88 109
mbed_official 0:4611f6cf2413 110 Use Mbed CLI commands to generate a binary for the application. For example, in the case of GCC, use the following command:
mbed_official 0:4611f6cf2413 111
mbed_official 0:4611f6cf2413 112 ```sh
mbed_official 0:4611f6cf2413 113 $ mbed compile -m YOUR_TARGET_WITH_MODEM -t GCC_ARM
mbed_official 0:4611f6cf2413 114 ```
mbed_official 0:4611f6cf2413 115
mbed_official 0:4611f6cf2413 116 ## Running the application
mbed_official 0:4611f6cf2413 117
mbed_official 0:4611f6cf2413 118 Drag and drop the application binary from `BUILD/YOUR_TARGET_WITH_MODEM/GCC_ARM/mbed-os-example-cellular.bin` to your Mbed Enabled target hardware, which appears as a USB device on your host machine.
mbed_official 0:4611f6cf2413 119
mbed_official 0:4611f6cf2413 120 Attach a serial console emulator of your choice (for example, PuTTY, Minicom or screen) to your USB device. Set the baudrate to 115200 bit/s, and reset your board by pressing the reset button.
mbed_official 0:4611f6cf2413 121
mbed_official 0:4611f6cf2413 122 You should see an output similar to this:
mbed_official 0:4611f6cf2413 123
mbed_official 0:4611f6cf2413 124 ```
mbed_official 2:0f644d6045cf 125 mbed-os-example-cellular
mbed_official 6:5678c0b6f74e 126 Establishing connection ......
mbed_official 2:0f644d6045cf 127
mbed_official 0:4611f6cf2413 128 Connection Established.
mbed_official 2:0f644d6045cf 129 TCP: connected with echo.mbedcloudtesting.com server
mbed_official 2:0f644d6045cf 130 TCP: Sent 4 Bytes to echo.mbedcloudtesting.com
mbed_official 0:4611f6cf2413 131 Received from echo server 4 Bytes
mbed_official 2:0f644d6045cf 132
mbed_official 2:0f644d6045cf 133
mbed_official 0:4611f6cf2413 134 Success. Exiting
mbed_official 0:4611f6cf2413 135 ```
mbed_official 0:4611f6cf2413 136
mbed_official 0:4611f6cf2413 137 ## Troubleshooting
mbed_official 0:4611f6cf2413 138
mbed_official 45:fcbbda26336a 139 * Make sure the fields `nsapi.default-cellular-sim-pin`, `nsapi.default-cellular-plmn`, `nsapi.default-cellular-apn`, `nsapi.default-cellular-username` and `nsapi.default-cellular-password` from the `mbed_app.json` file are filled in correctly. The correct values should appear in the user manual of the board if using eSIM or in the details of the SIM card if using normal SIM.
mbed_official 45:fcbbda26336a 140 * Enable trace flag to have access to debug information `"mbed-trace.enable": true` and `"cellular.debug-at": true`.
mbed_official 46:b872be3e1526 141 * Error Message: Assertion failed: iface usually means that a default modem is not defined, e.g. `"GENERIC_AT3GPP.provide-default": true`
mbed_official 46:b872be3e1526 142 * If the modem does not respond to (AT) queries, check that UART pins (tx, rx, rts, cts) are connected and defined, e.g. `"GENERIC_AT3GPP.tx": "<tx-pinmap>"`, ...
mbed_official 46:b872be3e1526 143 * It is a common case that a modem seems to connect fine with just USB power, but actually it needs to have an external power supply for a data connection.
mbed_official 11:23ea0907186e 144 * Try both `TCP` and `UDP` socket types.
mbed_official 11:23ea0907186e 145 * Try both `"lwip.ppp-enabled": true` and `"lwip.ppp-enabled": false`.
mbed_official 11:23ea0907186e 146 * The modem may support only a fixed baud-rate, such as `"platform.default-serial-baud-rate": 9600`.
mbed_official 11:23ea0907186e 147 * The modem and network may only support IPv6 in which case `"lwip.ipv6-enabled": true` shall be defined.
mbed_official 11:23ea0907186e 148 * The SIM and modem must have compatible cellular technology (3G, 4G, NB-IoT, ...) supported and cellular network available.
mbed_official 40:c46ee5b71843 149 * Enable CIoT optimization for NONIP socket `control-plane-opt: true`.
mbed_official 11:23ea0907186e 150
mbed_official 11:23ea0907186e 151 If you have problems to get started with debugging, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.
mbed_official 37:6482227bfa51 152
mbed_official 37:6482227bfa51 153 ### License and contributions
mbed_official 37:6482227bfa51 154
mbed_official 37:6482227bfa51 155 The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see [contributing.md](CONTRIBUTING.md) for more info.
mbed_official 37:6482227bfa51 156
mbed_official 37:6482227bfa51 157 This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.
mbed_official 37:6482227bfa51 158