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/contiki-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 Contiki 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 #ifndef __CONTIKI_CONF_H__
group-Avnet 0:478cfd88041f 39 #define __CONTIKI_CONF_H__
group-Avnet 0:478cfd88041f 40 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 41 #include "platform-conf.h"
group-Avnet 0:478cfd88041f 42 //#include "project-conf.h"
group-Avnet 0:478cfd88041f 43 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 44 #define SLIP_BRIDGE_CONF_NO_PUTCHAR 1
group-Avnet 0:478cfd88041f 45
group-Avnet 0:478cfd88041f 46 #define NETSTACK_CONF_RDC_CHANNEL_CHECK_RATE 8
group-Avnet 0:478cfd88041f 47 #define NULLRDC_CONF_802154_AUTOACK 0
group-Avnet 0:478cfd88041f 48 #define NETSTACK_CONF_FRAMER framer_802154
group-Avnet 0:478cfd88041f 49 #define NETSTACK_CONF_NETWORK sicslowpan_driver
group-Avnet 0:478cfd88041f 50
group-Avnet 0:478cfd88041f 51 #undef NETSTACK_CONF_RDC
group-Avnet 0:478cfd88041f 52 #define NETSTACK_CONF_RDC nullrdc_driver
group-Avnet 0:478cfd88041f 53 #define NETSTACK_RDC_HEADER_LEN 0
group-Avnet 0:478cfd88041f 54
group-Avnet 0:478cfd88041f 55 #undef NETSTACK_CONF_MAC
group-Avnet 0:478cfd88041f 56 #define NETSTACK_CONF_MAC csma_driver
group-Avnet 0:478cfd88041f 57 #define NETSTACK_MAC_HEADER_LEN 0
group-Avnet 0:478cfd88041f 58
group-Avnet 0:478cfd88041f 59 #define SICSLOWPAN_CONF_MAC_MAX_PAYLOAD \
group-Avnet 0:478cfd88041f 60 (NETSTACK_RADIO_MAX_PAYLOAD_LEN - NETSTACK_MAC_HEADER_LEN - \
group-Avnet 0:478cfd88041f 61 NETSTACK_RDC_HEADER_LEN )
group-Avnet 0:478cfd88041f 62
group-Avnet 0:478cfd88041f 63 #define RIMESTATS_CONF_ENABLED 0
group-Avnet 0:478cfd88041f 64 #define RIMESTATS_CONF_ON 0
group-Avnet 0:478cfd88041f 65
group-Avnet 0:478cfd88041f 66
group-Avnet 0:478cfd88041f 67 /* Network setup for IPv6 */
group-Avnet 0:478cfd88041f 68
group-Avnet 0:478cfd88041f 69 #define CXMAC_CONF_ANNOUNCEMENTS 0
group-Avnet 0:478cfd88041f 70
group-Avnet 0:478cfd88041f 71
group-Avnet 0:478cfd88041f 72 /* A trick to resolve a compilation error with IAR. */
group-Avnet 0:478cfd88041f 73 #ifdef __ICCARM__
group-Avnet 0:478cfd88041f 74 #define UIP_CONF_DS6_AADDR_NBU 1
group-Avnet 0:478cfd88041f 75 #endif
group-Avnet 0:478cfd88041f 76
group-Avnet 0:478cfd88041f 77 /* radio driver blocks until ACK is received */
group-Avnet 0:478cfd88041f 78 #define NULLRDC_CONF_ACK_WAIT_TIME (0)
group-Avnet 0:478cfd88041f 79 #define CONTIKIMAC_CONF_BROADCAST_RATE_LIMIT 0
group-Avnet 0:478cfd88041f 80 #define IEEE802154_CONF_PANID 0xABCD
group-Avnet 0:478cfd88041f 81
group-Avnet 0:478cfd88041f 82 #define AODV_COMPLIANCE
group-Avnet 0:478cfd88041f 83
group-Avnet 0:478cfd88041f 84 #define WITH_ASCII 1
group-Avnet 0:478cfd88041f 85
group-Avnet 0:478cfd88041f 86 #define PROCESS_CONF_NUMEVENTS 8
group-Avnet 0:478cfd88041f 87 #define PROCESS_CONF_STATS 1
group-Avnet 0:478cfd88041f 88 /*#define PROCESS_CONF_FASTPOLL 4*/
group-Avnet 0:478cfd88041f 89
group-Avnet 0:478cfd88041f 90
group-Avnet 0:478cfd88041f 91 #define LINKADDR_CONF_SIZE 8
group-Avnet 0:478cfd88041f 92
group-Avnet 0:478cfd88041f 93 #define UIP_CONF_LL_802154 1
group-Avnet 0:478cfd88041f 94 #define UIP_CONF_LLH_LEN 0
group-Avnet 0:478cfd88041f 95
group-Avnet 0:478cfd88041f 96 #define UIP_CONF_ROUTER 1
group-Avnet 0:478cfd88041f 97
group-Avnet 0:478cfd88041f 98 /* configure number of neighbors and routes */
group-Avnet 0:478cfd88041f 99 #ifndef UIP_CONF_DS6_ROUTE_NBU
group-Avnet 0:478cfd88041f 100 #define UIP_CONF_DS6_ROUTE_NBU 30
group-Avnet 0:478cfd88041f 101 #endif /* UIP_CONF_DS6_ROUTE_NBU */
group-Avnet 0:478cfd88041f 102
group-Avnet 0:478cfd88041f 103 #ifndef UIP_CONF_ND6_SEND_RA
group-Avnet 0:478cfd88041f 104 #define UIP_CONF_ND6_SEND_RA 0
group-Avnet 0:478cfd88041f 105 #endif
group-Avnet 0:478cfd88041f 106 #define UIP_CONF_ND6_REACHABLE_TIME 600000 //90000// 600000
group-Avnet 0:478cfd88041f 107 #define UIP_CONF_ND6_RETRANS_TIMER 10000
group-Avnet 0:478cfd88041f 108
group-Avnet 0:478cfd88041f 109
group-Avnet 0:478cfd88041f 110 #define UIP_CONF_IPV6 1
group-Avnet 0:478cfd88041f 111 #ifndef UIP_CONF_IPV6_QUEUE_PKT
group-Avnet 0:478cfd88041f 112 #define UIP_CONF_IPV6_QUEUE_PKT 0
group-Avnet 0:478cfd88041f 113 #endif /* UIP_CONF_IPV6_QUEUE_PKT */
group-Avnet 0:478cfd88041f 114 #define UIP_CONF_IP_FORWARD 0
group-Avnet 0:478cfd88041f 115 #ifndef UIP_CONF_BUFFER_SIZE
group-Avnet 0:478cfd88041f 116 //#define UIP_CONF_BUFFER_SIZE 280
group-Avnet 0:478cfd88041f 117 #define UIP_CONF_BUFFER_SIZE 600
group-Avnet 0:478cfd88041f 118 #endif
group-Avnet 0:478cfd88041f 119
group-Avnet 0:478cfd88041f 120 #define SICSLOWPAN_CONF_MAXAGE 4
group-Avnet 0:478cfd88041f 121 #define SICSLOWPAN_CONF_MAX_ADDR_CONTEXTS 2
group-Avnet 0:478cfd88041f 122
group-Avnet 0:478cfd88041f 123
group-Avnet 0:478cfd88041f 124 #ifndef SICSLOWPAN_CONF_MAX_MAC_TRANSMISSIONS
group-Avnet 0:478cfd88041f 125 #define SICSLOWPAN_CONF_MAX_MAC_TRANSMISSIONS 5
group-Avnet 0:478cfd88041f 126 #endif /* SICSLOWPAN_CONF_MAX_MAC_TRANSMISSIONS */
group-Avnet 0:478cfd88041f 127
group-Avnet 0:478cfd88041f 128 #define UIP_CONF_ICMP_DEST_UNREACH 1
group-Avnet 0:478cfd88041f 129
group-Avnet 0:478cfd88041f 130 #define UIP_CONF_DHCP_LIGHT
group-Avnet 0:478cfd88041f 131 #define UIP_CONF_LLH_LEN 0
group-Avnet 0:478cfd88041f 132 #ifndef UIP_CONF_RECEIVE_WINDOW
group-Avnet 0:478cfd88041f 133 #define UIP_CONF_RECEIVE_WINDOW 150
group-Avnet 0:478cfd88041f 134 #endif
group-Avnet 0:478cfd88041f 135 #ifndef UIP_CONF_TCP_MSS
group-Avnet 0:478cfd88041f 136 #define UIP_CONF_TCP_MSS UIP_CONF_RECEIVE_WINDOW
group-Avnet 0:478cfd88041f 137 #endif
group-Avnet 0:478cfd88041f 138 #define UIP_CONF_MAX_CONNECTIONS 4
group-Avnet 0:478cfd88041f 139 #define UIP_CONF_MAX_LISTENPORTS 8
group-Avnet 0:478cfd88041f 140 #define UIP_CONF_UDP_CONNS 12
group-Avnet 0:478cfd88041f 141 #define UIP_CONF_FWCACHE_SIZE 30
group-Avnet 0:478cfd88041f 142 #define UIP_CONF_BROADCAST 1
group-Avnet 0:478cfd88041f 143 #define UIP_ARCH_IPCHKSUM 0
group-Avnet 0:478cfd88041f 144 #define UIP_CONF_UDP 1
group-Avnet 0:478cfd88041f 145 #define UIP_CONF_UDP_CHECKSUMS 1
group-Avnet 0:478cfd88041f 146 #define UIP_CONF_TCP 1
group-Avnet 0:478cfd88041f 147 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 148 /* include the project config */
group-Avnet 0:478cfd88041f 149 /* PROJECT_CONF_H might be defined in the project Makefile */
group-Avnet 0:478cfd88041f 150 #ifdef PROJECT_CONF_H
group-Avnet 0:478cfd88041f 151 #include "project-conf.h"
group-Avnet 0:478cfd88041f 152 #endif /* PROJECT_CONF_H */
group-Avnet 0:478cfd88041f 153 /*---------------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 154 #endif /* CONTIKI_CONF_H */
group-Avnet 0:478cfd88041f 155 /*---------------------------------------------------------------------------*/