mbed-os-example-cellular-BG96 - Test code that Cat.M1 of BG96 for SK Telecom in K…

Users » Daniel_Lee » Code » mbed-os-example-cellular-BG96

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

Test code that Cat.M1 of BG96 for SK Telecom in Korea

This example showing how to use Cat.M1(BG96 module) of SK telecom network in Korea. You need a WIZnet BG96 board or can connect directly to M2Mnet BG96 module and development board.

If you are using Mbed OS 5.11.5 version, please see here!
Pelion ready example code is here!

board board

/media/uploads/Daniel_Lee/small_pic.jpg

/media/uploads/Daniel_Lee/screen_shot_2019-11-14_at_1.38.16_pm.png

BG96 RESET = D7
BG96 PWRKEY = D9
BG96 RX = D0(or D2)
BG96 TX = D1(or D8)
BG96 VCC = VCC(5V)
BG96 GND = GND

Tested with

NUCLEO_F429ZI
DISCO_L475VG_IOT01A
K66F
K64F

Below boards are Need to connect board's D2 and D8 to BG96's TX and RX on mbed_app.json

NUCLEO_L152RE
NUCLEO_F401RE

 "QUECTEL_BG96.tx": "D8",
 "QUECTEL_BG96.rx": "D2",

1. Import the application into your desktop:

 mbed import https://os.mbed.com/users/Daniel_Lee/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

4. Result

mbed-os-example-cellular


Built: Jul 24 2019, 14:55:22


[MAIN], plmn: NULL
Establishing connection
M2Mnet(BG96) Power ON
[00005501ms][INFO][CELL]: New CellularContext  (20004120)
[00005501ms][INFO][CELL]: CellularContext plmn NULL
[00005502ms][INFO][CELL]: CellularContext connect
[00006503ms][INFO][CELL]: Start connecting (timeout 1000 ms)
[00006512ms][INFO][CELL]: RSSI unknown
[00006520ms][INFO][CELL]: Modem ready
[00006524ms][INFO][CELL]: RSSI unknown
[00006524ms][INFO][CELL]: Setup SIM (timeout 1000 ms)
[00006529ms][INFO][CELL]: SIM is ready
[00006558ms][INFO][CELL]: RSSI unknown
[00006566ms][INFO][CELL]: Network registration (timeout 1000 ms)
[00006570ms][INFO][CELL]: Continue after 1 seconds
[00006964ms][ERR ][CELL]: AT overflow
[00007576ms][INFO][CELL]: RSSI unknown
[00007582ms][INFO][CELL]: Registering network => Attaching network
[00007586ms][INFO][CELL]: RSSI unknown
[00007586ms][INFO][CELL]: Attaching network (timeout 1000 ms)
[00007660ms][INFO][CELL]: Found PDP context 7
[00007663ms][INFO][CELL]: Activate PDP context 7
[00009733ms][INFO][CELL]: Found PDP context 7

Connection Established.
[00009742ms][INFO][CELL]: Socket 0 open
[00009752ms][INFO][CELL]: Socket 1 open
[00009786ms][INFO][CELL]: Socket 1 sent 43 bytes to 8.8.8.8 port 53
[00009967ms][INFO][CELL]: Socket 1 recv 71 bytes from 64:ff9b::808:808 port 53
[00009972ms][INFO][CELL]: Socket 1 closed
TCP: connected with echo.mbedcloudtesting.com server
[00010384ms][INFO][CELL]: Socket 0 sent 4 bytes to 2a05:d018:21f:3800:3164:2a5c7
TCP: Sent 4 Bytes to echo.mbedcloudtesting.com
[00011257ms][INFO][CELL]: Socket 0 recv 4 bytes
[00021263ms][INFO][CELL]: Socket 0 closed
Received from echo server 4 Bytes
[00021263ms][INFO][CELL]: CellularContext disconnect()
[00021264ms][INFO][CELL]: cb: CellularContext disconnected


Success. Exiting

5. Patched code

Base modified location : mbed-os/features/cellular/framework/targets/QUECTEL/BG96
https://github.com/DanielDmlee/mbed-os/commit/820e0a323641a88fdf5981e0d51219a3104c5ea0
https://github.com/DanielDmlee/mbed-os/commit/26c3bcf75988eac1ad0b1ca347726da0ad636b64

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@29:f1f568035f90, 2018-11-23 (annotated)

Committer:: mbed_official
Date:: Fri Nov 23 12:00:32 2018 +0000
Revision:: 29:f1f568035f90
Parent:: 28:232da3ce8a88
Child:: 31:fbb094e89746

Updated json configuration instructions in READ.me.



.

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

Who changed what in which revision?

User	Revision	Line number	New 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	26:348eec457e58	9	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	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	26:348eec457e58	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.html) and [contributing documentation](https://os.mbed.com/docs/latest/reference/contributing.html).
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	29:f1f568035f90	32	"nsapi.default-cellular-plmn": 0,
mbed_official	29:f1f568035f90	33	"nsapi.default-cellular-sim-pin": "\"1234\"",
mbed_official	29:f1f568035f90	34	"nsapi.default-cellular-apn": 0,
mbed_official	29:f1f568035f90	35	"nsapi.default-cellular-username": 0,
mbed_official	29:f1f568035f90	36	"nsapi.default-cellular-password": 0
mbed_official	6:5678c0b6f74e	37	```
mbed_official	0:4611f6cf2413	38
mbed_official	0:4611f6cf2413	39	### Selecting socket type (TCP or UDP)
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	26:348eec457e58	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/latest/reference/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	0:4611f6cf2413	86
mbed_official	0:4611f6cf2413	87	## Compiling the application
mbed_official	0:4611f6cf2413	88
mbed_official	28:232da3ce8a88	89	The master branch is for daily development and it uses the latest mbed-os/master.
mbed_official	28:232da3ce8a88	90
mbed_official	28:232da3ce8a88	91	To use the latest stable version update to a Mbed OS release tag, for example:
mbed_official	28:232da3ce8a88	92
mbed_official	28:232da3ce8a88	93	```
mbed_official	28:232da3ce8a88	94	mbed releases
mbed_official	28:232da3ce8a88	95	* mbed-os-5.10.4
mbed_official	28:232da3ce8a88	96	...
mbed_official	28:232da3ce8a88	97	mbed update mbed-os-5.10.4
mbed_official	28:232da3ce8a88	98	```
mbed_official	28:232da3ce8a88	99
mbed_official	28:232da3ce8a88	100	You may need to use `--clean` option to discard your local changes (use with caution).
mbed_official	28:232da3ce8a88	101
mbed_official	0:4611f6cf2413	102	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	103
mbed_official	0:4611f6cf2413	104	```sh
mbed_official	0:4611f6cf2413	105	$ mbed compile -m YOUR_TARGET_WITH_MODEM -t GCC_ARM
mbed_official	0:4611f6cf2413	106	```
mbed_official	0:4611f6cf2413	107
mbed_official	0:4611f6cf2413	108	## Running the application
mbed_official	0:4611f6cf2413	109
mbed_official	0:4611f6cf2413	110	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	111
mbed_official	0:4611f6cf2413	112	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	113
mbed_official	0:4611f6cf2413	114	You should see an output similar to this:
mbed_official	0:4611f6cf2413	115
mbed_official	0:4611f6cf2413	116	```
mbed_official	2:0f644d6045cf	117	mbed-os-example-cellular
mbed_official	6:5678c0b6f74e	118	Establishing connection ......
mbed_official	2:0f644d6045cf	119
mbed_official	0:4611f6cf2413	120	Connection Established.
mbed_official	2:0f644d6045cf	121	TCP: connected with echo.mbedcloudtesting.com server
mbed_official	2:0f644d6045cf	122	TCP: Sent 4 Bytes to echo.mbedcloudtesting.com
mbed_official	0:4611f6cf2413	123	Received from echo server 4 Bytes
mbed_official	2:0f644d6045cf	124
mbed_official	2:0f644d6045cf	125
mbed_official	0:4611f6cf2413	126	Success. Exiting
mbed_official	0:4611f6cf2413	127	```
mbed_official	0:4611f6cf2413	128
mbed_official	0:4611f6cf2413	129	## Troubleshooting
mbed_official	0:4611f6cf2413	130
mbed_official	11:23ea0907186e	131	* 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	132	* Enable trace flag to have access to debug information `"mbed-trace.enable": true`.
mbed_official	11:23ea0907186e	133	* Try both `TCP` and `UDP` socket types.
mbed_official	11:23ea0907186e	134	* Try both `"lwip.ppp-enabled": true` and `"lwip.ppp-enabled": false`.
mbed_official	11:23ea0907186e	135	* The modem may support only a fixed baud-rate, such as `"platform.default-serial-baud-rate": 9600`.
mbed_official	11:23ea0907186e	136	* The modem and network may only support IPv6 in which case `"lwip.ipv6-enabled": true` shall be defined.
mbed_official	11:23ea0907186e	137	* The SIM and modem must have compatible cellular technology (3G, 4G, NB-IoT, ...) supported and cellular network available.
mbed_official	11:23ea0907186e	138
mbed_official	11:23ea0907186e	139	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.

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed OS
Created:	25 Apr 2019
Imports:	77
Forks:	0
Commits:	45
Dependents:	0
Dependencies:	0
Followers:	4

The code in this repository is Apache licensed.