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 ******************************************************************************
group-Avnet 0:478cfd88041f 3 * @file SPIRIT_Config.h
group-Avnet 0:478cfd88041f 4 * @author VMA division - AMS
group-Avnet 0:478cfd88041f 5 * @version 3.2.2
group-Avnet 0:478cfd88041f 6 * @date 08-July-2015
group-Avnet 0:478cfd88041f 7 * @brief Spirit Configuration and useful defines
group-Avnet 0:478cfd88041f 8 *
group-Avnet 0:478cfd88041f 9 * @details
group-Avnet 0:478cfd88041f 10 *
group-Avnet 0:478cfd88041f 11 * This file is used to include all or a part of the Spirit
group-Avnet 0:478cfd88041f 12 * libraries into the application program which will be used.
group-Avnet 0:478cfd88041f 13 * Moreover some important parameters are defined here and the
group-Avnet 0:478cfd88041f 14 * user is allowed to edit them.
group-Avnet 0:478cfd88041f 15 *
group-Avnet 0:478cfd88041f 16 * @attention
group-Avnet 0:478cfd88041f 17 *
group-Avnet 0:478cfd88041f 18 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 19 *
group-Avnet 0:478cfd88041f 20 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 21 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 22 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 23 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 24 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 25 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 26 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 27 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 28 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 29 * without specific prior written permission.
group-Avnet 0:478cfd88041f 30 *
group-Avnet 0:478cfd88041f 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 32 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 33 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 34 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 35 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 37 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 39 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 40 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 41 *
group-Avnet 0:478cfd88041f 42 ******************************************************************************
group-Avnet 0:478cfd88041f 43 */
group-Avnet 0:478cfd88041f 44
group-Avnet 0:478cfd88041f 45 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 46 #ifndef __SPIRIT_CONFIG_H
group-Avnet 0:478cfd88041f 47 #define __SPIRIT_CONFIG_H
group-Avnet 0:478cfd88041f 48
group-Avnet 0:478cfd88041f 49
group-Avnet 0:478cfd88041f 50 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 51 #include "SPIRIT_Regs.h"
group-Avnet 0:478cfd88041f 52 #include "SPIRIT_Aes.h"
group-Avnet 0:478cfd88041f 53 #include "SPIRIT_Calibration.h"
group-Avnet 0:478cfd88041f 54 #include "SPIRIT_Commands.h"
group-Avnet 0:478cfd88041f 55 #include "SPIRIT_Csma.h"
group-Avnet 0:478cfd88041f 56 #include "SPIRIT_DirectRF.h"
group-Avnet 0:478cfd88041f 57 #include "SPIRIT_General.h"
group-Avnet 0:478cfd88041f 58 #include "SPIRIT_Gpio.h"
group-Avnet 0:478cfd88041f 59 #include "SPIRIT_Irq.h"
group-Avnet 0:478cfd88041f 60 #include "SPIRIT_Timer.h"
group-Avnet 0:478cfd88041f 61 #include "SPIRIT_LinearFifo.h"
group-Avnet 0:478cfd88041f 62 #include "SPIRIT_PktBasic.h"
group-Avnet 0:478cfd88041f 63 #include "SPIRIT_PktMbus.h"
group-Avnet 0:478cfd88041f 64 #include "SPIRIT_PktStack.h"
group-Avnet 0:478cfd88041f 65
group-Avnet 0:478cfd88041f 66 #include "SPIRIT_Qi.h"
group-Avnet 0:478cfd88041f 67 #include "SPIRIT_Radio.h"
group-Avnet 0:478cfd88041f 68 #include "MCU_Interface.h"
group-Avnet 0:478cfd88041f 69 #include "SPIRIT_Types.h"
group-Avnet 0:478cfd88041f 70 #include "SPIRIT_Management.h"
group-Avnet 0:478cfd88041f 71
group-Avnet 0:478cfd88041f 72
group-Avnet 0:478cfd88041f 73 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 74 extern "C" {
group-Avnet 0:478cfd88041f 75 #endif
group-Avnet 0:478cfd88041f 76
group-Avnet 0:478cfd88041f 77
group-Avnet 0:478cfd88041f 78 /** @addtogroup SPIRIT_Libraries SPIRIT Libraries
group-Avnet 0:478cfd88041f 79 * @brief This firmware implements libraries which allow the user
group-Avnet 0:478cfd88041f 80 * to manage the features of Spirit without knowing the hardware details.
group-Avnet 0:478cfd88041f 81 * @details The <i>SPIRIT_Libraries</i> modules are totally platform independent. The library provides one
group-Avnet 0:478cfd88041f 82 * module for each device feature. Each module refers to some functions whose prototypes are located in the
group-Avnet 0:478cfd88041f 83 * header file <i>@ref MCU_Interface.h</i>. The user who want to use these libraries on a particular
group-Avnet 0:478cfd88041f 84 * platform has to implement these functions respecting them signatures.
group-Avnet 0:478cfd88041f 85 * @{
group-Avnet 0:478cfd88041f 86 */
group-Avnet 0:478cfd88041f 87
group-Avnet 0:478cfd88041f 88 /** @defgroup SPIRIT_Configuration Configuration
group-Avnet 0:478cfd88041f 89 * @brief Spirit Configuration and useful defines.
group-Avnet 0:478cfd88041f 90 * @details See the file <i>@ref SPIRIT_Config.h</i> for more details.
group-Avnet 0:478cfd88041f 91 * @{
group-Avnet 0:478cfd88041f 92 */
group-Avnet 0:478cfd88041f 93
group-Avnet 0:478cfd88041f 94
group-Avnet 0:478cfd88041f 95 /** @defgroup Configuration_Exported_Types Configuration Exported Types
group-Avnet 0:478cfd88041f 96 * @{
group-Avnet 0:478cfd88041f 97 */
group-Avnet 0:478cfd88041f 98
group-Avnet 0:478cfd88041f 99 /**
group-Avnet 0:478cfd88041f 100 * @}
group-Avnet 0:478cfd88041f 101 */
group-Avnet 0:478cfd88041f 102
group-Avnet 0:478cfd88041f 103
group-Avnet 0:478cfd88041f 104 /** @defgroup Configuration_Exported_Constants Configuration Exported Constants
group-Avnet 0:478cfd88041f 105 * @{
group-Avnet 0:478cfd88041f 106 */
group-Avnet 0:478cfd88041f 107 #define DOUBLE_XTAL_THR 30000000
group-Avnet 0:478cfd88041f 108
group-Avnet 0:478cfd88041f 109 /**
group-Avnet 0:478cfd88041f 110 * @}
group-Avnet 0:478cfd88041f 111 */
group-Avnet 0:478cfd88041f 112
group-Avnet 0:478cfd88041f 113
group-Avnet 0:478cfd88041f 114 /** @defgroup Configuration_Exported_Macros Configuration Exported Macros
group-Avnet 0:478cfd88041f 115 * @{
group-Avnet 0:478cfd88041f 116 */
group-Avnet 0:478cfd88041f 117
group-Avnet 0:478cfd88041f 118 /**
group-Avnet 0:478cfd88041f 119 * @}
group-Avnet 0:478cfd88041f 120 */
group-Avnet 0:478cfd88041f 121
group-Avnet 0:478cfd88041f 122
group-Avnet 0:478cfd88041f 123 /** @defgroup Configuration_Exported_Functions Configuration Exported Functions
group-Avnet 0:478cfd88041f 124 * @{
group-Avnet 0:478cfd88041f 125 */
group-Avnet 0:478cfd88041f 126
group-Avnet 0:478cfd88041f 127 /**
group-Avnet 0:478cfd88041f 128 * @}
group-Avnet 0:478cfd88041f 129 */
group-Avnet 0:478cfd88041f 130
group-Avnet 0:478cfd88041f 131 /**
group-Avnet 0:478cfd88041f 132 * @}
group-Avnet 0:478cfd88041f 133 */
group-Avnet 0:478cfd88041f 134
group-Avnet 0:478cfd88041f 135
group-Avnet 0:478cfd88041f 136 /**
group-Avnet 0:478cfd88041f 137 * @}
group-Avnet 0:478cfd88041f 138 */
group-Avnet 0:478cfd88041f 139
group-Avnet 0:478cfd88041f 140
group-Avnet 0:478cfd88041f 141 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 142 }
group-Avnet 0:478cfd88041f 143 #endif
group-Avnet 0:478cfd88041f 144
group-Avnet 0:478cfd88041f 145 #endif
group-Avnet 0:478cfd88041f 146
group-Avnet 0:478cfd88041f 147 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/