Revision 0:fb5e1789de47, committed 2019-05-10

Comitter:

MACRUM

Date:

Fri May 10 10:18:11 2019 +0900

Child:

1:10dee4eeb55e

Commit message:

Initial commit

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CONTRIBUTING.md	Fri May 10 10:18:11 2019 +0900
@@ -0,0 +1,5 @@
+# Contributing to Mbed OS
+
+Mbed OS is an open-source, device software platform for the Internet of Things. Contributions are an important part of the platform, and our goal is to make it as simple as possible to become a contributor.
+
+To encourage productive collaboration, as well as robust, consistent and maintainable code, we have a set of guidelines for [contributing to Mbed OS](https://os.mbed.com/docs/mbed-os/latest/contributing/index.html).

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Jenkinsfile	Fri May 10 10:18:11 2019 +0900
@@ -0,0 +1,175 @@
+properties ([[$class: 'ParametersDefinitionProperty', parameterDefinitions: [
+  [$class: 'StringParameterDefinition', name: 'mbed_os_revision', defaultValue: '', description: 'Revision of mbed-os to build. To access mbed-os PR use format "pull/PR number/head"'],
+  [$class: 'BooleanParameterDefinition', name: 'smoke_test', defaultValue: true, description: 'Runs HW smoke tests on Cellular devices']
+  ]]])
+
+if (env.MBED_OS_REVISION == null) {
+  echo 'First run in this branch, using default parameter values'
+  env.MBED_OS_REVISION = ''
+}
+if (env.MBED_OS_REVISION == '') {
+  echo 'Using mbed OS revision from mbed-os.lib'
+} else {
+  echo "Using given mbed OS revision: ${env.MBED_OS_REVISION}"
+  if (env.MBED_OS_REVISION.matches('pull/\\d+/head')) {
+    echo "Revision is a Pull Request"
+  }
+}
+
+// Map RaaS instances to corresponding test suites
+def raas = [
+  "cellular_smoke_ublox_c027.json": "ruka"
+  //"cellular_smoke_mtb_mts_dragonfly.json": "8119"
+]
+
+// Supported Modems
+def targets = [
+  "UBLOX_C027",
+  "MTB_MTS_DRAGONFLY",
+  "UBLOX_C030_U201"
+  //"MTB_ADV_WISE_1570",
+  //"K64F"
+]
+
+// Map toolchains to compilers
+def toolchains = [
+  ARM: "armcc",
+  GCC_ARM: "arm-none-eabi-gcc",
+  IAR: "iar_arm",
+  ARMC6: "arm6"
+  ]
+
+def stepsForParallel = [:]
+
+// Jenkins pipeline does not support map.each, we need to use oldschool for loop
+for (int i = 0; i < targets.size(); i++) {
+  for(int j = 0; j < toolchains.size(); j++) {
+    def target = targets.get(i)
+    def toolchain = toolchains.keySet().asList().get(j)
+    def compilerLabel = toolchains.get(toolchain)
+    def stepName = "${target} ${toolchain}"
+
+    stepsForParallel[stepName] = buildStep(target, compilerLabel, toolchain)
+  }
+}
+
+def parallelRunSmoke = [:]
+
+// Need to compare boolean against string value
+if (params.smoke_test == true) {
+  echo "Running smoke tests"
+  // Generate smoke tests based on suite amount
+  for(int i = 0; i < raas.size(); i++) {
+    def suite_to_run = raas.keySet().asList().get(i)
+    def raasName = raas.get(suite_to_run)
+
+    // Parallel execution needs unique step names. Remove .json file ending.
+    def smokeStep = "${raasName} ${suite_to_run.substring(0, suite_to_run.indexOf('.'))}"
+    parallelRunSmoke[smokeStep] = run_smoke(raasName, suite_to_run, toolchains, targets)
+  }
+} else {
+  echo "Skipping smoke tests"
+}
+
+timestamps {
+  parallel stepsForParallel
+  parallel parallelRunSmoke
+}
+
+def buildStep(target, compilerLabel, toolchain) {
+  return {
+    stage ("${target}_${compilerLabel}") {
+      node ("${compilerLabel}") {
+        deleteDir()
+        dir("mbed-os-example-cellular") {
+          checkout scm
+          def config_file = "mbed_app.json"
+
+          // Configurations for different targets
+          if ("${target}" == "UBLOX_C030_U201") {
+            execute("sed -i 's/internet/JTM2M/' ${config_file}")
+          }
+
+          if ("${target}" == "UBLOX_C027") {
+            execute("sed -i 's/TCP/UDP/' ${config_file}")
+          }
+
+          if ("${target}" == "MTB_ADV_WISE_1570") {
+            execute("sed -i 's/TCP/UDP/' ${config_file}")
+            execute("sed -i 's/\"lwip.ppp-enabled\": true,/\"lwip.ppp-enabled\": false,/' ${config_file}")
+            execute("sed -i 's/\"platform.default-serial-baud-rate\": 115200,/\"platform.default-serial-baud-rate\": 9600,/' ${config_file}")
+          }
+
+          if ("${target}" == "K64F") {
+            execute("sed -i 's/TCP/UDP/' ${config_file}")
+            execute("sed -i 's/\"lwip.ppp-enabled\": true,/\"lwip.ppp-enabled\": false,/' ${config_file}")
+            execute("sed -i 's/\"target_overrides\": {/\"macros\": [\"CELLULAR_DEVICE=QUECTEL_BG96\", \"MDMRXD=PTC16\", \"MDMTXD=PTC17\"], \"target_overrides\": {/' ${config_file}")
+          }
+          // Set mbed-os to revision received as parameter
+          execute ("mbed deploy --protocol ssh")
+          if (env.MBED_OS_REVISION != '') {
+            dir("mbed-os") {
+              if (env.MBED_OS_REVISION.matches('pull/\\d+/head')) {
+                // Use mbed-os PR and switch to branch created
+                execute("git fetch origin ${env.MBED_OS_REVISION}:_PR_")
+                execute("git checkout _PR_")
+              } else {
+                execute ("git checkout ${env.MBED_OS_REVISION}")
+              }
+            }
+          }
+
+          execute ("mbed compile --build out/${target}_${toolchain}/ -m ${target} -t ${toolchain} -c --app-config ${config_file}")
+        }
+        if ("${target}" == "MTB_ADV_WISE_1570") {
+          stash name: "${target}_${toolchain}", includes: '**/mbed-os-example-cellular.hex'
+          archive '**/mbed-os-example-cellular.hex'
+        }
+        else {
+          stash name: "${target}_${toolchain}", includes: '**/mbed-os-example-cellular.bin'
+          archive '**/mbed-os-example-cellular.bin'
+        }
+        step([$class: 'WsCleanup'])
+      }
+    }
+  }
+}
+
+def run_smoke(raasName, suite_to_run, toolchains, targets) {
+  return {
+    env.RAAS_USERNAME = "user"
+    env.RAAS_PASSWORD = "user"
+    // Remove .json from suite name
+    def suiteName = suite_to_run.substring(0, suite_to_run.indexOf('.'))
+    stage ("smoke_${raasName}_${suiteName}") {
+      //node is actually the type of machine, i.e., mesh-test boild down to linux
+      node ("linux") {
+        deleteDir()
+        dir("mbed-clitest") {
+          git "git@github.com:ARMmbed/mbed-clitest.git"
+          execute("git checkout ${env.LATEST_CLITEST_STABLE_REL}")
+          dir("mbed-clitest-suites") {
+            git "git@github.com:ARMmbed/mbed-clitest-suites.git"
+            execute("git submodule update --init --recursive")
+            execute("git all checkout master")
+            dir("cellular") {
+              execute("git checkout master")
+            }
+          }
+                
+          for (int i = 0; i < targets.size(); i++) {
+            for(int j = 0; j < toolchains.size(); j++) {
+              def target = targets.get(i)
+              def toolchain = toolchains.keySet().asList().get(j)
+              unstash "${target}_${toolchain}"
+            }
+          }     
+          execute("python clitest.py --suitedir mbed-clitest-suites/suites/ --suite ${suite_to_run} --type hardware --reset \
+                  --raas https://${raasName}.mbedcloudtesting.com:443 --tcdir mbed-clitest-suites/cellular --raas_queue --raas_queue_timeout 3600 \
+                  --raas_share_allocs --failure_return_value -vvv -w --log log_${raasName}_${suiteName}")
+          archive "log_${raasName}_${suiteName}/**/*"
+        }
+      }
+    }
+  }
+}
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE	Fri May 10 10:18:11 2019 +0900
@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.
+

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Fri May 10 10:18:11 2019 +0900
@@ -0,0 +1,149 @@
+# 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.
+
+(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).)
+
+## Getting started
+
+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 [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.
+
+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 API](https://os.mbed.com/docs/latest/reference/cellular.html) and [contributing documentation](https://os.mbed.com/docs/mbed-os/latest/contributing/index.html).
+
+### Download the application
+
+```sh
+$ mbed import mbed-os-example-cellular
+$ cd mbed-os-example-cellular
+
+#OR
+
+$ git clone git@github.com:ARMmbed/mbed-os-example-cellular.git
+$ cd mbed-os-example-cellular
+```
+
+### Change the network and SIM credentials
+
+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:
+
+```json
+        "nsapi.default-cellular-plmn": 0,
+        "nsapi.default-cellular-sim-pin": "\"1234\"",
+        "nsapi.default-cellular-apn": 0,
+        "nsapi.default-cellular-username": 0,
+        "nsapi.default-cellular-password": 0
+```
+
+### Selecting socket type (TCP, UDP or NONIP)
+
+
+You can choose which socket type the application should use; however, please note that TCP is a more reliable transmission protocol. For example:
+
+
+```json
+
+     "sock-type": "TCP",
+
+```
+
+### 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.
+
+```json
+        "cellular.debug-at": true
+```
+
+### Turning on the tracing and trace level
+
+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
+
+```"target_overrides": {
+        "*": {
+            "mbed-trace.enable": true,
+```
+
+After you have defined `mbed-trace.enable: true`, you can set trace levels by changing value in `trace-level`
+
+ ```"trace-level": {
+            "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
+            "macro_name": "MBED_TRACE_MAX_LEVEL",
+            "value": "TRACE_LEVEL_INFO"
+        }
+```
+
+### Board support
+
+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).
+
+Currently supported boards with onboard modem chips are:
+
+[u-blox C027](https://os.mbed.com/platforms/u-blox-C027/)
+[MultiTech MTS Dragonfly](https://os.mbed.com/platforms/MTS-Dragonfly/)
+
+
+## Compiling the application
+
+The master branch is for daily development and it uses the latest mbed-os/master release.
+
+To use older versions update Mbed OS release tag, for example:
+
+```
+mbed releases
+ * mbed-os-5.10.4
+   ...
+mbed update mbed-os-5.10.4
+```
+
+You may need to use `--clean` option to discard your local changes (use with caution).
+
+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.
+
+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:
+
+```
+mbed-os-example-cellular
+Establishing connection ......
+
+Connection Established.
+TCP: connected with echo.mbedcloudtesting.com server
+TCP: Sent 4 Bytes to echo.mbedcloudtesting.com
+Received from echo server 4 Bytes
+
+
+Success. Exiting
+```
+
+## Troubleshooting
+
+* 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.
+* Enable CIoT optimization for NONIP socket `control-plane-opt: true`.
+
+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.
+
+### License and contributions
+
+The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see [contributing.md](CONTRIBUTING.md) for more info.
+
+This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.
+

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/main.cpp	Fri May 10 10:18:11 2019 +0900
@@ -0,0 +1,289 @@
+/*
+ * 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 "CellularNonIPSocket.h"
+#include "CellularDevice.h"
+#include "UDPSocket.h"
+#include "CellularLog.h"
+
+#define UDP 0
+#define TCP 1
+#define NONIP 2
+
+// Number of retries /
+#define RETRY_COUNT 3
+
+NetworkInterface *iface;
+
+// Echo server hostname
+const char *host_name = MBED_CONF_APP_ECHO_SERVER_HOSTNAME;
+
+// Echo server port (same for TCP and UDP)
+const int port = MBED_CONF_APP_ECHO_SERVER_PORT;
+
+static rtos::Mutex trace_mutex;
+
+#if MBED_CONF_MBED_TRACE_ENABLE
+static void trace_wait()
+{
+    trace_mutex.lock();
+}
+
+static void trace_release()
+{
+    trace_mutex.unlock();
+}
+
+static char time_st[50];
+
+static char* trace_time(size_t ss)
+{
+    snprintf(time_st, 49, "[%08llums]", Kernel::get_ms_count());
+    return time_st;
+}
+
+static void trace_open()
+{
+    mbed_trace_init();
+    mbed_trace_prefix_function_set( &trace_time );
+
+    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
+
+Thread dot_thread(osPriorityNormal, 512);
+
+void print_function(const char *format, ...)
+{
+    trace_mutex.lock();
+    va_list arglist;
+    va_start( arglist, format );
+    vprintf(format, arglist);
+    va_end( arglist );
+    trace_mutex.unlock();
+}
+
+void dot_event()
+{
+    while (true) {
+        ThisThread::sleep_for(4000);
+        if (iface && iface->get_connection_status() == NSAPI_STATUS_GLOBAL_UP) {
+            break;
+        } else {
+            trace_mutex.lock();
+            printf(".");
+            fflush(stdout);
+            trace_mutex.unlock();
+        }
+    }
+}
+
+/**
+ * Connects to the Cellular Network
+ */
+nsapi_error_t do_connect()
+{
+    nsapi_error_t retcode = NSAPI_ERROR_OK;
+    uint8_t retry_counter = 0;
+
+    while (iface->get_connection_status() != NSAPI_STATUS_GLOBAL_UP) {
+        retcode = iface->connect();
+        if (retcode == NSAPI_ERROR_AUTH_FAILURE) {
+            print_function("\n\nAuthentication Failure. Exiting application\n");
+        } else if (retcode == NSAPI_ERROR_OK) {
+            print_function("\n\nConnection Established.\n");
+        } else if (retry_counter > RETRY_COUNT) {
+            print_function("\n\nFatal connection failure: %d\n", retcode);
+        } else {
+            print_function("\n\nCouldn't connect: %d, will retry\n", retcode);
+            retry_counter++;
+            continue;
+        }
+        break;
+    }
+    return retcode;
+}
+
+/**
+ * Opens:
+ * - UDP or TCP socket with the given echo server and performs an echo
+ *   transaction retrieving current.
+ * - Cellular Non-IP socket for which the data delivery path is decided
+ *   by network's control plane CIoT optimisation setup, for the given APN.
+ */
+nsapi_error_t test_send_recv()
+{
+    nsapi_size_or_error_t retcode;
+#if MBED_CONF_APP_SOCK_TYPE == TCP
+    TCPSocket sock;
+#elif MBED_CONF_APP_SOCK_TYPE == UDP
+    UDPSocket sock;
+#elif MBED_CONF_APP_SOCK_TYPE == NONIP
+    CellularNonIPSocket sock;
+#endif
+
+#if MBED_CONF_APP_SOCK_TYPE == NONIP
+    retcode = sock.open((CellularContext*)iface);
+#else
+    retcode = sock.open(iface);
+#endif
+
+    if (retcode != NSAPI_ERROR_OK) {
+#if MBED_CONF_APP_SOCK_TYPE == TCP
+        print_function("TCPSocket.open() fails, code: %d\n", retcode);
+#elif MBED_CONF_APP_SOCK_TYPE == UDP
+        print_function("UDPSocket.open() fails, code: %d\n", retcode);
+#elif MBED_CONF_APP_SOCK_TYPE == NONIP
+        print_function("CellularNonIPSocket.open() fails, code: %d\n", retcode);
+#endif
+        return -1;
+    }
+
+    int n = 0;
+    const char *echo_string = "TEST";
+    char recv_buf[4];
+
+    sock.set_timeout(15000);
+
+#if MBED_CONF_APP_SOCK_TYPE == NONIP
+    retcode = sock.send((void*) echo_string, sizeof(echo_string));
+    if (retcode < 0) {
+        print_function("CellularNonIPSocket.send() fails, code: %d\n", retcode);
+        return -1;
+    } else {
+        print_function("CellularNonIPSocket: Sent %d Bytes\n", retcode);
+    }
+
+    n = sock.recv((void*) recv_buf, sizeof(recv_buf));
+
+#else
+
+    SocketAddress 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;
+    }
+
+    sock_addr.set_port(port);
+
+#if MBED_CONF_APP_SOCK_TYPE == TCP
+    retcode = sock.connect(sock_addr);
+    if (retcode < 0) {
+        print_function("TCPSocket.connect() fails, code: %d\n", retcode);
+        return -1;
+    } else {
+        print_function("TCP: connected with %s server\n", host_name);
+    }
+    retcode = sock.send((void*) echo_string, sizeof(echo_string));
+    if (retcode < 0) {
+        print_function("TCPSocket.send() fails, code: %d\n", retcode);
+        return -1;
+    } else {
+        print_function("TCP: Sent %d Bytes to %s\n", retcode, host_name);
+    }
+
+    n = sock.recv((void*) recv_buf, sizeof(recv_buf));
+#else
+
+    retcode = sock.sendto(sock_addr, (void*) echo_string, sizeof(echo_string));
+    if (retcode < 0) {
+        print_function("UDPSocket.sendto() fails, code: %d\n", retcode);
+        return -1;
+    } else {
+        print_function("UDP: Sent %d Bytes to %s\n", retcode, host_name);
+    }
+
+    n = sock.recvfrom(&sock_addr, (void*) recv_buf, sizeof(recv_buf));
+#endif
+#endif
+
+    sock.close();
+
+    if (n > 0) {
+        print_function("Received from echo server %d Bytes\n", n);
+        return 0;
+    }
+
+    return -1;
+}
+
+int main()
+{
+    print_function("\n\nmbed-os-example-cellular\n");
+    print_function("\n\nBuilt: %s, %s\n", __DATE__, __TIME__);
+#ifdef MBED_CONF_NSAPI_DEFAULT_CELLULAR_PLMN
+    print_function("\n\n[MAIN], plmn: %s\n", (MBED_CONF_NSAPI_DEFAULT_CELLULAR_PLMN ? MBED_CONF_NSAPI_DEFAULT_CELLULAR_PLMN : "NULL"));
+#endif
+
+    print_function("Establishing connection\n");
+#if MBED_CONF_MBED_TRACE_ENABLE
+    trace_open();
+#else
+    dot_thread.start(dot_event);
+#endif // #if MBED_CONF_MBED_TRACE_ENABLE
+
+#if MBED_CONF_APP_SOCK_TYPE == NONIP
+    iface = CellularContext::get_default_nonip_instance();
+#else
+    iface = CellularContext::get_default_instance();
+#endif
+
+    MBED_ASSERT(iface);
+
+    // sim pin, apn, credentials and possible plmn are taken automatically from json when using NetworkInterface::set_default_parameters()
+    iface->set_default_parameters();
+
+    nsapi_error_t retcode = NSAPI_ERROR_NO_CONNECTION;
+
+    /* Attempt to connect to a cellular network */
+    if (do_connect() == NSAPI_ERROR_OK) {
+        retcode = test_send_recv();
+    }
+
+    if (iface->disconnect() != NSAPI_ERROR_OK) {
+        print_function("\n\n disconnect failed.\n\n");
+    }
+
+    if (retcode == NSAPI_ERROR_OK) {
+        print_function("\n\nSuccess. Exiting \n\n");
+    } else {
+        print_function("\n\nFailure. Exiting \n\n");
+    }
+
+#if MBED_CONF_MBED_TRACE_ENABLE
+    trace_close();
+#else
+    dot_thread.terminate();
+#endif // #if MBED_CONF_MBED_TRACE_ENABLE
+
+    return 0;
+}
+// EOF

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-os.lib	Fri May 10 10:18:11 2019 +0900
@@ -0,0 +1,1 @@
+https://github.com/ARMmbed/mbed-os/#cfa7938a4dd6d1a4c501945b9c26ca68f70e284e

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed_app.json	Fri May 10 10:18:11 2019 +0900
@@ -0,0 +1,49 @@
+{
+    "config": {
+        "sock-type": "TCP",
+        "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",
+            "value": "TRACE_LEVEL_INFO"
+        }
+  },
+    "target_overrides": {
+        "*": {
+            "target.network-default-interface-type": "CELLULAR",
+            "mbed-trace.enable": false,
+            "lwip.ipv4-enabled": true,
+            "lwip.ethernet-enabled": false,
+            "lwip.ppp-enabled": true,
+            "lwip.tcp-enabled": true,
+            "platform.stdio-convert-newlines": true,
+            "platform.stdio-baud-rate": 115200,
+            "platform.default-serial-baud-rate": 115200,
+            "platform.stdio-buffered-serial": true,
+            "cellular.debug-at": false,
+            "nsapi.default-cellular-plmn": 0,
+            "nsapi.default-cellular-sim-pin": "\"1234\"",
+            "nsapi.default-cellular-apn": 0,
+            "nsapi.default-cellular-username": 0,
+            "nsapi.default-cellular-password": 0
+        },
+        "WIO_3G": {
+            "target.device_has_remove": ["SERIAL_FC"],
+            "nsapi.default-cellular-apn": "\"apn\"",
+            "nsapi.default-cellular-username": "\"username\"",
+            "nsapi.default-cellular-password": "\"password\""
+        },
+        "WIO_BG96": {
+            "nsapi.default-cellular-apn": "\"apn\"",
+            "nsapi.default-cellular-username": "\"username\"",
+            "nsapi.default-cellular-password": "\"password\""
+        }
+    }
+}