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_PktMbus.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 MBUS packets.
group-Avnet 0:478cfd88041f 8 *
group-Avnet 0:478cfd88041f 9 * @details
group-Avnet 0:478cfd88041f 10 *
group-Avnet 0:478cfd88041f 11 * This module can be used to manage the configuration of Spirit MBUS
group-Avnet 0:478cfd88041f 12 * packets.
group-Avnet 0:478cfd88041f 13 * The user can obtain a packet configuration filling the structure
group-Avnet 0:478cfd88041f 14 * <i>@ref PktMbusInit</i>, defining in it some general parameters
group-Avnet 0:478cfd88041f 15 * for the Spirit MBUS packet format.
group-Avnet 0:478cfd88041f 16 * Since the MBUS protocol is a standard, the configuration of a MBUS
group-Avnet 0:478cfd88041f 17 * packet is very simple to do.
group-Avnet 0:478cfd88041f 18 *
group-Avnet 0:478cfd88041f 19 * <b>Example:</b>
group-Avnet 0:478cfd88041f 20 * @code
group-Avnet 0:478cfd88041f 21 *
group-Avnet 0:478cfd88041f 22 * PktMbusInit mbusInit={
group-Avnet 0:478cfd88041f 23 * MBUS_SUBMODE_S1_S2_LONG_HEADER, // MBUS submode selection
group-Avnet 0:478cfd88041f 24 * 36, // added "01" chips on preamble
group-Avnet 0:478cfd88041f 25 * 16 // postamble length in "01" chips
group-Avnet 0:478cfd88041f 26 * };
group-Avnet 0:478cfd88041f 27 *
group-Avnet 0:478cfd88041f 28 * ...
group-Avnet 0:478cfd88041f 29 *
group-Avnet 0:478cfd88041f 30 * SpiritPktMbusInit(&mbusInit);
group-Avnet 0:478cfd88041f 31 *
group-Avnet 0:478cfd88041f 32 * ...
group-Avnet 0:478cfd88041f 33 *
group-Avnet 0:478cfd88041f 34 * @endcode
group-Avnet 0:478cfd88041f 35 *
group-Avnet 0:478cfd88041f 36 * The module provides some other functions that can be used to modify
group-Avnet 0:478cfd88041f 37 * or read only some configuration parameters.
group-Avnet 0:478cfd88041f 38 *
group-Avnet 0:478cfd88041f 39 *
group-Avnet 0:478cfd88041f 40 * @attention
group-Avnet 0:478cfd88041f 41 *
group-Avnet 0:478cfd88041f 42 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
group-Avnet 0:478cfd88041f 43 *
group-Avnet 0:478cfd88041f 44 * Redistribution and use in source and binary forms, with or without modification,
group-Avnet 0:478cfd88041f 45 * are permitted provided that the following conditions are met:
group-Avnet 0:478cfd88041f 46 * 1. Redistributions of source code must retain the above copyright notice,
group-Avnet 0:478cfd88041f 47 * this list of conditions and the following disclaimer.
group-Avnet 0:478cfd88041f 48 * 2. Redistributions in binary form must reproduce the above copyright notice,
group-Avnet 0:478cfd88041f 49 * this list of conditions and the following disclaimer in the documentation
group-Avnet 0:478cfd88041f 50 * and/or other materials provided with the distribution.
group-Avnet 0:478cfd88041f 51 * 3. Neither the name of STMicroelectronics nor the names of its contributors
group-Avnet 0:478cfd88041f 52 * may be used to endorse or promote products derived from this software
group-Avnet 0:478cfd88041f 53 * without specific prior written permission.
group-Avnet 0:478cfd88041f 54 *
group-Avnet 0:478cfd88041f 55 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
group-Avnet 0:478cfd88041f 56 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
group-Avnet 0:478cfd88041f 57 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-Avnet 0:478cfd88041f 58 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
group-Avnet 0:478cfd88041f 59 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
group-Avnet 0:478cfd88041f 60 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
group-Avnet 0:478cfd88041f 61 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
group-Avnet 0:478cfd88041f 62 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
group-Avnet 0:478cfd88041f 63 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
group-Avnet 0:478cfd88041f 64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-Avnet 0:478cfd88041f 65 *
group-Avnet 0:478cfd88041f 66 ******************************************************************************
group-Avnet 0:478cfd88041f 67 */
group-Avnet 0:478cfd88041f 68
group-Avnet 0:478cfd88041f 69 /* Define to prevent recursive inclusion -------------------------------------*/
group-Avnet 0:478cfd88041f 70 #ifndef __SPIRIT_PACKET_MBUS_H
group-Avnet 0:478cfd88041f 71 #define __SPIRIT_PACKET_MBUS_H
group-Avnet 0:478cfd88041f 72
group-Avnet 0:478cfd88041f 73
group-Avnet 0:478cfd88041f 74
group-Avnet 0:478cfd88041f 75 /* Includes ------------------------------------------------------------------*/
group-Avnet 0:478cfd88041f 76
group-Avnet 0:478cfd88041f 77 #include "SPIRIT_Regs.h"
group-Avnet 0:478cfd88041f 78 #include "SPIRIT_Types.h"
group-Avnet 0:478cfd88041f 79 #include "SPIRIT_PktCommon.h"
group-Avnet 0:478cfd88041f 80
group-Avnet 0:478cfd88041f 81 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 82 extern "C" {
group-Avnet 0:478cfd88041f 83 #endif
group-Avnet 0:478cfd88041f 84
group-Avnet 0:478cfd88041f 85
group-Avnet 0:478cfd88041f 86
group-Avnet 0:478cfd88041f 87 /**
group-Avnet 0:478cfd88041f 88 * @addtogroup SPIRIT_Libraries
group-Avnet 0:478cfd88041f 89 * @{
group-Avnet 0:478cfd88041f 90 */
group-Avnet 0:478cfd88041f 91
group-Avnet 0:478cfd88041f 92
group-Avnet 0:478cfd88041f 93 /**
group-Avnet 0:478cfd88041f 94 * @defgroup SPIRIT_PktMbus Pkt MBUS
group-Avnet 0:478cfd88041f 95 * @brief Configuration and management of SPIRIT MBUS packets.
group-Avnet 0:478cfd88041f 96 * @details See the file <i>@ref SPIRIT_PktMbus.h</i> for more details.
group-Avnet 0:478cfd88041f 97 * @{
group-Avnet 0:478cfd88041f 98 */
group-Avnet 0:478cfd88041f 99
group-Avnet 0:478cfd88041f 100 /**
group-Avnet 0:478cfd88041f 101 * @defgroup PktMbus_Exported_Types Pkt MBUS Exported Types
group-Avnet 0:478cfd88041f 102 * @{
group-Avnet 0:478cfd88041f 103 */
group-Avnet 0:478cfd88041f 104
group-Avnet 0:478cfd88041f 105
group-Avnet 0:478cfd88041f 106
group-Avnet 0:478cfd88041f 107 /**
group-Avnet 0:478cfd88041f 108 * @brief MBUS submode enumeration.
group-Avnet 0:478cfd88041f 109 */
group-Avnet 0:478cfd88041f 110
group-Avnet 0:478cfd88041f 111 typedef enum
group-Avnet 0:478cfd88041f 112 {
group-Avnet 0:478cfd88041f 113 MBUS_SUBMODE_S1_S2_LONG_HEADER = MBUS_CTRL_MBUS_SUBMODE_S1_S2L, /*!< MBUS submode S1, S2 (long header) - Header length = mbus_prmbl_ctrl + 279 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits) */
group-Avnet 0:478cfd88041f 114 MBUS_SUBMODE_S1_M_S2_T2_OTHER_TO_METER = MBUS_CTRL_MBUS_SUBMODE_S2_S1M_T2_OTHER, /*!< MBUS submode S1-m, S2, T2 (other to meter) - Header length = mbus_prmbl_ctrl + 15 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits)*/
group-Avnet 0:478cfd88041f 115 MBUS_SUBMODE_T1_T2_METER_TO_OTHER = MBUS_CTRL_MBUS_SUBMODE_T1_T2_METER, /*!< MBUS submode T1, T2 (meter to other) - Header length = mbus_prmbl_ctrl + 19 (in "01" bit pairs) , Sync word = 0x3D (length 10 bits)*/
group-Avnet 0:478cfd88041f 116 MBUS_SUBMODE_R2_SHORT_HEADER = MBUS_CTRL_MBUS_SUBMODE_R2, /*!< MBUS submode R2, short header - Header length = mbus_prmbl_ctrl + 39 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits)*/
group-Avnet 0:478cfd88041f 117
group-Avnet 0:478cfd88041f 118 }MbusSubmode;
group-Avnet 0:478cfd88041f 119
group-Avnet 0:478cfd88041f 120 #define IS_MBUS_SUBMODE(MODE) (((MODE) == MBUS_SUBMODE_S1_S2_LONG_HEADER) || \
group-Avnet 0:478cfd88041f 121 ((MODE) == MBUS_SUBMODE_S1_M_S2_T2_OTHER_TO_METER) || \
group-Avnet 0:478cfd88041f 122 ((MODE) == MBUS_SUBMODE_T1_T2_METER_TO_OTHER) || \
group-Avnet 0:478cfd88041f 123 ((MODE) == MBUS_SUBMODE_R2_SHORT_HEADER))
group-Avnet 0:478cfd88041f 124
group-Avnet 0:478cfd88041f 125
group-Avnet 0:478cfd88041f 126 /**
group-Avnet 0:478cfd88041f 127 * @brief SPIRIT MBUS Packet Init structure definition
group-Avnet 0:478cfd88041f 128 */
group-Avnet 0:478cfd88041f 129 typedef struct
group-Avnet 0:478cfd88041f 130 {
group-Avnet 0:478cfd88041f 131 MbusSubmode xMbusSubmode; /*!< Specifies the SUBMODE to be configured.
group-Avnet 0:478cfd88041f 132 This parameter can be a value of @ref MbusSubmode */
group-Avnet 0:478cfd88041f 133
group-Avnet 0:478cfd88041f 134 uint8_t cPreambleLength; /*!< Specifies the PREAMBLE length.
group-Avnet 0:478cfd88041f 135 This parameter can be any value between 0 and 255 chip sequence '01' */
group-Avnet 0:478cfd88041f 136
group-Avnet 0:478cfd88041f 137 uint8_t cPostambleLength; /*!< Specifies the POSTAMBLE length.
group-Avnet 0:478cfd88041f 138 This parameter can be any value between 0 and 255 chip sequence '01' */
group-Avnet 0:478cfd88041f 139
group-Avnet 0:478cfd88041f 140 }PktMbusInit;
group-Avnet 0:478cfd88041f 141
group-Avnet 0:478cfd88041f 142 /**
group-Avnet 0:478cfd88041f 143 *@}
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 * @defgroup PktMbus_Exported_Constants Pkt MBUS Exported Constants
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 * @defgroup PktMbus_Exported_Macros Pkt MBUS Exported Macros
group-Avnet 0:478cfd88041f 160 * @{
group-Avnet 0:478cfd88041f 161 */
group-Avnet 0:478cfd88041f 162
group-Avnet 0:478cfd88041f 163
group-Avnet 0:478cfd88041f 164 /**
group-Avnet 0:478cfd88041f 165 *@}
group-Avnet 0:478cfd88041f 166 */
group-Avnet 0:478cfd88041f 167
group-Avnet 0:478cfd88041f 168
group-Avnet 0:478cfd88041f 169 /**
group-Avnet 0:478cfd88041f 170 * @defgroup PktMbus_Exported_Functions Pkt MBUS Exported Functions
group-Avnet 0:478cfd88041f 171 * @{
group-Avnet 0:478cfd88041f 172 */
group-Avnet 0:478cfd88041f 173 void SpiritPktMbusInit(PktMbusInit* pxPktMbusInit);
group-Avnet 0:478cfd88041f 174 void SpiritPktMbusGetInfo(PktMbusInit* pxPktMbusInit);
group-Avnet 0:478cfd88041f 175 void SpiritPktMbusSetFormat(void);
group-Avnet 0:478cfd88041f 176 void SpiritPktMbusSetPreamble(uint8_t cPreamble);
group-Avnet 0:478cfd88041f 177 uint8_t SpiritPktMbusGetPreamble(void);
group-Avnet 0:478cfd88041f 178 void SpiritPktMbusSetPostamble(uint8_t cPostamble);
group-Avnet 0:478cfd88041f 179 uint8_t SpiritPktMbusGetPostamble(void);
group-Avnet 0:478cfd88041f 180 void SpiritPktMbusSetSubmode(MbusSubmode xMbusSubmode);
group-Avnet 0:478cfd88041f 181 MbusSubmode SpiritPktMbusGetSubmode(void);
group-Avnet 0:478cfd88041f 182 void SpiritPktMbusSetPayloadLength(uint16_t nPayloadLength);
group-Avnet 0:478cfd88041f 183 uint16_t SpiritPktMbusGetPayloadLength(void);
group-Avnet 0:478cfd88041f 184
group-Avnet 0:478cfd88041f 185
group-Avnet 0:478cfd88041f 186 /**
group-Avnet 0:478cfd88041f 187 *@}
group-Avnet 0:478cfd88041f 188 */
group-Avnet 0:478cfd88041f 189
group-Avnet 0:478cfd88041f 190 /**
group-Avnet 0:478cfd88041f 191 *@}
group-Avnet 0:478cfd88041f 192 */
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 */
group-Avnet 0:478cfd88041f 198
group-Avnet 0:478cfd88041f 199
group-Avnet 0:478cfd88041f 200 #ifdef __cplusplus
group-Avnet 0:478cfd88041f 201 }
group-Avnet 0:478cfd88041f 202 #endif
group-Avnet 0:478cfd88041f 203
group-Avnet 0:478cfd88041f 204 #endif
group-Avnet 0:478cfd88041f 205
group-Avnet 0:478cfd88041f 206 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/