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 hw-config.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 Header file for Hardware Configuration & Setup
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 #ifndef __HW_CONFIG_H
group-Avnet 0:478cfd88041f 39 #define __HW_CONFIG_H
group-Avnet 0:478cfd88041f 40 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 41 #include "stm32l-spirit1-config.h"
group-Avnet 0:478cfd88041f 42 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 43 #define UART_RxBufferSize 512
group-Avnet 0:478cfd88041f 44 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 45 #define I2Cx I2C1
group-Avnet 0:478cfd88041f 46 #define I2Cx_CLK_ENABLE() __I2C1_CLK_ENABLE()
group-Avnet 0:478cfd88041f 47 #define I2Cx_SDA_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE()
group-Avnet 0:478cfd88041f 48 #define I2Cx_SCL_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE()
group-Avnet 0:478cfd88041f 49 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 50 #define I2Cx_FORCE_RESET() __I2C1_FORCE_RESET()
group-Avnet 0:478cfd88041f 51 #define I2Cx_RELEASE_RESET() __I2C1_RELEASE_RESET()
group-Avnet 0:478cfd88041f 52 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 53 /* Definition for I2Cx Pins */
group-Avnet 0:478cfd88041f 54 #define I2Cx_SCL_PIN GPIO_PIN_8
group-Avnet 0:478cfd88041f 55 #define I2Cx_SCL_GPIO_PORT GPIOB
group-Avnet 0:478cfd88041f 56 #define I2Cx_SDA_PIN GPIO_PIN_9
group-Avnet 0:478cfd88041f 57 #define I2Cx_SDA_GPIO_PORT GPIOB
group-Avnet 0:478cfd88041f 58 #define I2Cx_SCL_SDA_AF GPIO_AF4_I2C1
group-Avnet 0:478cfd88041f 59
group-Avnet 0:478cfd88041f 60 /* Definition for I2Cx's NVIC */
group-Avnet 0:478cfd88041f 61 #define I2Cx_EV_IRQn I2C1_EV_IRQn
group-Avnet 0:478cfd88041f 62 #define I2Cx_ER_IRQn I2C1_ER_IRQn
group-Avnet 0:478cfd88041f 63 #define I2Cx_EV_IRQHandler I2C1_EV_IRQHandler
group-Avnet 0:478cfd88041f 64 #define I2Cx_ER_IRQHandler I2C1_ER_IRQHandler
group-Avnet 0:478cfd88041f 65
group-Avnet 0:478cfd88041f 66
group-Avnet 0:478cfd88041f 67 #define I2Cx I2C1
group-Avnet 0:478cfd88041f 68 #define I2Cx_CLK_ENABLE() __I2C1_CLK_ENABLE()
group-Avnet 0:478cfd88041f 69 #define I2Cx_SDA_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE()
group-Avnet 0:478cfd88041f 70 #define I2Cx_SCL_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE()
group-Avnet 0:478cfd88041f 71
group-Avnet 0:478cfd88041f 72 #define I2Cx_FORCE_RESET() __I2C1_FORCE_RESET()
group-Avnet 0:478cfd88041f 73 #define I2Cx_RELEASE_RESET() __I2C1_RELEASE_RESET()
group-Avnet 0:478cfd88041f 74
group-Avnet 0:478cfd88041f 75 /* Definition for I2Cx Pins */
group-Avnet 0:478cfd88041f 76 #define I2Cx_SCL_PIN GPIO_PIN_8
group-Avnet 0:478cfd88041f 77 #define I2Cx_SCL_GPIO_PORT GPIOB
group-Avnet 0:478cfd88041f 78 #define I2Cx_SDA_PIN GPIO_PIN_9
group-Avnet 0:478cfd88041f 79 #define I2Cx_SDA_GPIO_PORT GPIOB
group-Avnet 0:478cfd88041f 80 #define I2Cx_SCL_SDA_AF GPIO_AF4_I2C1
group-Avnet 0:478cfd88041f 81
group-Avnet 0:478cfd88041f 82 /* Definition for I2Cx's NVIC */
group-Avnet 0:478cfd88041f 83 #define I2Cx_EV_IRQn I2C1_EV_IRQn
group-Avnet 0:478cfd88041f 84 #define I2Cx_ER_IRQn I2C1_ER_IRQn
group-Avnet 0:478cfd88041f 85 #define I2Cx_EV_IRQHandler I2C1_EV_IRQHandler
group-Avnet 0:478cfd88041f 86 #define I2Cx_ER_IRQHandler I2C1_ER_IRQHandler
group-Avnet 0:478cfd88041f 87
group-Avnet 0:478cfd88041f 88 /* User can use this section to tailor USARTx/UARTx instance used and associated
group-Avnet 0:478cfd88041f 89 resources */
group-Avnet 0:478cfd88041f 90 /* Definition for USARTx clock resources */
group-Avnet 0:478cfd88041f 91 #define USARTx USART2
group-Avnet 0:478cfd88041f 92 #define USARTx_CLK_ENABLE() __USART2_CLK_ENABLE();
group-Avnet 0:478cfd88041f 93 #define DMAx_CLK_ENABLE() __DMA1_CLK_ENABLE()
group-Avnet 0:478cfd88041f 94 #define USARTx_RX_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE()
group-Avnet 0:478cfd88041f 95 #define USARTx_TX_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE()
group-Avnet 0:478cfd88041f 96
group-Avnet 0:478cfd88041f 97 #define USARTx_FORCE_RESET() __USART2_FORCE_RESET()
group-Avnet 0:478cfd88041f 98 #define USARTx_RELEASE_RESET() __USART2_RELEASE_RESET()
group-Avnet 0:478cfd88041f 99
group-Avnet 0:478cfd88041f 100 /* Definition for USARTx Pins */
group-Avnet 0:478cfd88041f 101 #define USARTx_TX_PIN GPIO_PIN_2
group-Avnet 0:478cfd88041f 102 #define USARTx_TX_GPIO_PORT GPIOA
group-Avnet 0:478cfd88041f 103
group-Avnet 0:478cfd88041f 104 #define USARTx_RX_PIN GPIO_PIN_3
group-Avnet 0:478cfd88041f 105 #define USARTx_RX_GPIO_PORT GPIOA
group-Avnet 0:478cfd88041f 106
group-Avnet 0:478cfd88041f 107 /* Definition for USARTx's NVIC */
group-Avnet 0:478cfd88041f 108 #define USARTx_IRQn USART2_IRQn
group-Avnet 0:478cfd88041f 109 #define USARTx_IRQHandler USART2_IRQHandler
group-Avnet 0:478cfd88041f 110
group-Avnet 0:478cfd88041f 111 #define USARTx_TX_AF GPIO_AF7_USART2
group-Avnet 0:478cfd88041f 112 #define USARTx_RX_AF GPIO_AF7_USART2
group-Avnet 0:478cfd88041f 113
group-Avnet 0:478cfd88041f 114
group-Avnet 0:478cfd88041f 115 /* Enable sensor mask */
group-Avnet 0:478cfd88041f 116 #define PRESSURE_SENSOR 0x00000001
group-Avnet 0:478cfd88041f 117 #define TEMPERATURE_SENSOR 0x00000002
group-Avnet 0:478cfd88041f 118 #define HUMIDITY_SENSOR 0x00000004
group-Avnet 0:478cfd88041f 119 #define UV_SENSOR 0x00000008
group-Avnet 0:478cfd88041f 120 #define ACCELEROMETER_SENSOR 0x00000010
group-Avnet 0:478cfd88041f 121 #define GYROSCOPE_SENSOR 0x00000020
group-Avnet 0:478cfd88041f 122 #define MAGNETIC_SENSOR 0x00000040
group-Avnet 0:478cfd88041f 123 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 124 #endif /*__HW_CONFIG_H*/
group-Avnet 0:478cfd88041f 125 /*---------------------------------------------------------------------------*/