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 platform/stm32nucleo-spirit1/platform-conf.h
group-Avnet 0:478cfd88041f 4 * @author System LAB
group-Avnet 0:478cfd88041f 5 * @version V1.0.0
group-Avnet 0:478cfd88041f 6 * @date 17-May-2015
group-Avnet 0:478cfd88041f 7 * @brief Configuration parameters
group-Avnet 0:478cfd88041f 8 ******************************************************************************
group-Avnet 0:478cfd88041f 9 * @attention
group-Avnet 0:478cfd88041f 10 *
group-Avnet 0:478cfd88041f 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 12 *
group-Avnet 0:478cfd88041f 13 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 14 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 15 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 16 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 18 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 19 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 21 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 22 * without specific prior written permission.
group-Avnet 0:478cfd88041f 23 *
group-Avnet 0:478cfd88041f 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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 /**
group-Avnet 0:478cfd88041f 39 * \addtogroup stm32nucleo-spirit1
group-Avnet 0:478cfd88041f 40 * @{
group-Avnet 0:478cfd88041f 41 *
group-Avnet 0:478cfd88041f 42 * \defgroup stm32nucleo-spirit1-peripherals User Button on STM32 Nucleo
group-Avnet 0:478cfd88041f 43 *
group-Avnet 0:478cfd88041f 44 * Defines some of the platforms capabilities
group-Avnet 0:478cfd88041f 45 * @{
group-Avnet 0:478cfd88041f 46 *
group-Avnet 0:478cfd88041f 47 * \file
group-Avnet 0:478cfd88041f 48 * Header file for the stm32nucleo-spirit1 platform configuration
group-Avnet 0:478cfd88041f 49 */
group-Avnet 0:478cfd88041f 50 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 51 #ifndef __PLATFORM_CONF_H__
group-Avnet 0:478cfd88041f 52 #define __PLATFORM_CONF_H__
group-Avnet 0:478cfd88041f 53 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 54 #ifdef USE_STM32L1XX_NUCLEO
group-Avnet 0:478cfd88041f 55 #include <inttypes.h>
group-Avnet 0:478cfd88041f 56 #include <string.h>
group-Avnet 0:478cfd88041f 57 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 58 #define PLATFORM_HAS_LEDS 1
group-Avnet 0:478cfd88041f 59 #define PLATFORM_HAS_BUTTON 1
group-Avnet 0:478cfd88041f 60 #define PLATFORM_HAS_RADIO 1
group-Avnet 0:478cfd88041f 61
group-Avnet 0:478cfd88041f 62 #define LEDS_GREEN 1 /*Nucleo LED*/
group-Avnet 0:478cfd88041f 63 #define LEDS_RED 2 /*SPIRIT1 LED*/
group-Avnet 0:478cfd88041f 64
group-Avnet 0:478cfd88041f 65 #ifdef COMPILE_SENSORS
group-Avnet 0:478cfd88041f 66 #define LEDS_CONF_ALL 1 /*Can't use SPIRIT1 LED in this case*/
group-Avnet 0:478cfd88041f 67 #else
group-Avnet 0:478cfd88041f 68 #define LEDS_CONF_ALL 3 /*No sensors -> we can use SPIRIT1 LED in this case*/
group-Avnet 0:478cfd88041f 69 #endif /*COMPILE_SENSORS*/
group-Avnet 0:478cfd88041f 70 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 71 #define F_CPU 32000000ul
group-Avnet 0:478cfd88041f 72 #define RTIMER_ARCH_SECOND 32768
group-Avnet 0:478cfd88041f 73 #define PRESCALER ((F_CPU / (RTIMER_ARCH_SECOND*2)))
group-Avnet 0:478cfd88041f 74
group-Avnet 0:478cfd88041f 75 #define UART1_CONF_TX_WITH_INTERRUPT 0
group-Avnet 0:478cfd88041f 76 #define WITH_SERIAL_LINE_INPUT 1
group-Avnet 0:478cfd88041f 77 #define TELNETD_CONF_NUMLINES 6
group-Avnet 0:478cfd88041f 78 #define NETSTACK_CONF_RADIO spirit_radio_driver
group-Avnet 0:478cfd88041f 79 #define NETSTACK_RADIO_MAX_PAYLOAD_LEN 96 /* spirit1-config.h */
group-Avnet 0:478cfd88041f 80
group-Avnet 0:478cfd88041f 81 #if WITH_IP64
group-Avnet 0:478cfd88041f 82 #include "ip64-conf.h"
group-Avnet 0:478cfd88041f 83 #define WITH_SLIP 1
group-Avnet 0:478cfd88041f 84 #ifndef UIP_FALLBACK_INTERFACE
group-Avnet 0:478cfd88041f 85 #define UIP_FALLBACK_INTERFACE ip64_uip_fallback_interface
group-Avnet 0:478cfd88041f 86 #endif
group-Avnet 0:478cfd88041f 87 #endif /* WITH_IP64 */
group-Avnet 0:478cfd88041f 88
group-Avnet 0:478cfd88041f 89 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 90 /* define ticks/second for slow and fast clocks. Notice that these should be a
group-Avnet 0:478cfd88041f 91 power of two, eg 64,128,256,512 etc, for efficiency as POT's can be optimized
group-Avnet 0:478cfd88041f 92 well. */
group-Avnet 0:478cfd88041f 93 #define CLOCK_CONF_SECOND 128
group-Avnet 0:478cfd88041f 94 #define RELOAD_VALUE ((F_CPU/CLOCK_CONF_SECOND) - 1)
group-Avnet 0:478cfd88041f 95 /* One tick: 62.5 ms */
group-Avnet 0:478cfd88041f 96
group-Avnet 0:478cfd88041f 97 #define RTIMER_CLOCK_LT(a,b) ((signed short)((a)-(b)) < 0)
group-Avnet 0:478cfd88041f 98 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 99 typedef unsigned long clock_time_t;
group-Avnet 0:478cfd88041f 100 typedef unsigned long long rtimer_clock_t;
group-Avnet 0:478cfd88041f 101 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 102 #define CC_CONF_REGISTER_ARGS 0
group-Avnet 0:478cfd88041f 103 #define CC_CONF_FUNCTION_POINTER_ARGS 1
group-Avnet 0:478cfd88041f 104 #define CC_CONF_FASTCALL
group-Avnet 0:478cfd88041f 105 #define CC_CONF_VA_ARGS 1
group-Avnet 0:478cfd88041f 106 #define CC_CONF_INLINE inline
group-Avnet 0:478cfd88041f 107
group-Avnet 0:478cfd88041f 108 #define CCIF
group-Avnet 0:478cfd88041f 109 #define CLIF
group-Avnet 0:478cfd88041f 110 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 111 typedef uint8_t u8_t;
group-Avnet 0:478cfd88041f 112 typedef uint16_t u16_t;
group-Avnet 0:478cfd88041f 113 typedef uint32_t u32_t;
group-Avnet 0:478cfd88041f 114 typedef int32_t s32_t;
group-Avnet 0:478cfd88041f 115 typedef unsigned short uip_stats_t;
group-Avnet 0:478cfd88041f 116 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 117 #define MULTICHAN_CONF_SET_CHANNEL(x)
group-Avnet 0:478cfd88041f 118 #define MULTICHAN_CONF_READ_RSSI(x) 0
group-Avnet 0:478cfd88041f 119 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 120 #endif//USE_STM32L1XX_NUCLEO
group-Avnet 0:478cfd88041f 121
group-Avnet 0:478cfd88041f 122 #ifdef USE_STM32F4XX_NUCLEO
group-Avnet 0:478cfd88041f 123 #include <inttypes.h>
group-Avnet 0:478cfd88041f 124 #include <string.h>
group-Avnet 0:478cfd88041f 125 #include "main.h"
group-Avnet 0:478cfd88041f 126 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 127 #define PLATFORM_HAS_LEDS 1
group-Avnet 0:478cfd88041f 128 #define PLATFORM_HAS_BUTTON 1
group-Avnet 0:478cfd88041f 129 #define PLATFORM_HAS_RADIO 1
group-Avnet 0:478cfd88041f 130
group-Avnet 0:478cfd88041f 131 #define LEDS_GREEN 1 /*Nucleo LED*/
group-Avnet 0:478cfd88041f 132 #define LEDS_RED 2 /*SPIRIT1 LED*/
group-Avnet 0:478cfd88041f 133
group-Avnet 0:478cfd88041f 134 #ifdef COMPILE_SENSORS
group-Avnet 0:478cfd88041f 135 #define LEDS_CONF_ALL 1 /*Can't use SPIRIT1 LED in this case*/
group-Avnet 0:478cfd88041f 136 #else
group-Avnet 0:478cfd88041f 137 #define LEDS_CONF_ALL 3 /*No sensors -> we can use SPIRIT1 LED in this case*/
group-Avnet 0:478cfd88041f 138 #endif /*COMPILE_SENSORS*/
group-Avnet 0:478cfd88041f 139 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 140 #define F_CPU 84000000ul
group-Avnet 0:478cfd88041f 141 #define RTIMER_ARCH_SECOND 96000//32678
group-Avnet 0:478cfd88041f 142 //#define PRESCALER uwPrescalerValue
group-Avnet 0:478cfd88041f 143
group-Avnet 0:478cfd88041f 144 #define UART1_CONF_TX_WITH_INTERRUPT 0
group-Avnet 0:478cfd88041f 145 #define WITH_SERIAL_LINE_INPUT 1
group-Avnet 0:478cfd88041f 146 #define TELNETD_CONF_NUMLINES 6
group-Avnet 0:478cfd88041f 147 #define NETSTACK_CONF_RADIO spirit_radio_driver
group-Avnet 0:478cfd88041f 148 #define NETSTACK_RADIO_MAX_PAYLOAD_LEN 96 /* spirit1-config.h */
group-Avnet 0:478cfd88041f 149
group-Avnet 0:478cfd88041f 150 #if WITH_IP64
group-Avnet 0:478cfd88041f 151 #include "ip64-conf.h"
group-Avnet 0:478cfd88041f 152 #define WITH_SLIP 1
group-Avnet 0:478cfd88041f 153 #ifndef UIP_FALLBACK_INTERFACE
group-Avnet 0:478cfd88041f 154 #define UIP_FALLBACK_INTERFACE ip64_uip_fallback_interface
group-Avnet 0:478cfd88041f 155 #endif
group-Avnet 0:478cfd88041f 156 #endif /* WITH_IP64 */
group-Avnet 0:478cfd88041f 157
group-Avnet 0:478cfd88041f 158 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 159 /* define ticks/second for slow and fast clocks. Notice that these should be a
group-Avnet 0:478cfd88041f 160 power of two, eg 64,128,256,512 etc, for efficiency as POT's can be optimized
group-Avnet 0:478cfd88041f 161 well. */
group-Avnet 0:478cfd88041f 162 #define CLOCK_CONF_SECOND 512
group-Avnet 0:478cfd88041f 163 #define RELOAD_VALUE ((F_CPU/CLOCK_CONF_SECOND) - 1)
group-Avnet 0:478cfd88041f 164
group-Avnet 0:478cfd88041f 165 /* One tick: 62.5 ms */
group-Avnet 0:478cfd88041f 166
group-Avnet 0:478cfd88041f 167 #define RTIMER_CLOCK_LT(a,b) ((signed short)((a)-(b)) < 0)
group-Avnet 0:478cfd88041f 168 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 169 typedef unsigned long clock_time_t;
group-Avnet 0:478cfd88041f 170 typedef unsigned long long rtimer_clock_t;
group-Avnet 0:478cfd88041f 171 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 172 #define CC_CONF_REGISTER_ARGS 0
group-Avnet 0:478cfd88041f 173 #define CC_CONF_FUNCTION_POINTER_ARGS 1
group-Avnet 0:478cfd88041f 174 #define CC_CONF_FASTCALL
group-Avnet 0:478cfd88041f 175 #define CC_CONF_VA_ARGS 1
group-Avnet 0:478cfd88041f 176 #define CC_CONF_INLINE inline
group-Avnet 0:478cfd88041f 177
group-Avnet 0:478cfd88041f 178 #define CCIF
group-Avnet 0:478cfd88041f 179 #define CLIF
group-Avnet 0:478cfd88041f 180 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 181 typedef uint8_t u8_t;
group-Avnet 0:478cfd88041f 182 typedef uint16_t u16_t;
group-Avnet 0:478cfd88041f 183 typedef uint32_t u32_t;
group-Avnet 0:478cfd88041f 184 typedef int32_t s32_t;
group-Avnet 0:478cfd88041f 185 typedef unsigned short uip_stats_t;
group-Avnet 0:478cfd88041f 186 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 187 #define MULTICHAN_CONF_SET_CHANNEL(x)
group-Avnet 0:478cfd88041f 188 #define MULTICHAN_CONF_READ_RSSI(x) 0
group-Avnet 0:478cfd88041f 189 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 190 #endif//USE_STM32F4XX_NUCLEO
group-Avnet 0:478cfd88041f 191
group-Avnet 0:478cfd88041f 192 #endif /* __PLATFORM_CONF_H__ */
group-Avnet 0:478cfd88041f 193 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 194 /**
group-Avnet 0:478cfd88041f 195 * @}
group-Avnet 0:478cfd88041f 196 * @}
group-Avnet 0:478cfd88041f 197 */