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) 2012, STMicroelectronics.
group-Avnet 0:478cfd88041f 3 * All rights reserved.
group-Avnet 0:478cfd88041f 4 *
group-Avnet 0:478cfd88041f 5 * Redistribution and use in source and binary forms, with or without
group-Avnet 0:478cfd88041f 6 * modification, are permitted provided that the following conditions
group-Avnet 0:478cfd88041f 7 * are met:
group-Avnet 0:478cfd88041f 8 * 1. Redistributions of source code must retain the above copyright
group-Avnet 0:478cfd88041f 9 * notice, this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 10 * 2. Redistributions in binary form must reproduce the above copyright
group-Avnet 0:478cfd88041f 11 * notice, this list of conditions and the following disclaimer in the
group-Avnet 0:478cfd88041f 12 * documentation and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 13 * 3. Neither the name of the copyright holder nor the names of its
group-Avnet 0:478cfd88041f 14 * contributors may be used to endorse or promote products derived
group-Avnet 0:478cfd88041f 15 * from this software without specific prior written permission.
group-Avnet 0:478cfd88041f 16 *
group-Avnet 0:478cfd88041f 17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
group-Avnet 0:478cfd88041f 18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
group-Avnet 0:478cfd88041f 19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
group-Avnet 0:478cfd88041f 20 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
group-Avnet 0:478cfd88041f 21 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
group-Avnet 0:478cfd88041f 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
group-Avnet 0:478cfd88041f 23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
group-Avnet 0:478cfd88041f 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
group-Avnet 0:478cfd88041f 26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
group-Avnet 0:478cfd88041f 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
group-Avnet 0:478cfd88041f 28 * OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 29 *
group-Avnet 0:478cfd88041f 30 */
group-Avnet 0:478cfd88041f 31 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 32 #ifndef __SPIRIT1_CONST_H__
group-Avnet 0:478cfd88041f 33 #define __SPIRIT1_CONST_H__
group-Avnet 0:478cfd88041f 34 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 35
group-Avnet 0:478cfd88041f 36 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 37
group-Avnet 0:478cfd88041f 38 /* The state bitfield and values for different states, as read from MC_STATE[1:0] registers,
group-Avnet 0:478cfd88041f 39 which are returned on any SPI read or write operation. */
group-Avnet 0:478cfd88041f 40 #define SPIRIT1_STATE_STATEBITS (0x00FE)
group-Avnet 0:478cfd88041f 41 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 42
group-Avnet 0:478cfd88041f 43 #define SPIRIT1_STATE_STANDBY ((0x0040)<<1)
group-Avnet 0:478cfd88041f 44 #define SPIRIT1_STATE_SLEEP ((0x0036)<<1)
group-Avnet 0:478cfd88041f 45 #define SPIRIT1_STATE_READY ((0x0003)<<1)
group-Avnet 0:478cfd88041f 46 #define SPIRIT1_STATE_LOCK ((0x000F)<<1)
group-Avnet 0:478cfd88041f 47 #define SPIRIT1_STATE_RX ((0x0033)<<1)
group-Avnet 0:478cfd88041f 48 #define SPIRIT1_STATE_TX ((0x005F)<<1)
group-Avnet 0:478cfd88041f 49 /* NB the below states were extracted from ST drivers, but are not specified in the datasheet */
group-Avnet 0:478cfd88041f 50 #define SPIRIT1_STATE_PM_SETUP ((0x003D)<<1)
group-Avnet 0:478cfd88041f 51 #define SPIRIT1_STATE_XO_SETTLING ((0x0023)<<1)
group-Avnet 0:478cfd88041f 52 #define SPIRIT1_STATE_SYNTH_SETUP ((0x0053)<<1)
group-Avnet 0:478cfd88041f 53 #define SPIRIT1_STATE_PROTOCOL ((0x001F)<<1)
group-Avnet 0:478cfd88041f 54 #define SPIRIT1_STATE_SYNTH_CALIBRATION ((0x004F)<<1)
group-Avnet 0:478cfd88041f 55 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 56 /* strobe commands */
group-Avnet 0:478cfd88041f 57 #define SPIRIT1_STROBE_TX 0x60
group-Avnet 0:478cfd88041f 58 #define SPIRIT1_STROBE_RX 0x61
group-Avnet 0:478cfd88041f 59 #define SPIRIT1_STROBE_READY 0x62
group-Avnet 0:478cfd88041f 60 #define SPIRIT1_STROBE_STANDBY 0x63
group-Avnet 0:478cfd88041f 61 #define SPIRIT1_STROBE_SLEEP 0x64
group-Avnet 0:478cfd88041f 62 #define SPIRIT1_STROBE_SABORT 0x67
group-Avnet 0:478cfd88041f 63 #define SPIRIT1_STROBE_SRES 0x70
group-Avnet 0:478cfd88041f 64 #define SPIRIT1_STROBE_FRX 0x71
group-Avnet 0:478cfd88041f 65 #define SPIRIT1_STROBE_FTX 0x72
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 /* Exported types ------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 71 /*------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 72
group-Avnet 0:478cfd88041f 73
group-Avnet 0:478cfd88041f 74 #endif /* __SPIRIT1_CONST_H__ */
group-Avnet 0:478cfd88041f 75 /*---------------------------------------------------------------------------*/