Added support for the WNC M14A2A Cellular LTE Data Module.

Dependencies:   WNC14A2AInterface

Easy Connect

Easily add all supported connectivity methods to your mbed OS project

This project is derived from https://developer.mbed.org/teams/sandbox/code/simple-mbed-client-example/file/dd6231df71bb/easy-connect.lib. It give user the ability to switch between connectivity methods and includes support for the WNC14A2A Data Module. The `NetworkInterface` API makes this easy, but you still need a mechanism for the user to select the connection method, The selection is made by modifying the `mbed_app.json` file and using `easy_connect()` from your application.

Specifying connectivity method

To add support for the WNC14A2A, add the following to your ``mbed_app.json`` file:

mbed_app.json

{
    "config": {
        "network-interface":{
            "help": "options are ETHERNET,WIFI_ESP8266,WIFI_ODIN,MESH_LOWPAN_ND,MESH_THREAD,WNC14A2A",
            "value": "WNC14A2A"
        }
    },
}

After you choose `WNC14A2A` you'll also need to indicate if you want debug output or not by Enabling (true) or Disabling (false) WNC_DEBUG.

If WNC_DEBUG is enabled, there are 3 different levels of debug output (selected via bit settings). These debug levels are set using the following values:

ValueDescription
1Basic WNC driver debug output
2Comprehensive WNC driver debug output
4Network Layer debug output

You can have any combination of these three bit values for a total value of 0 – 7.

WNC Debug Settings

    "config": {
        "WNC_DEBUG": {
            "value": false
        },
        "WNC_DEBUG_SETTING": {
            "value": 4
        },
    }

Using Easy Connect from your application

Easy Connect has just one function which will either return a `NetworkInterface`-pointer or `NULL`:

Sample Code

#include "easy-connect.h"

int main(int, char**) {
    NetworkInterface* network = easy_connect(true); /* has 1 argument, enable_logging (pass in true to log to serial port) */
    if (!network) {
        printf("Connecting to the network failed... See serial output.\r\n");
        return 1;
    }
 
    // Rest of your program
}

Tested on

  • K64F with Ethernet.
  • AT&T Cellular IoT Starter Kit with WNC M14A2A Cellular Data Module

The WNCInterface class currently supports the following version(s):

  • MPSS: M14A2A_v11.50.164451 APSS: M14A2A_v11.53.164451

License

This library is released under the Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License and 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.

Committer:
group-Avnet
Date:
Wed Apr 19 01:08:11 2017 +0000
Revision:
0:478cfd88041f
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-Avnet 0:478cfd88041f 1 # Easy Connect - Easily add all supported connectivity methods to your mbed OS project
group-Avnet 0:478cfd88041f 2
group-Avnet 0:478cfd88041f 3 Often you want to give users of your application the choice to switch between connectivity methods. The
group-Avnet 0:478cfd88041f 4 `NetworkInterface` API makes this easy, but you'll still need a mechanism for the user to chooce the method,
group-Avnet 0:478cfd88041f 5 throw in some `#define`'s, etc. Easy Connect handles all this for you. Just declare the desired connectivity
group-Avnet 0:478cfd88041f 6 method in your `mbed_app.json` file, and call `easy_connect()` from your application.
group-Avnet 0:478cfd88041f 7
group-Avnet 0:478cfd88041f 8 ## Specifying connectivity method
group-Avnet 0:478cfd88041f 9
group-Avnet 0:478cfd88041f 10 Add the following to your ``mbed_app.json`` file:
group-Avnet 0:478cfd88041f 11
group-Avnet 0:478cfd88041f 12 ```json
group-Avnet 0:478cfd88041f 13 {
group-Avnet 0:478cfd88041f 14 "config": {
group-Avnet 0:478cfd88041f 15 "network-interface":{
group-Avnet 0:478cfd88041f 16 "help": "options are ETHERNET,WIFI_ESP8266,WIFI_ODIN,MESH_LOWPAN_ND,MESH_THREAD,WNC14A2A",
group-Avnet 0:478cfd88041f 17 "value": "ETHERNET"
group-Avnet 0:478cfd88041f 18 }
group-Avnet 0:478cfd88041f 19 },
group-Avnet 0:478cfd88041f 20 "target_overrides": {
group-Avnet 0:478cfd88041f 21 "*": {
group-Avnet 0:478cfd88041f 22 "target.features_add": ["NANOSTACK", "LOWPAN_ROUTER", "COMMON_PAL"],
group-Avnet 0:478cfd88041f 23 "mbed-mesh-api.6lowpan-nd-channel-page": 0,
group-Avnet 0:478cfd88041f 24 "mbed-mesh-api.6lowpan-nd-channel": 12
group-Avnet 0:478cfd88041f 25 }
group-Avnet 0:478cfd88041f 26 }
group-Avnet 0:478cfd88041f 27 }
group-Avnet 0:478cfd88041f 28 ```
group-Avnet 0:478cfd88041f 29 >If you choose `WNC14A2A` you'll also need to indicate if you want WNC14A2A debug output or not. You
group-Avnet 0:478cfd88041f 30 >Have 3 levels of debug (via bit settings). The debug value is set with the with the value of WNC_DEBUG_SETTING.
group-Avnet 0:478cfd88041f 31 >1 - Basic WNC driver debug output
group-Avnet 0:478cfd88041f 32 >2 - Comprehensive WNC driver debug output
group-Avnet 0:478cfd88041f 33 >4 - Network Layer debug output
group-Avnet 0:478cfd88041f 34 >You can have any combination you want 0 - 7.
group-Avnet 0:478cfd88041f 35 >Turning on or off WNC_DEBUG output is set with the WNC_DEBG setting.
group-Avnet 0:478cfd88041f 36 >If you choose `WIFI_ESP8266` or `WIFI_ODIN`, you'll also need to add the WiFi SSID and password:
group-Avnet 0:478cfd88041f 37
group-Avnet 0:478cfd88041f 38 ```json
group-Avnet 0:478cfd88041f 39 "config": {
group-Avnet 0:478cfd88041f 40 "network-interface":{
group-Avnet 0:478cfd88041f 41 "help": "options are ETHERNET,WIFI_ESP8266,WIFI_ODIN,MESH_LOWPAN_ND,MESH_THREAD",
group-Avnet 0:478cfd88041f 42 "value": "WIFI_ESP8266"
group-Avnet 0:478cfd88041f 43 },
group-Avnet 0:478cfd88041f 44 "esp8266-tx": {
group-Avnet 0:478cfd88041f 45 "help": "Pin used as TX (connects to ESP8266 RX)",
group-Avnet 0:478cfd88041f 46 "value": "PTD3"
group-Avnet 0:478cfd88041f 47 },
group-Avnet 0:478cfd88041f 48 "esp8266-rx": {
group-Avnet 0:478cfd88041f 49 "help": "Pin used as RX (connects to ESP8266 TX)",
group-Avnet 0:478cfd88041f 50 "value": "PTD2"
group-Avnet 0:478cfd88041f 51 },
group-Avnet 0:478cfd88041f 52 "esp8266-debug": {
group-Avnet 0:478cfd88041f 53 "value": true
group-Avnet 0:478cfd88041f 54 },
group-Avnet 0:478cfd88041f 55 "wifi-ssid": {
group-Avnet 0:478cfd88041f 56 "value": "\"SSID\""
group-Avnet 0:478cfd88041f 57 },
group-Avnet 0:478cfd88041f 58 "WNC_DEBUG": {
group-Avnet 0:478cfd88041f 59 "value": false
group-Avnet 0:478cfd88041f 60 },
group-Avnet 0:478cfd88041f 61 "WNC_DEBUG_SETTING": {
group-Avnet 0:478cfd88041f 62 "value": 4
group-Avnet 0:478cfd88041f 63 },
group-Avnet 0:478cfd88041f 64 "wifi-password": {
group-Avnet 0:478cfd88041f 65 "value": "\"Password\""
group-Avnet 0:478cfd88041f 66 }
group-Avnet 0:478cfd88041f 67 }
group-Avnet 0:478cfd88041f 68 ```
group-Avnet 0:478cfd88041f 69
group-Avnet 0:478cfd88041f 70 If you use `MESH_LOWPAN_ND` or `MESH_THREAD` you will need to specify your radio module:
group-Avnet 0:478cfd88041f 71
group-Avnet 0:478cfd88041f 72 ```json
group-Avnet 0:478cfd88041f 73 "config": {
group-Avnet 0:478cfd88041f 74 "network-interface":{
group-Avnet 0:478cfd88041f 75 "help": "options are ETHERNET,WIFI_ESP8266,WIFI_ODIN,MESH_LOWPAN_ND,MESH_THREAD",
group-Avnet 0:478cfd88041f 76 "value": "MESH_LOWPAN_ND"
group-Avnet 0:478cfd88041f 77 },
group-Avnet 0:478cfd88041f 78 "mesh_radio_type": {
group-Avnet 0:478cfd88041f 79 "help": "options are ATMEL, MCR20",
group-Avnet 0:478cfd88041f 80 "value": "ATMEL"
group-Avnet 0:478cfd88041f 81 }
group-Avnet 0:478cfd88041f 82 }
group-Avnet 0:478cfd88041f 83 ```
group-Avnet 0:478cfd88041f 84
group-Avnet 0:478cfd88041f 85 ## Using Easy Connect from your application
group-Avnet 0:478cfd88041f 86
group-Avnet 0:478cfd88041f 87 Easy Connect has just one function which will either return a `NetworkInterface`-pointer or `NULL`:
group-Avnet 0:478cfd88041f 88
group-Avnet 0:478cfd88041f 89 ```cpp
group-Avnet 0:478cfd88041f 90 #include "easy-connect.h"
group-Avnet 0:478cfd88041f 91
group-Avnet 0:478cfd88041f 92 int main(int, char**) {
group-Avnet 0:478cfd88041f 93 NetworkInterface* network = easy_connect(true); /* has 1 argument, enable_logging (pass in true to log to serial port) */
group-Avnet 0:478cfd88041f 94 if (!network) {
group-Avnet 0:478cfd88041f 95 printf("Connecting to the network failed... See serial output.\r\n");
group-Avnet 0:478cfd88041f 96 return 1;
group-Avnet 0:478cfd88041f 97 }
group-Avnet 0:478cfd88041f 98
group-Avnet 0:478cfd88041f 99 // Rest of your program
group-Avnet 0:478cfd88041f 100 }
group-Avnet 0:478cfd88041f 101 ```
group-Avnet 0:478cfd88041f 102 ## CR/LF in serial output
group-Avnet 0:478cfd88041f 103
group-Avnet 0:478cfd88041f 104 If you want to avoid using `\r\n` in your printouts and just use normal C-style `\n` instead, please specify these to your `mbed_app.json`
group-Avnet 0:478cfd88041f 105
group-Avnet 0:478cfd88041f 106 ```json
group-Avnet 0:478cfd88041f 107 "target_overrides": {
group-Avnet 0:478cfd88041f 108 "*": {
group-Avnet 0:478cfd88041f 109 "platform.stdio-baud-rate": 115200,
group-Avnet 0:478cfd88041f 110 "platform.stdio-convert-newlines": true
group-Avnet 0:478cfd88041f 111 }
group-Avnet 0:478cfd88041f 112 }
group-Avnet 0:478cfd88041f 113 ```
group-Avnet 0:478cfd88041f 114
group-Avnet 0:478cfd88041f 115 ## Extra defines
group-Avnet 0:478cfd88041f 116
group-Avnet 0:478cfd88041f 117 If you'd like to use Easy Connect with mbed Client then you're in luck. Easy Connect automatically defines the `MBED_SERVER_ADDRESS` macro depending on your connectivity method (either IPv4 or IPv6 address). Use this address to connect to the right instance of mbed Device Connector.