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 stm32l-spirit1-config.h
group-Avnet 0:478cfd88041f 4 * @author MCD Application Team
group-Avnet 0:478cfd88041f 5 * @version V3.4.0
group-Avnet 0:478cfd88041f 6 * @date 29-June-2012
group-Avnet 0:478cfd88041f 7 * @brief Evaluation board specific configuration file.
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 2012 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 12 *
group-Avnet 0:478cfd88041f 13 * Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
group-Avnet 0:478cfd88041f 14 * You may not use this file except in compliance with the License.
group-Avnet 0:478cfd88041f 15 * You may obtain a copy of the License at:
group-Avnet 0:478cfd88041f 16 *
group-Avnet 0:478cfd88041f 17 * http://www.st.com/software_license_agreement_liberty_v2
group-Avnet 0:478cfd88041f 18 *
group-Avnet 0:478cfd88041f 19 * Unless required by applicable law or agreed to in writing, software
group-Avnet 0:478cfd88041f 20 * distributed under the License is distributed on an "AS IS" BASIS,
group-Avnet 0:478cfd88041f 21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-Avnet 0:478cfd88041f 22 * See the License for the specific language governing permissions and
group-Avnet 0:478cfd88041f 23 * limitations under the License.
group-Avnet 0:478cfd88041f 24 *
group-Avnet 0:478cfd88041f 25 ******************************************************************************
group-Avnet 0:478cfd88041f 26 */
group-Avnet 0:478cfd88041f 27
group-Avnet 0:478cfd88041f 28 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 29 #ifndef __STM32L_SPIRIT1_CONFIG_H
group-Avnet 0:478cfd88041f 30 #define __STM32L_SPIRIT1_CONFIG_H
group-Avnet 0:478cfd88041f 31
group-Avnet 0:478cfd88041f 32 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 33
group-Avnet 0:478cfd88041f 34 /* Exported types ------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 35 /* Exported constants --------------------------------------------------------*/
group-Avnet 0:478cfd88041f 36
group-Avnet 0:478cfd88041f 37 /* Define the STM32F10x hardware depending on the used evaluation board */
group-Avnet 0:478cfd88041f 38 #ifdef USE_STM3210B_EVAL
group-Avnet 0:478cfd88041f 39 #define USB_DISCONNECT GPIOD
group-Avnet 0:478cfd88041f 40 #define USB_DISCONNECT_PIN GPIO_PIN_9
group-Avnet 0:478cfd88041f 41 #define RCC_APB2Periph_GPIO_DISCONNECT RCC_APB2Periph_GPIOD
group-Avnet 0:478cfd88041f 42 #define EVAL_COM1_IRQHandler USART1_IRQHandler
group-Avnet 0:478cfd88041f 43
group-Avnet 0:478cfd88041f 44 #elif defined (USE_STM3210E_EVAL)
group-Avnet 0:478cfd88041f 45 #define USB_DISCONNECT GPIOB
group-Avnet 0:478cfd88041f 46 #define USB_DISCONNECT_PIN GPIO_PIN_14
group-Avnet 0:478cfd88041f 47 #define RCC_APB2Periph_GPIO_DISCONNECT RCC_APB2Periph_GPIOB
group-Avnet 0:478cfd88041f 48 #define EVAL_COM1_IRQHandler USART1_IRQHandler
group-Avnet 0:478cfd88041f 49
group-Avnet 0:478cfd88041f 50 #elif defined (USE_STM3210C_EVAL)
group-Avnet 0:478cfd88041f 51 #define USB_DISCONNECT 0
group-Avnet 0:478cfd88041f 52 #define USB_DISCONNECT_PIN 0
group-Avnet 0:478cfd88041f 53 #define RCC_APB2Periph_GPIO_DISCONNECT 0
group-Avnet 0:478cfd88041f 54 #define EVAL_COM1_IRQHandler USART2_IRQHandler
group-Avnet 0:478cfd88041f 55
group-Avnet 0:478cfd88041f 56 #elif defined (USE_STM32L152_EVAL) || defined (USE_STM32L152D_EVAL)
group-Avnet 0:478cfd88041f 57 /*
group-Avnet 0:478cfd88041f 58 For STM32L15xx devices it is possible to use the internal USB pullup
group-Avnet 0:478cfd88041f 59 controlled by register SYSCFG_PMC (refer to RM0038 reference manual for
group-Avnet 0:478cfd88041f 60 more details).
group-Avnet 0:478cfd88041f 61 It is also possible to use external pullup (and disable the internal pullup)
group-Avnet 0:478cfd88041f 62 by setting the define USB_USE_EXTERNAL_PULLUP in file platform_config.h
group-Avnet 0:478cfd88041f 63 and configuring the right pin to be used for the external pull up configuration.
group-Avnet 0:478cfd88041f 64 To have more details on how to use an external pull up, please refer to
group-Avnet 0:478cfd88041f 65 STM3210E-EVAL evaluation board manuals.
group-Avnet 0:478cfd88041f 66 */
group-Avnet 0:478cfd88041f 67 /* Uncomment the following define to use an external pull up instead of the
group-Avnet 0:478cfd88041f 68 integrated STM32L15xx internal pull up. In this case make sure to set up
group-Avnet 0:478cfd88041f 69 correctly the external required hardware and the GPIO defines below.*/
group-Avnet 0:478cfd88041f 70 /* #define USB_USE_EXTERNAL_PULLUP */
group-Avnet 0:478cfd88041f 71
group-Avnet 0:478cfd88041f 72 #if !defined(USB_USE_EXTERNAL_PULLUP)
group-Avnet 0:478cfd88041f 73 #define STM32L15_USB_CONNECT SYSCFG_USBPuCmd(ENABLE)
group-Avnet 0:478cfd88041f 74 #define STM32L15_USB_DISCONNECT SYSCFG_USBPuCmd(DISABLE)
group-Avnet 0:478cfd88041f 75
group-Avnet 0:478cfd88041f 76 #elif defined(USB_USE_EXTERNAL_PULLUP)
group-Avnet 0:478cfd88041f 77 /* PA0 is chosen just as illustrating example, you should modify the defines
group-Avnet 0:478cfd88041f 78 below according to your hardware configuration. */
group-Avnet 0:478cfd88041f 79 #define USB_DISCONNECT GPIOA
group-Avnet 0:478cfd88041f 80 #define USB_DISCONNECT_PIN GPIO_PIN_0
group-Avnet 0:478cfd88041f 81 #define RCC_AHBPeriph_GPIO_DISCONNECT RCC_AHBPeriph_GPIOA
group-Avnet 0:478cfd88041f 82 #define STM32L15_USB_CONNECT GPIO_ResetBits(USB_DISCONNECT, USB_DISCONNECT_PIN)
group-Avnet 0:478cfd88041f 83 #define STM32L15_USB_DISCONNECT GPIO_SetBits(USB_DISCONNECT, USB_DISCONNECT_PIN)
group-Avnet 0:478cfd88041f 84 #endif /* USB_USE_EXTERNAL_PULLUP */
group-Avnet 0:478cfd88041f 85
group-Avnet 0:478cfd88041f 86 #ifdef USE_STM32L152_EVAL
group-Avnet 0:478cfd88041f 87 #define EVAL_COM1_IRQHandler USART2_IRQHandler
group-Avnet 0:478cfd88041f 88 #elif defined (USE_STM32L152D_EVAL)
group-Avnet 0:478cfd88041f 89 #define EVAL_COM1_IRQHandler USART1_IRQHandler
group-Avnet 0:478cfd88041f 90 #endif /*USE_STM32L152_EVAL*/
group-Avnet 0:478cfd88041f 91
group-Avnet 0:478cfd88041f 92 #endif /* USE_STM3210B_EVAL */
group-Avnet 0:478cfd88041f 93
group-Avnet 0:478cfd88041f 94 /* Exported macro ------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 95 /* Exported functions ------------------------------------------------------- */
group-Avnet 0:478cfd88041f 96
group-Avnet 0:478cfd88041f 97 #endif /* __STM32L_SPIRIT1_CONFIG_H */
group-Avnet 0:478cfd88041f 98 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/