Seeed / Mbed OS Wio_3G-example-cellular

Cellular example code for Seeed Wio 3G

Fork of Wio_3G-example-cellular by Toyomasa Watarai

README.md@17:a0330a2e9948, 2018-08-08 (annotated)

Committer:
MACRUM
Date:
Wed Aug 08 10:16:49 2018 +0000
Revision:
17:a0330a2e9948
Parent:
16:bf6ed28b4d08 
Add APN setting

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 0:4611f6cf2413 5 ## Getting started
mbed_official 0:4611f6cf2413 6
mbed_official 0:4611f6cf2413 7 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 8
mbed_official 0:4611f6cf2413 9 The program uses a [generic cellular modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_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.
mbed_official 0:4611f6cf2413 10
mbed_official 0:4611f6cf2413 11 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 12
mbed_official 0:4611f6cf2413 13 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-api.html) and [contributing documentation](https://os.mbed.com/docs/latest/reference/contributing-connectivity.html#cellularinterface).
mbed_official 0:4611f6cf2413 14
mbed_official 0:4611f6cf2413 15 ### Download the application
mbed_official 0:4611f6cf2413 16
mbed_official 0:4611f6cf2413 17 ```sh
mbed_official 0:4611f6cf2413 18 $ mbed import mbed-os-example-cellular
mbed_official 0:4611f6cf2413 19 $ cd mbed-os-example-cellular
mbed_official 0:4611f6cf2413 20
mbed_official 0:4611f6cf2413 21 #OR
mbed_official 0:4611f6cf2413 22
mbed_official 0:4611f6cf2413 23 $ git clone git@github.com:ARMmbed/mbed-os-example-cellular.git
mbed_official 0:4611f6cf2413 24 $ cd mbed-os-example-cellular
mbed_official 0:4611f6cf2413 25 ```
mbed_official 0:4611f6cf2413 26
mbed_official 0:4611f6cf2413 27 ### Change the network and SIM credentials
mbed_official 0:4611f6cf2413 28
mbed_official 0:4611f6cf2413 29 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:
mbed_official 0:4611f6cf2413 30
mbed_official 0:4611f6cf2413 31 ```json
mbed_official 0:4611f6cf2413 32 "sim-pin-code": {
mbed_official 0:4611f6cf2413 33 "help": "SIM PIN code",
mbed_official 0:4611f6cf2413 34 "value": "\"1234\""
mbed_official 0:4611f6cf2413 35 },
mbed_official 0:4611f6cf2413 36 "apn": {
mbed_official 0:4611f6cf2413 37 "help": "The APN string to use for this SIM/network, set to 0 if none",
mbed_official 0:4611f6cf2413 38 "value": "\"internet\""
mbed_official 0:4611f6cf2413 39 },
mbed_official 0:4611f6cf2413 40 "username": {
mbed_official 0:4611f6cf2413 41 "help": "The user name string to use for this APN, set to zero if none",
mbed_official 0:4611f6cf2413 42 "value": 0
mbed_official 0:4611f6cf2413 43 },
mbed_official 0:4611f6cf2413 44 "password": {
mbed_official 0:4611f6cf2413 45 "help": "The password string to use for this APN, set to 0 if none",
mbed_official 0:4611f6cf2413 46 "value": 0
mbed_official 0:4611f6cf2413 47 }
mbed_official 6:5678c0b6f74e 48 ```
mbed_official 0:4611f6cf2413 49
mbed_official 0:4611f6cf2413 50 ### Selecting socket type (TCP or UDP)
mbed_official 0:4611f6cf2413 51
mbed_official 0:4611f6cf2413 52
mbed_official 6:5678c0b6f74e 53 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 54
mbed_official 0:4611f6cf2413 55
mbed_official 0:4611f6cf2413 56 ```json
mbed_official 0:4611f6cf2413 57
mbed_official 0:4611f6cf2413 58 "sock-type": "TCP",
mbed_official 0:4611f6cf2413 59
mbed_official 0:4611f6cf2413 60 ```
mbed_official 0:4611f6cf2413 61
mbed_official 0:4611f6cf2413 62 ### Turning modem AT echo trace on
mbed_official 0:4611f6cf2413 63
mbed_official 11:23ea0907186e 64 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 65
mbed_official 0:4611f6cf2413 66 ```json
mbed_official 11:23ea0907186e 67 "cellular.debug-at": true
mbed_official 0:4611f6cf2413 68 ```
mbed_official 0:4611f6cf2413 69
mbed_official 6:5678c0b6f74e 70 ### Turning on the tracing and trace level
mbed_official 6:5678c0b6f74e 71
mbed_official 6:5678c0b6f74e 72 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 73
mbed_official 6:5678c0b6f74e 74 ```"target_overrides": {
mbed_official 6:5678c0b6f74e 75 "*": {
mbed_official 11:23ea0907186e 76 "target.features_add": ["LWIP"],
mbed_official 11:23ea0907186e 77 "mbed-trace.enable": true,
mbed_official 6:5678c0b6f74e 78 ```
mbed_official 6:5678c0b6f74e 79
mbed_official 6:5678c0b6f74e 80 After you have defined `mbed-trace.enable: true`, you can set trace levels by changing value in `trace-level`
mbed_official 6:5678c0b6f74e 81
mbed_official 6:5678c0b6f74e 82 ```"trace-level": {
mbed_official 6:5678c0b6f74e 83 "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
mbed_official 6:5678c0b6f74e 84 "macro_name": "MBED_TRACE_MAX_LEVEL",
mbed_official 6:5678c0b6f74e 85 "value": "TRACE_LEVEL_INFO"
mbed_official 6:5678c0b6f74e 86 }
mbed_official 6:5678c0b6f74e 87 ```
mbed_official 6:5678c0b6f74e 88
mbed_official 0:4611f6cf2413 89 ### Board support
mbed_official 0:4611f6cf2413 90
mbed_official 0:4611f6cf2413 91 The [generic cellular modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_modem_driver) this application uses was written using only a standard AT command set. It uses PPP with an Mbed-supported external IP stack. These abilities make the driver essentially generic, or nonvendor specific. However, this particular driver is for onboard-modem types. In other words, the 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/latest/reference/cellular-api.html).
mbed_official 0:4611f6cf2413 92
mbed_official 16:bf6ed28b4d08 93 Currently supported boards with onboard modem chips are:
mbed_official 16:bf6ed28b4d08 94
mbed_official 16:bf6ed28b4d08 95 [u-blox C027](https://os.mbed.com/platforms/u-blox-C027/)
mbed_official 16:bf6ed28b4d08 96 [MultiTech MTS Dragonfly](https://os.mbed.com/platforms/MTS-Dragonfly/)
mbed_official 16:bf6ed28b4d08 97
mbed_official 0:4611f6cf2413 98
mbed_official 0:4611f6cf2413 99 ## Compiling the application
mbed_official 0:4611f6cf2413 100
mbed_official 0:4611f6cf2413 101 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 102
mbed_official 0:4611f6cf2413 103 ```sh
mbed_official 0:4611f6cf2413 104 $ mbed compile -m YOUR_TARGET_WITH_MODEM -t GCC_ARM
mbed_official 0:4611f6cf2413 105 ```
mbed_official 0:4611f6cf2413 106
mbed_official 0:4611f6cf2413 107 ## Running the application
mbed_official 0:4611f6cf2413 108
mbed_official 0:4611f6cf2413 109 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 110
mbed_official 0:4611f6cf2413 111 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 112
mbed_official 0:4611f6cf2413 113 You should see an output similar to this:
mbed_official 0:4611f6cf2413 114
mbed_official 0:4611f6cf2413 115 ```
mbed_official 2:0f644d6045cf 116 mbed-os-example-cellular
mbed_official 6:5678c0b6f74e 117 Establishing connection ......
mbed_official 2:0f644d6045cf 118
mbed_official 0:4611f6cf2413 119 Connection Established.
mbed_official 2:0f644d6045cf 120 TCP: connected with echo.mbedcloudtesting.com server
mbed_official 2:0f644d6045cf 121 TCP: Sent 4 Bytes to echo.mbedcloudtesting.com
mbed_official 0:4611f6cf2413 122 Received from echo server 4 Bytes
mbed_official 2:0f644d6045cf 123
mbed_official 2:0f644d6045cf 124
mbed_official 0:4611f6cf2413 125 Success. Exiting
mbed_official 0:4611f6cf2413 126 ```
mbed_official 0:4611f6cf2413 127
mbed_official 0:4611f6cf2413 128 ## Troubleshooting
mbed_official 0:4611f6cf2413 129
mbed_official 11:23ea0907186e 130 * 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.
mbed_official 11:23ea0907186e 131 * Enable trace flag to have access to debug information `"mbed-trace.enable": true`.
mbed_official 11:23ea0907186e 132 * Try both `TCP` and `UDP` socket types.
mbed_official 11:23ea0907186e 133 * Try both `"lwip.ppp-enabled": true` and `"lwip.ppp-enabled": false`.
mbed_official 11:23ea0907186e 134 * The modem may support only a fixed baud-rate, such as `"platform.default-serial-baud-rate": 9600`.
mbed_official 11:23ea0907186e 135 * The modem and network may only support IPv6 in which case `"lwip.ipv6-enabled": true` shall be defined.
mbed_official 11:23ea0907186e 136 * The SIM and modem must have compatible cellular technology (3G, 4G, NB-IoT, ...) supported and cellular network available.
mbed_official 11:23ea0907186e 137
mbed_official 11:23ea0907186e 138 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.