Eric Jung / Mbed OS mbed-os-example-cellular-BG96

BG96 Cat.M1 basic sample for WIZnet IoT Shield based on Mbed-OS Cellular APIs (SK telecom network in Korea)

Overview

This code could be access via Cat.M1(BG96 module) of SK telecom network in Korea. Need a WIZnet IoT Shield BG96 board and development board. The code forked Daniel_Lee's mbed-os-example-cellular-BG96 repository and added some features.

/media/uploads/hkjung/wiznetiotshield_bg96_nucleo-l476rg_stacking.png /media/uploads/hkjung/wiznetiotshield_bg96_nucleo-l476rg_separate.png

Tested with

  • NUCLEO_L476RG
  • DISCO_L475VG_IOT01A
  • K64F

Example functionality

This example showcases the following device functionality:

1. Import the application into your desktop:

mbed import https://os.mbed.com/users/hkjung/code/mbed-os-example-cellular-BG96/
 
cd mbed-os-example-cellular-BG96

2. Compile and program:

mbed compile -t <toolchain> -m <TARGET_BOARD>

(supported toolchains : GCC_ARM / ARM / IAR)

3. Download binary to a target board

If need more information such as how to test, please look at https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-cellular/.

README.md@34:6f85d44597ac, 2019-02-15 (annotated)

Committer:
mbed_official
Date:
Fri Feb 15 15:26:44 2019 +0000
Revision:
34:6f85d44597ac
Parent:
31:fbb094e89746 
Merge pull request #117 from AnotherButler/patch-1



Add and update links to README.md

.

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 0:4611f6cf2413 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 APN settings if needed. For example:
mbed_official 0:4611f6cf2413 32
mbed_official 0:4611f6cf2413 33 ```json
mbed_official 29:f1f568035f90 34 "nsapi.default-cellular-plmn": 0,
mbed_official 29:f1f568035f90 35 "nsapi.default-cellular-sim-pin": "\"1234\"",
mbed_official 29:f1f568035f90 36 "nsapi.default-cellular-apn": 0,
mbed_official 29:f1f568035f90 37 "nsapi.default-cellular-username": 0,
mbed_official 29:f1f568035f90 38 "nsapi.default-cellular-password": 0
mbed_official 6:5678c0b6f74e 39 ```
mbed_official 0:4611f6cf2413 40
mbed_official 0:4611f6cf2413 41 ### Selecting socket type (TCP or UDP)
mbed_official 0:4611f6cf2413 42
mbed_official 0:4611f6cf2413 43
mbed_official 6:5678c0b6f74e 44 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 45
mbed_official 0:4611f6cf2413 46
mbed_official 0:4611f6cf2413 47 ```json
mbed_official 0:4611f6cf2413 48
mbed_official 0:4611f6cf2413 49 "sock-type": "TCP",
mbed_official 0:4611f6cf2413 50
mbed_official 0:4611f6cf2413 51 ```
mbed_official 0:4611f6cf2413 52
mbed_official 0:4611f6cf2413 53 ### Turning modem AT echo trace on
mbed_official 0:4611f6cf2413 54
mbed_official 11:23ea0907186e 55 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 56
mbed_official 0:4611f6cf2413 57 ```json
mbed_official 11:23ea0907186e 58 "cellular.debug-at": true
mbed_official 0:4611f6cf2413 59 ```
mbed_official 0:4611f6cf2413 60
mbed_official 6:5678c0b6f74e 61 ### Turning on the tracing and trace level
mbed_official 6:5678c0b6f74e 62
mbed_official 6:5678c0b6f74e 63 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 64
mbed_official 6:5678c0b6f74e 65 ```"target_overrides": {
mbed_official 6:5678c0b6f74e 66 "*": {
mbed_official 11:23ea0907186e 67 "mbed-trace.enable": true,
mbed_official 6:5678c0b6f74e 68 ```
mbed_official 6:5678c0b6f74e 69
mbed_official 6:5678c0b6f74e 70 After you have defined `mbed-trace.enable: true`, you can set trace levels by changing value in `trace-level`
mbed_official 6:5678c0b6f74e 71
mbed_official 6:5678c0b6f74e 72 ```"trace-level": {
mbed_official 6:5678c0b6f74e 73 "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
mbed_official 6:5678c0b6f74e 74 "macro_name": "MBED_TRACE_MAX_LEVEL",
mbed_official 6:5678c0b6f74e 75 "value": "TRACE_LEVEL_INFO"
mbed_official 6:5678c0b6f74e 76 }
mbed_official 6:5678c0b6f74e 77 ```
mbed_official 6:5678c0b6f74e 78
mbed_official 0:4611f6cf2413 79 ### Board support
mbed_official 0:4611f6cf2413 80
mbed_official 34:6f85d44597ac 81 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 82
mbed_official 16:bf6ed28b4d08 83 Currently supported boards with onboard modem chips are:
mbed_official 16:bf6ed28b4d08 84
mbed_official 26:348eec457e58 85 [u-blox C027](https://os.mbed.com/platforms/u-blox-C027/)
mbed_official 16:bf6ed28b4d08 86 [MultiTech MTS Dragonfly](https://os.mbed.com/platforms/MTS-Dragonfly/)
mbed_official 16:bf6ed28b4d08 87
mbed_official 0:4611f6cf2413 88
mbed_official 0:4611f6cf2413 89 ## Compiling the application
mbed_official 0:4611f6cf2413 90
mbed_official 31:fbb094e89746 91 The master branch is for daily development and it uses the latest mbed-os/master release.
mbed_official 28:232da3ce8a88 92
mbed_official 31:fbb094e89746 93 To use older versions update Mbed OS release tag, for example:
mbed_official 28:232da3ce8a88 94
mbed_official 28:232da3ce8a88 95 ```
mbed_official 28:232da3ce8a88 96 mbed releases
mbed_official 28:232da3ce8a88 97 * mbed-os-5.10.4
mbed_official 28:232da3ce8a88 98 ...
mbed_official 28:232da3ce8a88 99 mbed update mbed-os-5.10.4
mbed_official 28:232da3ce8a88 100 ```
mbed_official 28:232da3ce8a88 101
mbed_official 28:232da3ce8a88 102 You may need to use `--clean` option to discard your local changes (use with caution).
mbed_official 28:232da3ce8a88 103
mbed_official 0:4611f6cf2413 104 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 105
mbed_official 0:4611f6cf2413 106 ```sh
mbed_official 0:4611f6cf2413 107 $ mbed compile -m YOUR_TARGET_WITH_MODEM -t GCC_ARM
mbed_official 0:4611f6cf2413 108 ```
mbed_official 0:4611f6cf2413 109
mbed_official 0:4611f6cf2413 110 ## Running the application
mbed_official 0:4611f6cf2413 111
mbed_official 0:4611f6cf2413 112 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 113
mbed_official 0:4611f6cf2413 114 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 115
mbed_official 0:4611f6cf2413 116 You should see an output similar to this:
mbed_official 0:4611f6cf2413 117
mbed_official 0:4611f6cf2413 118 ```
mbed_official 2:0f644d6045cf 119 mbed-os-example-cellular
mbed_official 6:5678c0b6f74e 120 Establishing connection ......
mbed_official 2:0f644d6045cf 121
mbed_official 0:4611f6cf2413 122 Connection Established.
mbed_official 2:0f644d6045cf 123 TCP: connected with echo.mbedcloudtesting.com server
mbed_official 2:0f644d6045cf 124 TCP: Sent 4 Bytes to echo.mbedcloudtesting.com
mbed_official 0:4611f6cf2413 125 Received from echo server 4 Bytes
mbed_official 2:0f644d6045cf 126
mbed_official 2:0f644d6045cf 127
mbed_official 0:4611f6cf2413 128 Success. Exiting
mbed_official 0:4611f6cf2413 129 ```
mbed_official 0:4611f6cf2413 130
mbed_official 0:4611f6cf2413 131 ## Troubleshooting
mbed_official 0:4611f6cf2413 132
mbed_official 11:23ea0907186e 133 * 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 134 * Enable trace flag to have access to debug information `"mbed-trace.enable": true`.
mbed_official 11:23ea0907186e 135 * Try both `TCP` and `UDP` socket types.
mbed_official 11:23ea0907186e 136 * Try both `"lwip.ppp-enabled": true` and `"lwip.ppp-enabled": false`.
mbed_official 11:23ea0907186e 137 * The modem may support only a fixed baud-rate, such as `"platform.default-serial-baud-rate": 9600`.
mbed_official 11:23ea0907186e 138 * The modem and network may only support IPv6 in which case `"lwip.ipv6-enabled": true` shall be defined.
mbed_official 11:23ea0907186e 139 * The SIM and modem must have compatible cellular technology (3G, 4G, NB-IoT, ...) supported and cellular network available.
mbed_official 11:23ea0907186e 140
mbed_official 11:23ea0907186e 141 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.