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

Revision:
0:4611f6cf2413
Child:
2:0f644d6045cf
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/main.cpp	Thu Mar 08 17:31:37 2018 +0000
@@ -0,0 +1,223 @@
+/*
+ * Copyright (c) 2017 ARM Limited. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ * Licensed under the Apache License, Version 2.0 (the License); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "mbed.h"
+#include "common_functions.h"
+#include "UDPSocket.h"
+#include "OnboardCellularInterface.h"
+
+#define UDP 0
+#define TCP 1
+
+// SIM pin code goes here
+#ifndef MBED_CONF_APP_SIM_PIN_CODE
+# define MBED_CONF_APP_SIM_PIN_CODE    "1234"
+#endif
+
+#ifndef MBED_CONF_APP_APN
+# define MBED_CONF_APP_APN         "internet"
+#endif
+#ifndef MBED_CONF_APP_USERNAME
+# define MBED_CONF_APP_USERNAME    NULL
+#endif
+#ifndef MBED_CONF_APP_PASSWORD
+# define MBED_CONF_APP_PASSWORD    NULL
+#endif
+
+// Number of retries /
+#define RETRY_COUNT 3
+
+
+
+// CellularInterface object
+OnboardCellularInterface iface;
+
+// Echo server hostname
+const char *host_name = "echo.u-blox.com";
+
+// Echo server port (same for TCP and UDP)
+const int port = 7;
+
+Mutex PrintMutex;
+Thread dot_thread;
+
+#define PRINT_TEXT_LENGTH 128
+char print_text[PRINT_TEXT_LENGTH];
+void print_function(const char *input_string)
+{
+    PrintMutex.lock();
+    printf("%s", input_string);
+    fflush(NULL);
+    PrintMutex.unlock();
+}
+
+void dot_event()
+{
+
+    while (true) {
+        wait(4);
+        if (!iface.is_connected()) {
+            print_function(".");
+        } else {
+            break;
+        }
+    }
+
+}
+
+
+/**
+ * Connects to the Cellular Network
+ */
+nsapi_error_t do_connect()
+{
+    nsapi_error_t retcode;
+    uint8_t retry_counter = 0;
+
+    while (!iface.is_connected()) {
+
+        retcode = iface.connect();
+        if (retcode == NSAPI_ERROR_AUTH_FAILURE) {
+            print_function("\n\nAuthentication Failure. Exiting application\n");
+            return retcode;
+        } else if (retcode != NSAPI_ERROR_OK) {
+            snprintf(print_text, PRINT_TEXT_LENGTH, "\n\nCouldn't connect: %d, will retry\n", retcode);
+            print_function(print_text);
+            retry_counter++;
+            continue;
+        } else if (retcode != NSAPI_ERROR_OK && retry_counter > RETRY_COUNT) {
+            snprintf(print_text, PRINT_TEXT_LENGTH, "\n\nFatal connection failure: %d\n", retcode);
+            print_function(print_text);
+            return retcode;
+        }
+
+        break;
+    }
+
+    print_function("\n\nConnection Established.\n");
+
+    return NSAPI_ERROR_OK;
+}
+
+/**
+ * Opens a UDP or a TCP socket with the given echo server and performs an echo
+ * transaction retrieving current.
+ */
+nsapi_error_t test_send_recv()
+{
+    nsapi_size_or_error_t retcode;
+#if MBED_CONF_APP_SOCK_TYPE == TCP
+    TCPSocket sock;
+#else
+    UDPSocket sock;
+#endif
+
+    retcode = sock.open(&iface);
+    if (retcode != NSAPI_ERROR_OK) {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "UDPSocket.open() fails, code: %d\n", retcode);
+        print_function(print_text);
+        return -1;
+    }
+
+    SocketAddress sock_addr;
+    retcode = iface.gethostbyname(host_name, &sock_addr);
+    if (retcode != NSAPI_ERROR_OK) {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "Couldn't resolve remote host: %s, code: %d\n", host_name,
+               retcode);
+        print_function(print_text);
+        return -1;
+    }
+
+    sock_addr.set_port(port);
+
+    sock.set_timeout(15000);
+    int n = 0;
+    const char *echo_string = "TEST";
+    char recv_buf[4];
+#if MBED_CONF_APP_SOCK_TYPE == TCP
+    retcode = sock.connect(sock_addr);
+    if (retcode < 0) {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "TCPSocket.connect() fails, code: %d\n", retcode);
+        print_function(print_text);
+        return -1;
+    } else {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "TCP: connected with %s server\n", host_name);
+        print_function(print_text);
+    }
+    retcode = sock.send((void*) echo_string, sizeof(echo_string));
+    if (retcode < 0) {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "TCPSocket.send() fails, code: %d\n", retcode);
+        print_function(print_text);
+        return -1;
+    } else {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "TCP: Sent %d Bytes to %s\n", retcode, host_name);
+        print_function(print_text);
+    }
+
+    n = sock.recv((void*) recv_buf, sizeof(recv_buf));
+#else
+
+    retcode = sock.sendto(sock_addr, (void*) echo_string, sizeof(echo_string));
+    if (retcode < 0) {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "UDPSocket.sendto() fails, code: %d\n", retcode);
+        print_function(print_text);
+        return -1;
+    } else {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "UDP: Sent %d Bytes to %s\n", retcode, host_name);
+        print_function(print_text);
+    }
+
+    n = sock.recvfrom(&sock_addr, (void*) recv_buf, sizeof(recv_buf));
+#endif
+
+    sock.close();
+
+    if (n > 0) {
+        snprintf(print_text, PRINT_TEXT_LENGTH, "Received from echo server %d Bytes\n", n);
+        print_function(print_text);
+        return 0;
+    }
+
+    return -1;
+}
+
+int main()
+{
+
+    iface.modem_debug_on(MBED_CONF_APP_MODEM_TRACE);
+    /* Set Pin code for SIM card */
+    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);
+
+    print_function("\n\nmbed-os-example-cellular\n");
+    print_function("Establishing connection ");
+    dot_thread.start(dot_event);
+
+    /* Attempt to connect to a cellular network */
+    if (do_connect() == NSAPI_ERROR_OK) {
+        nsapi_error_t retcode = test_send_recv();
+        if (retcode == NSAPI_ERROR_OK) {
+            print_function("\n\nSuccess. Exiting \n\n");
+            return 0;
+        }
+    }
+
+    print_function("\n\nFailure. Exiting \n\n");
+    return -1;
+}
+// EOF