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 * Copyright (c) 2014-2015 ARM Limited. All rights reserved.
group-Avnet 0:478cfd88041f 3 * SPDX-License-Identifier: Apache-2.0
group-Avnet 0:478cfd88041f 4 * Licensed under the Apache License, Version 2.0 (the License); you may
group-Avnet 0:478cfd88041f 5 * not use this file except in compliance with the License.
group-Avnet 0:478cfd88041f 6 * You may obtain a copy of the License at
group-Avnet 0:478cfd88041f 7 *
group-Avnet 0:478cfd88041f 8 * http://www.apache.org/licenses/LICENSE-2.0
group-Avnet 0:478cfd88041f 9 *
group-Avnet 0:478cfd88041f 10 * Unless required by applicable law or agreed to in writing, software
group-Avnet 0:478cfd88041f 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
group-Avnet 0:478cfd88041f 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-Avnet 0:478cfd88041f 13 * See the License for the specific language governing permissions and
group-Avnet 0:478cfd88041f 14 * limitations under the License.
group-Avnet 0:478cfd88041f 15 */
group-Avnet 0:478cfd88041f 16 #ifndef AT24MAC_H
group-Avnet 0:478cfd88041f 17 #define AT24MAC_H
group-Avnet 0:478cfd88041f 18
group-Avnet 0:478cfd88041f 19 #include "PinNames.h"
group-Avnet 0:478cfd88041f 20 #include "I2C.h"
group-Avnet 0:478cfd88041f 21
group-Avnet 0:478cfd88041f 22 /*
group-Avnet 0:478cfd88041f 23 * AT24MAC drivers.
group-Avnet 0:478cfd88041f 24 *
group-Avnet 0:478cfd88041f 25 * This is a EEPROM chip designed to contain factory programmed read-only EUI-64 or EUI-48,
group-Avnet 0:478cfd88041f 26 * a 128bit serial number and some user programmable EEPROM.
group-Avnet 0:478cfd88041f 27 *
group-Avnet 0:478cfd88041f 28 * AT24MAC602 contains EUI-64, use read_eui64()
group-Avnet 0:478cfd88041f 29 * AT24MAC402 contains EUI-64, use read_eui48()
group-Avnet 0:478cfd88041f 30 *
group-Avnet 0:478cfd88041f 31 * NOTE: You cannot use both EUI-64 and EUI-48. Chip contains only one of those.
group-Avnet 0:478cfd88041f 32 */
group-Avnet 0:478cfd88041f 33
group-Avnet 0:478cfd88041f 34 class AT24Mac {
group-Avnet 0:478cfd88041f 35 public:
group-Avnet 0:478cfd88041f 36 AT24Mac(PinName sda, PinName scl);
group-Avnet 0:478cfd88041f 37
group-Avnet 0:478cfd88041f 38 /**
group-Avnet 0:478cfd88041f 39 * Read unique serial number from chip.
group-Avnet 0:478cfd88041f 40 * \param buf pointer to write serial number to. Must have space for 16 bytes.
group-Avnet 0:478cfd88041f 41 * \return zero on success, negative number on failure
group-Avnet 0:478cfd88041f 42 */
group-Avnet 0:478cfd88041f 43 int read_serial(void *buf);
group-Avnet 0:478cfd88041f 44
group-Avnet 0:478cfd88041f 45 /**
group-Avnet 0:478cfd88041f 46 * Read EUI-64 from chip.
group-Avnet 0:478cfd88041f 47 * \param buf pointer to write EUI-64 to. Must have space for 8 bytes.
group-Avnet 0:478cfd88041f 48 * \return zero on success, negative number on failure
group-Avnet 0:478cfd88041f 49 */
group-Avnet 0:478cfd88041f 50 int read_eui64(void *buf);
group-Avnet 0:478cfd88041f 51
group-Avnet 0:478cfd88041f 52 /**
group-Avnet 0:478cfd88041f 53 * Read EUI-48 from chip.
group-Avnet 0:478cfd88041f 54 * \param buf pointer to write EUI-48 to. Must have space for 6 bytes.
group-Avnet 0:478cfd88041f 55 * \return zero on success, negative number on failure
group-Avnet 0:478cfd88041f 56 */
group-Avnet 0:478cfd88041f 57 int read_eui48(void *buf);
group-Avnet 0:478cfd88041f 58
group-Avnet 0:478cfd88041f 59 private:
group-Avnet 0:478cfd88041f 60 mbed::I2C _i2c;
group-Avnet 0:478cfd88041f 61 };
group-Avnet 0:478cfd88041f 62
group-Avnet 0:478cfd88041f 63 #endif /* AT24MAC_H */