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

Or

/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

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/.

Files at this revision

API Documentation at this revision

Comitter:
mbed_official
Date:
Mon Jun 18 09:00:19 2018 +0100
Parent:
10:fdcc1da8a6d4
Child:
12:393c693226f4
Commit message:
Merge pull request #85 from AriParkkila/merge-mbed-os-5.9.0

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

Changed in this revision

README.md Show annotated file Show diff for this revision Revisions of this file
main.cpp Show annotated file Show diff for this revision Revisions of this file
mbed-os.lib Show annotated file Show diff for this revision Revisions of this file
mbed_app.json Show annotated file Show diff for this revision Revisions of this file
--- a/README.md	Wed Jun 06 07:45:26 2018 +0100
+++ b/README.md	Mon Jun 18 09:00:19 2018 +0100
@@ -61,13 +61,10 @@
 
 ### 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. Set the `modem_trace` field value to be true.
+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.
 
 ```json
-        "modem_trace": {
-            "help": "Turns AT command trace on/off from the cellular modem, defaults to off",
-            "value": true
-        },
+        "cellular.debug-at": true
 ```
 
 ### Turning on the tracing and trace level
@@ -76,8 +73,8 @@
 
 ```"target_overrides": {
         "*": {
-            "target.features_add": ["LWIP", "COMMON_PAL"],
-            "mbed-trace.enable": false,
+            "target.features_add": ["LWIP"],
+            "mbed-trace.enable": true,
 ```
 
 After you have defined `mbed-trace.enable: true`, you can set trace levels by changing value in `trace-level`
@@ -126,4 +123,12 @@
 
 ## Troubleshooting
 
-If you have problems, 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.
+* 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.
+
+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.
--- a/main.cpp	Wed Jun 06 07:45:26 2018 +0100
+++ b/main.cpp	Mon Jun 18 09:00:19 2018 +0100
@@ -17,7 +17,6 @@
 #include "mbed.h"
 #include "common_functions.h"
 #include "UDPSocket.h"
-#include "OnboardCellularInterface.h"
 #include "CellularLog.h"
 
 #define UDP 0
@@ -41,16 +40,13 @@
 // Number of retries /
 #define RETRY_COUNT 3
 
-
-
-// CellularInterface object
-OnboardCellularInterface iface;
+CellularBase *iface;
 
 // Echo server hostname
-const char *host_name = "echo.mbedcloudtesting.com";
+const char *host_name = MBED_CONF_APP_ECHO_SERVER_HOSTNAME;
 
 // Echo server port (same for TCP and UDP)
-const int port = 7;
+const int port = MBED_CONF_APP_ECHO_SERVER_PORT;
 
 static rtos::Mutex trace_mutex;
 
@@ -80,10 +76,16 @@
 
     mbed_trace_mutex_wait_function_set(trace_wait);
     mbed_trace_mutex_release_function_set(trace_release);
+
+    mbed_cellular_trace::mutex_wait_function_set(trace_wait);
+    mbed_cellular_trace::mutex_release_function_set(trace_release);
 }
 
 static void trace_close()
 {
+    mbed_cellular_trace::mutex_wait_function_set(NULL);
+    mbed_cellular_trace::mutex_release_function_set(NULL);
+
     mbed_trace_free();
 }
 #endif // #if MBED_CONF_MBED_TRACE_ENABLE
@@ -104,7 +106,7 @@
 {
     while (true) {
         Thread::wait(4000);
-        if (!iface.is_connected()) {
+        if (!iface->is_connected()) {
             trace_mutex.lock();
             printf(".");
             fflush(stdout);
@@ -123,8 +125,8 @@
     nsapi_error_t retcode = NSAPI_ERROR_OK;
     uint8_t retry_counter = 0;
 
-    while (!iface.is_connected()) {
-        retcode = iface.connect();
+    while (!iface->is_connected()) {
+        retcode = iface->connect();
         if (retcode == NSAPI_ERROR_AUTH_FAILURE) {
             print_function("\n\nAuthentication Failure. Exiting application\n");
         } else if (retcode == NSAPI_ERROR_OK) {
@@ -154,14 +156,14 @@
     UDPSocket sock;
 #endif
 
-    retcode = sock.open(&iface);
+    retcode = sock.open(iface);
     if (retcode != NSAPI_ERROR_OK) {
         print_function("UDPSocket.open() fails, code: %d\n", retcode);
         return -1;
     }
 
     SocketAddress sock_addr;
-    retcode = iface.gethostbyname(host_name, &sock_addr);
+    retcode = iface->gethostbyname(host_name, &sock_addr);
     if (retcode != NSAPI_ERROR_OK) {
         print_function("Couldn't resolve remote host: %s, code: %d\n", host_name, retcode);
         return -1;
@@ -222,14 +224,14 @@
 #else
     dot_thread.start(dot_event);
 #endif // #if MBED_CONF_MBED_TRACE_ENABLE
+    iface = CellularBase::get_default_instance();
+    MBED_ASSERT(iface);
+
     /* Set Pin code for SIM card */
-    iface.set_sim_pin(MBED_CONF_APP_SIM_PIN_CODE);
+    iface->set_sim_pin(MBED_CONF_APP_SIM_PIN_CODE);
 
     /* Set network credentials here, e.g., APN */
-    iface.set_credentials(MBED_CONF_APP_APN, MBED_CONF_APP_USERNAME, MBED_CONF_APP_PASSWORD);
-
-    /* Set the modem debug on/off */
-    iface.modem_debug_on(MBED_CONF_APP_MODEM_TRACE);
+    iface->set_credentials(MBED_CONF_APP_APN, MBED_CONF_APP_USERNAME, MBED_CONF_APP_PASSWORD);
 
     nsapi_error_t retcode = NSAPI_ERROR_NO_CONNECTION;
 
--- a/mbed-os.lib	Wed Jun 06 07:45:26 2018 +0100
+++ b/mbed-os.lib	Mon Jun 18 09:00:19 2018 +0100
@@ -1,1 +1,1 @@
-https://github.com/ARMmbed/mbed-os/#35fa909641fedcad9bbe0c7300d4ccdf15a2b71a
+https://github.com/ARMmbed/mbed-os/#866850acc15e86cd4ac11bf4404078a49f921ddd
--- a/mbed_app.json	Wed Jun 06 07:45:26 2018 +0100
+++ b/mbed_app.json	Mon Jun 18 09:00:19 2018 +0100
@@ -1,10 +1,6 @@
 {
     "config": {
         "sock-type": "TCP",
-        "modem_trace": {
-            "help": "Turns AT command trace on/off from the cellular modem, defaults to off",
-            "value": false
-        },
         "sim-pin-code": {
             "help": "SIM PIN code",
             "value": "\"1234\""
@@ -21,6 +17,14 @@
             "help": "The password string to use for this APN, set to 0 if none",
             "value": 0
         },
+        "echo-server-hostname": {
+            "help": "Echo server host name.",
+            "value": "\"echo.mbedcloudtesting.com\""
+        },
+        "echo-server-port": {
+            "help": "Echo server port number.",
+            "value": 7
+        },
         "trace-level": {
             "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
             "macro_name": "MBED_TRACE_MAX_LEVEL",
@@ -29,7 +33,7 @@
   },
     "target_overrides": {
         "*": {
-            "target.features_add": ["LWIP", "COMMON_PAL"],
+            "target.features_add": ["LWIP"],
             "mbed-trace.enable": false,
             "lwip.ipv4-enabled": true,
             "lwip.ethernet-enabled": false,
@@ -38,7 +42,8 @@
             "platform.stdio-convert-newlines": true,
             "platform.stdio-baud-rate": 115200,
             "platform.default-serial-baud-rate": 115200,
-            "platform.stdio-buffered-serial": true
+            "platform.stdio-buffered-serial": true,
+            "cellular.debug-at": false
         }
     }
 }