Merge pull request #47 from ARMmbed/mbed-os-5.7.0-oob

Merge Mbed OS 5.7.0 oob

Author: Antti Kauppila

README.md

@@ -1,16 +1,16 @@
-# Example cellular application for mbed OS
+# Example cellular application for Mbed OS
 
 This is an example based on `mbed-os` cellular APIs that demonstrates a TCP or UDP echo transaction with a public echo server.
 
 ## Getting started
 
-This particular cellular application uses a cellular network and network-socket APIs that are part of [`mbed-os`](github.com/armmbed/mbed-os).
+This particular cellular application uses a cellular network and network-socket APIs that are part of [`mbed-os`](https://github.com/ARMmbed/mbed-os).
 
 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.
 
 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.
 
-For more information on ARM mbed OS cellular APIs and porting guide, please visit the [mbed OS cellular documentation](https://docs.mbed.com/docs/mbed-os-api-reference/en/latest/APIs/communication/cellular/).
+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).
 
 ### Download the application
 
@@ -49,7 +49,9 @@ See the file `mbed_app.json` in the root directory of your application. This fil
 
 ### Selecting socket type (TCP or UDP)
 
-You can choose which socket type the application should use. For example:
+
+You can choose which socket type the application should use; however, please note that TCP is a more reliable tranmission protocol. For example:
+
 
 ```json
 
@@ -70,23 +72,23 @@ If you like details and wish to know about all the AT interactions between the m
 
 ### Board support
 
-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://docs.mbed.com/docs/mbed-os-api-reference/en/latest/APIs/communication/cellular/).
+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).
 
-Examples of mbed Enabled boards with onboard modem chips include [u-blox C027](https://developer.mbed.org/platforms/u-blox-C027/) and [MultiTech MTS Dragonfly](https://developer.mbed.org/platforms/MTS-Dragonfly/).
+Examples of Mbed Enabled boards with onboard modem chips include [u-blox C027](https://os.mbed.com/platforms/u-blox-C027/) and [MultiTech MTS Dragonfly](https://os.mbed.com/platforms/MTS-Dragonfly/).
 
 ## Compiling the application
 
-Use mbed CLI commands to generate a binary for the application. For example, in the case of GCC, use the following command:
+Use Mbed CLI commands to generate a binary for the application. For example, in the case of GCC, use the following command:
 
 ```sh
 $ mbed compile -m YOUR_TARGET_WITH_MODEM -t GCC_ARM
 ```
 
 ## Running the application
 
-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.
+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.
 
-Attach a serial console emulator of your choice (for example, PuTTY, Minicom or screen) to your USB device. Set the baudrate to 115200, and reset your board by pressing the reset button.
+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.
 
 You should see an output similar to this:
 
@@ -102,3 +104,7 @@ Received from echo server 4 Bytes
 Success. Exiting
 
 ```
+
+## 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.

main.cpp

@@ -40,6 +40,8 @@
 // Number of retries /
 #define RETRY_COUNT 3
 
+
+
 // CellularInterface object
 OnboardCellularInterface iface;
 
@@ -49,6 +51,34 @@ 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
  */
@@ -61,21 +91,23 @@ nsapi_error_t do_connect()
 
         retcode = iface.connect();
         if (retcode == NSAPI_ERROR_AUTH_FAILURE) {
-            printf("\n\nAuthentication Failure. Exiting application\n");
+            print_function("\n\nAuthentication Failure. Exiting application\n");
             return retcode;
         } else if (retcode != NSAPI_ERROR_OK) {
-            printf("\n\nCouldn't connect: %d, will retry\n", retcode);
+            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) {
-            printf("\n\nFatal connection failure: %d\n", retcode);
+            snprintf(print_text, PRINT_TEXT_LENGTH, "\n\nFatal connection failure: %d\n", retcode);
+            print_function(print_text);
             return retcode;
         }
 
         break;
     }
 
-    printf("\n\nConnection Established.\n");
+    print_function("\n\nConnection Established.\n");
 
     return NSAPI_ERROR_OK;
 }
@@ -95,49 +127,57 @@ nsapi_error_t test_send_recv()
 
     retcode = sock.open(&iface);
     if (retcode != NSAPI_ERROR_OK) {
-        printf("UDPSocket.open() fails, code: %d\n", retcode);
+        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) {
-        printf("Couldn't resolve remote host: %s, code: %d\n", host_name,
+        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;
-    char *echo_string = "TEST";
+    const char *echo_string = "TEST";
     char recv_buf[4];
 #if MBED_CONF_APP_SOCK_TYPE == TCP
     retcode = sock.connect(sock_addr);
     if (retcode < 0) {
-        printf("TCPSocket.connect() fails, code: %d\n", retcode);
+        snprintf(print_text, PRINT_TEXT_LENGTH, "TCPSocket.connect() fails, code: %d\n", retcode);
+        print_function(print_text);
         return -1;
     } else {
-        printf("TCP: connected with %s server\n", host_name);
+        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) {
-        printf("TCPSocket.send() fails, code: %d\n", retcode);
+        snprintf(print_text, PRINT_TEXT_LENGTH, "TCPSocket.send() fails, code: %d\n", retcode);
+        print_function(print_text);
         return -1;
     } else {
-        printf("TCP: Sent %d Bytes to %s\n", retcode, host_name);
+        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) {
-        printf("UDPSocket.sendto() fails, code: %d\n", retcode);
+        snprintf(print_text, PRINT_TEXT_LENGTH, "UDPSocket.sendto() fails, code: %d\n", retcode);
+        print_function(print_text);
         return -1;
     } else {
-        printf("UDP: Sent %d Bytes to %s\n", retcode, host_name);
+        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));
@@ -146,36 +186,38 @@ nsapi_error_t test_send_recv()
     sock.close();
 
     if (n > 0) {
-        printf("Received from echo server %d Bytes\n", n);
+        snprintf(print_text, PRINT_TEXT_LENGTH, "Received from echo server %d Bytes\n", n);
+        print_function(print_text);
         return 0;
     }
 
     return -1;
-
-    return retcode;
 }
 
 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);
 
-    printf("\n\nmbed-os-example-cellular, Connecting...\n");
+    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) {
-            printf("\n\nSuccess. Exiting \n\n");
+            print_function("\n\nSuccess. Exiting \n\n");
             return 0;
         }
     }
 
-    printf("\n\nFailure. Exiting \n\n");
+    print_function("\n\nFailure. Exiting \n\n");
     return -1;
 }
 // EOF

mbed-os.lib

@@ -1 +1 @@
-https://github.com/ARMmbed/mbed-os/#5f6572179d66ce4c09d6517b659ac51133cc980d
+https://github.com/ARMmbed/mbed-os/#8b54959f5bca08a8ad44a701bafd634afbb38b03

mbed_app.json

@@ -1,6 +1,6 @@
 {
     "config": {
-        "sock-type": "UDP",
+        "sock-type": "TCP",
         "modem_trace": {
             "help": "Turns AT command trace on/off from the cellular modem, defaults to off",
             "value": false
@@ -34,4 +34,4 @@
             "platform.default-serial-baud-rate": 115200
         }
     }
-}
+}