Cellular example code for Seeed Wio 3G and Wio LTE-M1/NB1(BG96)

Example cellular application for Mbed OS

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

(Note: To see this example in a rendered form you can import into the Arm Mbed Online Compiler, please see the documentation.)

Getting started

This particular cellular application uses a cellular network and network-socket APIs that are part of `mbed-os`.

The program uses a cellular modem driver using an external IP stack (LWIP) standard 3GPP AT 27.007 AT commands to setup the cellular modem and registers to the network.

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.

For more information on Arm Mbed OS cellular APIs and porting guide, please visit the Mbed OS cellular API and contributing documentation.

Download the application

$ mbed import mbed-os-example-cellular
$ cd mbed-os-example-cellular
 
#OR
 
$ git clone git@github.com:ARMmbed/mbed-os-example-cellular.git
$ cd mbed-os-example-cellular

Change the network and SIM credentials

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 APN settings if needed. For example:

        "nsapi.default-cellular-plmn": 0,
        "nsapi.default-cellular-sim-pin": "\"1234\"",
        "nsapi.default-cellular-apn": 0,
        "nsapi.default-cellular-username": 0,
        "nsapi.default-cellular-password": 0

Selecting socket type (TCP, UDP or NONIP)

You can choose which socket type the application should use; however, please note that TCP is a more reliable transmission protocol. For example:

 
     "sock-type": "TCP",
 

Turning modem AT echo trace on

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.

        "cellular.debug-at": true

Turning on the tracing and trace level

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

"target_overrides": {
        "*": {
            "mbed-trace.enable": true,

After you have defined `mbed-trace.enable: true`, you can set trace levels by changing value in `trace-level`

"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"
        }

Board support

The cellular modem driver 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.

Compiling the application

The master branch is for daily development and it uses the latest mbed-os/master release.

To use older versions update Mbed OS release tag, for example:

mbed releases
 * mbed-os-5.10.4
   ...
mbed update mbed-os-5.10.4

You may need to use `clean` option to discard your local changes (use with caution).

Use Mbed CLI commands to generate a binary for the application. For example, in the case of GCC, use the following command:

$ mbed compile -m YOUR_TARGET_WITH_MODEM -t GCC_ARM

Running the application

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.

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.

You should see an output similar to this:

mbed-os-example-cellular
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

Troubleshooting

  • Make sure the fields `sim-pin-code`, `apn`, `username` and `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.
  • Enable trace flag to have access to debug information `"mbed-trace.enable": true`.
  • Try both `TCP` and `UDP` socket types.
  • Try both `"lwip.ppp-enabled": true` and `"lwip.ppp-enabled": false`.
  • The modem may support only a fixed baud-rate, such as `"platform.default-serial-baud-rate": 9600`.
  • The modem and network may only support IPv6 in which case `"lwip.ipv6-enabled": true` shall be defined.
  • The SIM and modem must have compatible cellular technology (3G, 4G, NB-IoT, ...) supported and cellular network available.
  • Enable CIoT optimization for NONIP socket `control-plane-opt: true`.

If you have problems to get started with debugging, you can review the documentation for suggestions on what could be wrong and how to fix it.

License and contributions

The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see contributing.md for more info.

This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.

Committer:
MACRUM
Date:
Fri May 10 10:18:11 2019 +0900
Revision:
0:fb5e1789de47
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MACRUM 0:fb5e1789de47 1 Apache License
MACRUM 0:fb5e1789de47 2 Version 2.0, January 2004
MACRUM 0:fb5e1789de47 3 http://www.apache.org/licenses/
MACRUM 0:fb5e1789de47 4
MACRUM 0:fb5e1789de47 5 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
MACRUM 0:fb5e1789de47 6
MACRUM 0:fb5e1789de47 7 1. Definitions.
MACRUM 0:fb5e1789de47 8
MACRUM 0:fb5e1789de47 9 "License" shall mean the terms and conditions for use, reproduction,
MACRUM 0:fb5e1789de47 10 and distribution as defined by Sections 1 through 9 of this document.
MACRUM 0:fb5e1789de47 11
MACRUM 0:fb5e1789de47 12 "Licensor" shall mean the copyright owner or entity authorized by
MACRUM 0:fb5e1789de47 13 the copyright owner that is granting the License.
MACRUM 0:fb5e1789de47 14
MACRUM 0:fb5e1789de47 15 "Legal Entity" shall mean the union of the acting entity and all
MACRUM 0:fb5e1789de47 16 other entities that control, are controlled by, or are under common
MACRUM 0:fb5e1789de47 17 control with that entity. For the purposes of this definition,
MACRUM 0:fb5e1789de47 18 "control" means (i) the power, direct or indirect, to cause the
MACRUM 0:fb5e1789de47 19 direction or management of such entity, whether by contract or
MACRUM 0:fb5e1789de47 20 otherwise, or (ii) ownership of fifty percent (50%) or more of the
MACRUM 0:fb5e1789de47 21 outstanding shares, or (iii) beneficial ownership of such entity.
MACRUM 0:fb5e1789de47 22
MACRUM 0:fb5e1789de47 23 "You" (or "Your") shall mean an individual or Legal Entity
MACRUM 0:fb5e1789de47 24 exercising permissions granted by this License.
MACRUM 0:fb5e1789de47 25
MACRUM 0:fb5e1789de47 26 "Source" form shall mean the preferred form for making modifications,
MACRUM 0:fb5e1789de47 27 including but not limited to software source code, documentation
MACRUM 0:fb5e1789de47 28 source, and configuration files.
MACRUM 0:fb5e1789de47 29
MACRUM 0:fb5e1789de47 30 "Object" form shall mean any form resulting from mechanical
MACRUM 0:fb5e1789de47 31 transformation or translation of a Source form, including but
MACRUM 0:fb5e1789de47 32 not limited to compiled object code, generated documentation,
MACRUM 0:fb5e1789de47 33 and conversions to other media types.
MACRUM 0:fb5e1789de47 34
MACRUM 0:fb5e1789de47 35 "Work" shall mean the work of authorship, whether in Source or
MACRUM 0:fb5e1789de47 36 Object form, made available under the License, as indicated by a
MACRUM 0:fb5e1789de47 37 copyright notice that is included in or attached to the work
MACRUM 0:fb5e1789de47 38 (an example is provided in the Appendix below).
MACRUM 0:fb5e1789de47 39
MACRUM 0:fb5e1789de47 40 "Derivative Works" shall mean any work, whether in Source or Object
MACRUM 0:fb5e1789de47 41 form, that is based on (or derived from) the Work and for which the
MACRUM 0:fb5e1789de47 42 editorial revisions, annotations, elaborations, or other modifications
MACRUM 0:fb5e1789de47 43 represent, as a whole, an original work of authorship. For the purposes
MACRUM 0:fb5e1789de47 44 of this License, Derivative Works shall not include works that remain
MACRUM 0:fb5e1789de47 45 separable from, or merely link (or bind by name) to the interfaces of,
MACRUM 0:fb5e1789de47 46 the Work and Derivative Works thereof.
MACRUM 0:fb5e1789de47 47
MACRUM 0:fb5e1789de47 48 "Contribution" shall mean any work of authorship, including
MACRUM 0:fb5e1789de47 49 the original version of the Work and any modifications or additions
MACRUM 0:fb5e1789de47 50 to that Work or Derivative Works thereof, that is intentionally
MACRUM 0:fb5e1789de47 51 submitted to Licensor for inclusion in the Work by the copyright owner
MACRUM 0:fb5e1789de47 52 or by an individual or Legal Entity authorized to submit on behalf of
MACRUM 0:fb5e1789de47 53 the copyright owner. For the purposes of this definition, "submitted"
MACRUM 0:fb5e1789de47 54 means any form of electronic, verbal, or written communication sent
MACRUM 0:fb5e1789de47 55 to the Licensor or its representatives, including but not limited to
MACRUM 0:fb5e1789de47 56 communication on electronic mailing lists, source code control systems,
MACRUM 0:fb5e1789de47 57 and issue tracking systems that are managed by, or on behalf of, the
MACRUM 0:fb5e1789de47 58 Licensor for the purpose of discussing and improving the Work, but
MACRUM 0:fb5e1789de47 59 excluding communication that is conspicuously marked or otherwise
MACRUM 0:fb5e1789de47 60 designated in writing by the copyright owner as "Not a Contribution."
MACRUM 0:fb5e1789de47 61
MACRUM 0:fb5e1789de47 62 "Contributor" shall mean Licensor and any individual or Legal Entity
MACRUM 0:fb5e1789de47 63 on behalf of whom a Contribution has been received by Licensor and
MACRUM 0:fb5e1789de47 64 subsequently incorporated within the Work.
MACRUM 0:fb5e1789de47 65
MACRUM 0:fb5e1789de47 66 2. Grant of Copyright License. Subject to the terms and conditions of
MACRUM 0:fb5e1789de47 67 this License, each Contributor hereby grants to You a perpetual,
MACRUM 0:fb5e1789de47 68 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
MACRUM 0:fb5e1789de47 69 copyright license to reproduce, prepare Derivative Works of,
MACRUM 0:fb5e1789de47 70 publicly display, publicly perform, sublicense, and distribute the
MACRUM 0:fb5e1789de47 71 Work and such Derivative Works in Source or Object form.
MACRUM 0:fb5e1789de47 72
MACRUM 0:fb5e1789de47 73 3. Grant of Patent License. Subject to the terms and conditions of
MACRUM 0:fb5e1789de47 74 this License, each Contributor hereby grants to You a perpetual,
MACRUM 0:fb5e1789de47 75 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
MACRUM 0:fb5e1789de47 76 (except as stated in this section) patent license to make, have made,
MACRUM 0:fb5e1789de47 77 use, offer to sell, sell, import, and otherwise transfer the Work,
MACRUM 0:fb5e1789de47 78 where such license applies only to those patent claims licensable
MACRUM 0:fb5e1789de47 79 by such Contributor that are necessarily infringed by their
MACRUM 0:fb5e1789de47 80 Contribution(s) alone or by combination of their Contribution(s)
MACRUM 0:fb5e1789de47 81 with the Work to which such Contribution(s) was submitted. If You
MACRUM 0:fb5e1789de47 82 institute patent litigation against any entity (including a
MACRUM 0:fb5e1789de47 83 cross-claim or counterclaim in a lawsuit) alleging that the Work
MACRUM 0:fb5e1789de47 84 or a Contribution incorporated within the Work constitutes direct
MACRUM 0:fb5e1789de47 85 or contributory patent infringement, then any patent licenses
MACRUM 0:fb5e1789de47 86 granted to You under this License for that Work shall terminate
MACRUM 0:fb5e1789de47 87 as of the date such litigation is filed.
MACRUM 0:fb5e1789de47 88
MACRUM 0:fb5e1789de47 89 4. Redistribution. You may reproduce and distribute copies of the
MACRUM 0:fb5e1789de47 90 Work or Derivative Works thereof in any medium, with or without
MACRUM 0:fb5e1789de47 91 modifications, and in Source or Object form, provided that You
MACRUM 0:fb5e1789de47 92 meet the following conditions:
MACRUM 0:fb5e1789de47 93
MACRUM 0:fb5e1789de47 94 (a) You must give any other recipients of the Work or
MACRUM 0:fb5e1789de47 95 Derivative Works a copy of this License; and
MACRUM 0:fb5e1789de47 96
MACRUM 0:fb5e1789de47 97 (b) You must cause any modified files to carry prominent notices
MACRUM 0:fb5e1789de47 98 stating that You changed the files; and
MACRUM 0:fb5e1789de47 99
MACRUM 0:fb5e1789de47 100 (c) You must retain, in the Source form of any Derivative Works
MACRUM 0:fb5e1789de47 101 that You distribute, all copyright, patent, trademark, and
MACRUM 0:fb5e1789de47 102 attribution notices from the Source form of the Work,
MACRUM 0:fb5e1789de47 103 excluding those notices that do not pertain to any part of
MACRUM 0:fb5e1789de47 104 the Derivative Works; and
MACRUM 0:fb5e1789de47 105
MACRUM 0:fb5e1789de47 106 (d) If the Work includes a "NOTICE" text file as part of its
MACRUM 0:fb5e1789de47 107 distribution, then any Derivative Works that You distribute must
MACRUM 0:fb5e1789de47 108 include a readable copy of the attribution notices contained
MACRUM 0:fb5e1789de47 109 within such NOTICE file, excluding those notices that do not
MACRUM 0:fb5e1789de47 110 pertain to any part of the Derivative Works, in at least one
MACRUM 0:fb5e1789de47 111 of the following places: within a NOTICE text file distributed
MACRUM 0:fb5e1789de47 112 as part of the Derivative Works; within the Source form or
MACRUM 0:fb5e1789de47 113 documentation, if provided along with the Derivative Works; or,
MACRUM 0:fb5e1789de47 114 within a display generated by the Derivative Works, if and
MACRUM 0:fb5e1789de47 115 wherever such third-party notices normally appear. The contents
MACRUM 0:fb5e1789de47 116 of the NOTICE file are for informational purposes only and
MACRUM 0:fb5e1789de47 117 do not modify the License. You may add Your own attribution
MACRUM 0:fb5e1789de47 118 notices within Derivative Works that You distribute, alongside
MACRUM 0:fb5e1789de47 119 or as an addendum to the NOTICE text from the Work, provided
MACRUM 0:fb5e1789de47 120 that such additional attribution notices cannot be construed
MACRUM 0:fb5e1789de47 121 as modifying the License.
MACRUM 0:fb5e1789de47 122
MACRUM 0:fb5e1789de47 123 You may add Your own copyright statement to Your modifications and
MACRUM 0:fb5e1789de47 124 may provide additional or different license terms and conditions
MACRUM 0:fb5e1789de47 125 for use, reproduction, or distribution of Your modifications, or
MACRUM 0:fb5e1789de47 126 for any such Derivative Works as a whole, provided Your use,
MACRUM 0:fb5e1789de47 127 reproduction, and distribution of the Work otherwise complies with
MACRUM 0:fb5e1789de47 128 the conditions stated in this License.
MACRUM 0:fb5e1789de47 129
MACRUM 0:fb5e1789de47 130 5. Submission of Contributions. Unless You explicitly state otherwise,
MACRUM 0:fb5e1789de47 131 any Contribution intentionally submitted for inclusion in the Work
MACRUM 0:fb5e1789de47 132 by You to the Licensor shall be under the terms and conditions of
MACRUM 0:fb5e1789de47 133 this License, without any additional terms or conditions.
MACRUM 0:fb5e1789de47 134 Notwithstanding the above, nothing herein shall supersede or modify
MACRUM 0:fb5e1789de47 135 the terms of any separate license agreement you may have executed
MACRUM 0:fb5e1789de47 136 with Licensor regarding such Contributions.
MACRUM 0:fb5e1789de47 137
MACRUM 0:fb5e1789de47 138 6. Trademarks. This License does not grant permission to use the trade
MACRUM 0:fb5e1789de47 139 names, trademarks, service marks, or product names of the Licensor,
MACRUM 0:fb5e1789de47 140 except as required for reasonable and customary use in describing the
MACRUM 0:fb5e1789de47 141 origin of the Work and reproducing the content of the NOTICE file.
MACRUM 0:fb5e1789de47 142
MACRUM 0:fb5e1789de47 143 7. Disclaimer of Warranty. Unless required by applicable law or
MACRUM 0:fb5e1789de47 144 agreed to in writing, Licensor provides the Work (and each
MACRUM 0:fb5e1789de47 145 Contributor provides its Contributions) on an "AS IS" BASIS,
MACRUM 0:fb5e1789de47 146 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
MACRUM 0:fb5e1789de47 147 implied, including, without limitation, any warranties or conditions
MACRUM 0:fb5e1789de47 148 of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
MACRUM 0:fb5e1789de47 149 PARTICULAR PURPOSE. You are solely responsible for determining the
MACRUM 0:fb5e1789de47 150 appropriateness of using or redistributing the Work and assume any
MACRUM 0:fb5e1789de47 151 risks associated with Your exercise of permissions under this License.
MACRUM 0:fb5e1789de47 152
MACRUM 0:fb5e1789de47 153 8. Limitation of Liability. In no event and under no legal theory,
MACRUM 0:fb5e1789de47 154 whether in tort (including negligence), contract, or otherwise,
MACRUM 0:fb5e1789de47 155 unless required by applicable law (such as deliberate and grossly
MACRUM 0:fb5e1789de47 156 negligent acts) or agreed to in writing, shall any Contributor be
MACRUM 0:fb5e1789de47 157 liable to You for damages, including any direct, indirect, special,
MACRUM 0:fb5e1789de47 158 incidental, or consequential damages of any character arising as a
MACRUM 0:fb5e1789de47 159 result of this License or out of the use or inability to use the
MACRUM 0:fb5e1789de47 160 Work (including but not limited to damages for loss of goodwill,
MACRUM 0:fb5e1789de47 161 work stoppage, computer failure or malfunction, or any and all
MACRUM 0:fb5e1789de47 162 other commercial damages or losses), even if such Contributor
MACRUM 0:fb5e1789de47 163 has been advised of the possibility of such damages.
MACRUM 0:fb5e1789de47 164
MACRUM 0:fb5e1789de47 165 9. Accepting Warranty or Additional Liability. While redistributing
MACRUM 0:fb5e1789de47 166 the Work or Derivative Works thereof, You may choose to offer,
MACRUM 0:fb5e1789de47 167 and charge a fee for, acceptance of support, warranty, indemnity,
MACRUM 0:fb5e1789de47 168 or other liability obligations and/or rights consistent with this
MACRUM 0:fb5e1789de47 169 License. However, in accepting such obligations, You may act only
MACRUM 0:fb5e1789de47 170 on Your own behalf and on Your sole responsibility, not on behalf
MACRUM 0:fb5e1789de47 171 of any other Contributor, and only if You agree to indemnify,
MACRUM 0:fb5e1789de47 172 defend, and hold each Contributor harmless for any liability
MACRUM 0:fb5e1789de47 173 incurred by, or claims asserted against, such Contributor by reason
MACRUM 0:fb5e1789de47 174 of your accepting any such warranty or additional liability.
MACRUM 0:fb5e1789de47 175
MACRUM 0:fb5e1789de47 176 END OF TERMS AND CONDITIONS
MACRUM 0:fb5e1789de47 177
MACRUM 0:fb5e1789de47 178 APPENDIX: How to apply the Apache License to your work.
MACRUM 0:fb5e1789de47 179
MACRUM 0:fb5e1789de47 180 To apply the Apache License to your work, attach the following
MACRUM 0:fb5e1789de47 181 boilerplate notice, with the fields enclosed by brackets "{}"
MACRUM 0:fb5e1789de47 182 replaced with your own identifying information. (Don't include
MACRUM 0:fb5e1789de47 183 the brackets!) The text should be enclosed in the appropriate
MACRUM 0:fb5e1789de47 184 comment syntax for the file format. We also recommend that a
MACRUM 0:fb5e1789de47 185 file or class name and description of purpose be included on the
MACRUM 0:fb5e1789de47 186 same "printed page" as the copyright notice for easier
MACRUM 0:fb5e1789de47 187 identification within third-party archives.
MACRUM 0:fb5e1789de47 188
MACRUM 0:fb5e1789de47 189 Copyright {yyyy} {name of copyright owner}
MACRUM 0:fb5e1789de47 190
MACRUM 0:fb5e1789de47 191 Licensed under the Apache License, Version 2.0 (the "License");
MACRUM 0:fb5e1789de47 192 you may not use this file except in compliance with the License.
MACRUM 0:fb5e1789de47 193 You may obtain a copy of the License at
MACRUM 0:fb5e1789de47 194
MACRUM 0:fb5e1789de47 195 http://www.apache.org/licenses/LICENSE-2.0
MACRUM 0:fb5e1789de47 196
MACRUM 0:fb5e1789de47 197 Unless required by applicable law or agreed to in writing, software
MACRUM 0:fb5e1789de47 198 distributed under the License is distributed on an "AS IS" BASIS,
MACRUM 0:fb5e1789de47 199 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
MACRUM 0:fb5e1789de47 200 See the License for the specific language governing permissions and
MACRUM 0:fb5e1789de47 201 limitations under the License.
MACRUM 0:fb5e1789de47 202