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_DirectRF.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 Configuration and management of SPIRIT direct transmission / receive modes.
group-Avnet 0:478cfd88041f 8 * @details
group-Avnet 0:478cfd88041f 9 *
group-Avnet 0:478cfd88041f 10 * This module contains functions to manage the direct Tx/Rx mode.
group-Avnet 0:478cfd88041f 11 * The user can choose the way to send data to Spirit through the
group-Avnet 0:478cfd88041f 12 * enumerative types <i>@ref DirectTx</i>/<i>@ref DirectRx</i>.
group-Avnet 0:478cfd88041f 13 *
group-Avnet 0:478cfd88041f 14 * @attention
group-Avnet 0:478cfd88041f 15 *
group-Avnet 0:478cfd88041f 16 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 17 *
group-Avnet 0:478cfd88041f 18 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 19 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 20 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 21 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 22 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 23 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 24 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 25 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 26 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 27 * without specific prior written permission.
group-Avnet 0:478cfd88041f 28 *
group-Avnet 0:478cfd88041f 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 30 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 31 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 32 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 34 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 36 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 37 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 39 *
group-Avnet 0:478cfd88041f 40 ******************************************************************************
group-Avnet 0:478cfd88041f 41 */
group-Avnet 0:478cfd88041f 42
group-Avnet 0:478cfd88041f 43 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 44 #ifndef __SPIRIT1_DIRECT_RF_H
group-Avnet 0:478cfd88041f 45 #define __SPIRIT1_DIRECT_RF_H
group-Avnet 0:478cfd88041f 46
group-Avnet 0:478cfd88041f 47 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 48
group-Avnet 0:478cfd88041f 49 #include "SPIRIT_Regs.h"
group-Avnet 0:478cfd88041f 50 #include "SPIRIT_Types.h"
group-Avnet 0:478cfd88041f 51
group-Avnet 0:478cfd88041f 52
group-Avnet 0:478cfd88041f 53
group-Avnet 0:478cfd88041f 54 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 55 extern "C" {
group-Avnet 0:478cfd88041f 56 #endif
group-Avnet 0:478cfd88041f 57
group-Avnet 0:478cfd88041f 58
group-Avnet 0:478cfd88041f 59 /**
group-Avnet 0:478cfd88041f 60 * @addtogroup SPIRIT_Libraries
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 * @defgroup SPIRIT_DirectRf Direct RF
group-Avnet 0:478cfd88041f 67 * @brief Configuration and management of SPIRIT direct transmission / receive modes.
group-Avnet 0:478cfd88041f 68 * @details See the file <i>@ref SPIRIT_DirectRF.h</i> for more details.
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 * @defgroup DirectRf_Exported_Types Direct RF Exported Types
group-Avnet 0:478cfd88041f 74 * @{
group-Avnet 0:478cfd88041f 75 */
group-Avnet 0:478cfd88041f 76
group-Avnet 0:478cfd88041f 77 /**
group-Avnet 0:478cfd88041f 78 * @brief Direct transmission mode enumeration for SPIRIT.
group-Avnet 0:478cfd88041f 79 */
group-Avnet 0:478cfd88041f 80 typedef enum
group-Avnet 0:478cfd88041f 81 {
group-Avnet 0:478cfd88041f 82 NORMAL_TX_MODE = 0x00, /*!< Normal mode, no direct transmission is used */
group-Avnet 0:478cfd88041f 83 DIRECT_TX_FIFO_MODE = 0x04, /*!< Source is FIFO: payload bits are continuously read from the TX FIFO */
group-Avnet 0:478cfd88041f 84 DIRECT_TX_GPIO_MODE = 0x08, /*!< Source is GPIO: payload bits are continuously read from one of the GPIO ports and transmitted without any processing */
group-Avnet 0:478cfd88041f 85 PN9_TX_MODE = 0x0C /*!< A pseudorandom binary sequence is generated internally */
group-Avnet 0:478cfd88041f 86 }DirectTx;
group-Avnet 0:478cfd88041f 87
group-Avnet 0:478cfd88041f 88 #define IS_DIRECT_TX(MODE) (((MODE) == NORMAL_TX_MODE) || \
group-Avnet 0:478cfd88041f 89 ((MODE) == DIRECT_TX_FIFO_MODE) || \
group-Avnet 0:478cfd88041f 90 ((MODE) == DIRECT_TX_GPIO_MODE) || \
group-Avnet 0:478cfd88041f 91 ((MODE) == PN9_TX_MODE))
group-Avnet 0:478cfd88041f 92
group-Avnet 0:478cfd88041f 93 /**
group-Avnet 0:478cfd88041f 94 * @brief Direct receive mode enumeration for SPIRIT.
group-Avnet 0:478cfd88041f 95 */
group-Avnet 0:478cfd88041f 96 typedef enum
group-Avnet 0:478cfd88041f 97 {
group-Avnet 0:478cfd88041f 98 NORMAL_RX_MODE = 0x00, /*!< Normal mode, no direct reception is used */
group-Avnet 0:478cfd88041f 99 DIRECT_RX_FIFO_MODE = 0x10, /*!< Destination is FIFO: payload bits are continuously written to the RX FIFO and not subjected to any processing*/
group-Avnet 0:478cfd88041f 100 DIRECT_RX_GPIO_MODE = 0x20 /*!< Destination is GPIO: payload bits are continuously written to one of the GPIO ports and not subjected to any processing*/
group-Avnet 0:478cfd88041f 101 }DirectRx;
group-Avnet 0:478cfd88041f 102
group-Avnet 0:478cfd88041f 103 #define IS_DIRECT_RX(MODE) (((MODE) == NORMAL_RX_MODE) || \
group-Avnet 0:478cfd88041f 104 ((MODE) == DIRECT_RX_FIFO_MODE) || \
group-Avnet 0:478cfd88041f 105 ((MODE) == DIRECT_RX_GPIO_MODE))
group-Avnet 0:478cfd88041f 106
group-Avnet 0:478cfd88041f 107
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 DirectRf_Exported_Constants Direct RF Exported Constants
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
group-Avnet 0:478cfd88041f 124 /**
group-Avnet 0:478cfd88041f 125 * @defgroup DirectRf_Exported_Macros Direct RF Exported Macros
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 * @defgroup DirectRf_Exported_Functions Direct RF Exported Functions
group-Avnet 0:478cfd88041f 137 * @{
group-Avnet 0:478cfd88041f 138 */
group-Avnet 0:478cfd88041f 139
group-Avnet 0:478cfd88041f 140 void SpiritDirectRfSetRxMode(DirectRx xDirectRx);
group-Avnet 0:478cfd88041f 141 DirectRx SpiritDirectRfGetRxMode(void);
group-Avnet 0:478cfd88041f 142 void SpiritDirectRfSetTxMode(DirectTx xDirectTx);
group-Avnet 0:478cfd88041f 143 DirectTx SpiritDirectRfGetTxMode(void);
group-Avnet 0:478cfd88041f 144
group-Avnet 0:478cfd88041f 145 /**
group-Avnet 0:478cfd88041f 146 *@}
group-Avnet 0:478cfd88041f 147 */
group-Avnet 0:478cfd88041f 148
group-Avnet 0:478cfd88041f 149 /**
group-Avnet 0:478cfd88041f 150 *@}
group-Avnet 0:478cfd88041f 151 */
group-Avnet 0:478cfd88041f 152
group-Avnet 0:478cfd88041f 153
group-Avnet 0:478cfd88041f 154 /**
group-Avnet 0:478cfd88041f 155 *@}
group-Avnet 0:478cfd88041f 156 */
group-Avnet 0:478cfd88041f 157
group-Avnet 0:478cfd88041f 158
group-Avnet 0:478cfd88041f 159 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 160 }
group-Avnet 0:478cfd88041f 161 #endif
group-Avnet 0:478cfd88041f 162
group-Avnet 0:478cfd88041f 163 #endif
group-Avnet 0:478cfd88041f 164
group-Avnet 0:478cfd88041f 165 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/