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_Management.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 The management layer for SPIRIT1 library.
group-Avnet 0:478cfd88041f 8 * @details
group-Avnet 0:478cfd88041f 9 *
group-Avnet 0:478cfd88041f 10 * @attention
group-Avnet 0:478cfd88041f 11 *
group-Avnet 0:478cfd88041f 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 13 *
group-Avnet 0:478cfd88041f 14 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 15 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 16 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 17 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 19 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 20 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 22 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 23 * without specific prior written permission.
group-Avnet 0:478cfd88041f 24 *
group-Avnet 0:478cfd88041f 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 35 *
group-Avnet 0:478cfd88041f 36 ******************************************************************************
group-Avnet 0:478cfd88041f 37 */
group-Avnet 0:478cfd88041f 38
group-Avnet 0:478cfd88041f 39 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 40 #ifndef SPIRIT_MANAGEMENT_H_
group-Avnet 0:478cfd88041f 41 #define SPIRIT_MANAGEMENT_H_
group-Avnet 0:478cfd88041f 42
group-Avnet 0:478cfd88041f 43 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 44 #include "SPIRIT_Config.h"
group-Avnet 0:478cfd88041f 45
group-Avnet 0:478cfd88041f 46 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 47 extern "C" {
group-Avnet 0:478cfd88041f 48 #endif
group-Avnet 0:478cfd88041f 49
group-Avnet 0:478cfd88041f 50
group-Avnet 0:478cfd88041f 51 /**
group-Avnet 0:478cfd88041f 52 * @addtogroup SPIRIT_Libraries
group-Avnet 0:478cfd88041f 53 * @{
group-Avnet 0:478cfd88041f 54 */
group-Avnet 0:478cfd88041f 55
group-Avnet 0:478cfd88041f 56
group-Avnet 0:478cfd88041f 57 /**
group-Avnet 0:478cfd88041f 58 * @defgroup SPIRIT_MANAGEMENT Management
group-Avnet 0:478cfd88041f 59 * @brief Workarounds for Spirit1.
group-Avnet 0:478cfd88041f 60 * @details See the file <i>@ref SPIRIT_Management.h</i> for more details.
group-Avnet 0:478cfd88041f 61 * @{
group-Avnet 0:478cfd88041f 62 */
group-Avnet 0:478cfd88041f 63
group-Avnet 0:478cfd88041f 64
group-Avnet 0:478cfd88041f 65 /**
group-Avnet 0:478cfd88041f 66 * @addgroup SPIRIT_MANAGEMENT_FUNCTIONS
group-Avnet 0:478cfd88041f 67 * @{
group-Avnet 0:478cfd88041f 68 */
group-Avnet 0:478cfd88041f 69
group-Avnet 0:478cfd88041f 70
group-Avnet 0:478cfd88041f 71
group-Avnet 0:478cfd88041f 72
group-Avnet 0:478cfd88041f 73 uint8_t SpiritManagementWaVcoCalibration(void);
group-Avnet 0:478cfd88041f 74 void SpiritManagementWaCmdStrobeTx(void);
group-Avnet 0:478cfd88041f 75 void SpiritManagementWaCmdStrobeRx(void);
group-Avnet 0:478cfd88041f 76 void SpiritManagementWaTRxFcMem(uint32_t nDesiredFreq);
group-Avnet 0:478cfd88041f 77 void SpiritManagementWaExtraCurrent(void);
group-Avnet 0:478cfd88041f 78
group-Avnet 0:478cfd88041f 79 /**
group-Avnet 0:478cfd88041f 80 * @}
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 */
group-Avnet 0:478cfd88041f 86
group-Avnet 0:478cfd88041f 87 /**
group-Avnet 0:478cfd88041f 88 * @}
group-Avnet 0:478cfd88041f 89 */
group-Avnet 0:478cfd88041f 90
group-Avnet 0:478cfd88041f 91 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 92 }
group-Avnet 0:478cfd88041f 93 #endif
group-Avnet 0:478cfd88041f 94
group-Avnet 0:478cfd88041f 95
group-Avnet 0:478cfd88041f 96 #endif
group-Avnet 0:478cfd88041f 97
group-Avnet 0:478cfd88041f 98
group-Avnet 0:478cfd88041f 99 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/
group-Avnet 0:478cfd88041f 100