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 /*
group-Avnet 0:478cfd88041f 2 * Copyright (c) 2014-2015 ARM Limited. All rights reserved.
group-Avnet 0:478cfd88041f 3 * SPDX-License-Identifier: Apache-2.0
group-Avnet 0:478cfd88041f 4 * Licensed under the Apache License, Version 2.0 (the License); you may
group-Avnet 0:478cfd88041f 5 * not use this file except in compliance with the License.
group-Avnet 0:478cfd88041f 6 * You may obtain a copy of the License at
group-Avnet 0:478cfd88041f 7 *
group-Avnet 0:478cfd88041f 8 * http://www.apache.org/licenses/LICENSE-2.0
group-Avnet 0:478cfd88041f 9 *
group-Avnet 0:478cfd88041f 10 * Unless required by applicable law or agreed to in writing, software
group-Avnet 0:478cfd88041f 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
group-Avnet 0:478cfd88041f 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-Avnet 0:478cfd88041f 13 * See the License for the specific language governing permissions and
group-Avnet 0:478cfd88041f 14 * limitations under the License.
group-Avnet 0:478cfd88041f 15 */
group-Avnet 0:478cfd88041f 16
group-Avnet 0:478cfd88041f 17 #include <stdarg.h>
group-Avnet 0:478cfd88041f 18 #include <stdint.h>
group-Avnet 0:478cfd88041f 19 #include <stdio.h>
group-Avnet 0:478cfd88041f 20 #include <string.h>
group-Avnet 0:478cfd88041f 21
group-Avnet 0:478cfd88041f 22 #include "mbed_error.h"
group-Avnet 0:478cfd88041f 23
group-Avnet 0:478cfd88041f 24 size_t BufferedSerialThunk(void *buf_serial, const void *s, size_t length);
group-Avnet 0:478cfd88041f 25
group-Avnet 0:478cfd88041f 26 int BufferedPrintfC(void *stream, int size, const char* format, va_list arg)
group-Avnet 0:478cfd88041f 27 {
group-Avnet 0:478cfd88041f 28 int r;
group-Avnet 0:478cfd88041f 29 char buffer[512];
group-Avnet 0:478cfd88041f 30 if (size >= 512) {
group-Avnet 0:478cfd88041f 31 return -1;
group-Avnet 0:478cfd88041f 32 }
group-Avnet 0:478cfd88041f 33 memset(buffer, 0, size);
group-Avnet 0:478cfd88041f 34 r = vsprintf(buffer, format, arg);
group-Avnet 0:478cfd88041f 35 // this may not hit the heap but should alert the user anyways
group-Avnet 0:478cfd88041f 36 if(r > (int32_t) size) {
group-Avnet 0:478cfd88041f 37 error("%s %d buffer overwrite (max_buf_size: %d exceeded: %d)!\r\n", __FILE__, __LINE__, size, r);
group-Avnet 0:478cfd88041f 38 return 0;
group-Avnet 0:478cfd88041f 39 }
group-Avnet 0:478cfd88041f 40 if ( r > 0 ) {
group-Avnet 0:478cfd88041f 41 BufferedSerialThunk(stream, buffer, r);
group-Avnet 0:478cfd88041f 42 }
group-Avnet 0:478cfd88041f 43 return r;
group-Avnet 0:478cfd88041f 44 }