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 #ifndef NANOSTACK_RF_PHY_SPIRIT1_H_
group-Avnet 0:478cfd88041f 2 #define NANOSTACK_RF_PHY_SPIRIT1_H_
group-Avnet 0:478cfd88041f 3
group-Avnet 0:478cfd88041f 4 #include <stdint.h>
group-Avnet 0:478cfd88041f 5
group-Avnet 0:478cfd88041f 6 #include "NanostackRfPhy.h"
group-Avnet 0:478cfd88041f 7 #include "PinNames.h"
group-Avnet 0:478cfd88041f 8
group-Avnet 0:478cfd88041f 9 // Arduino pin defaults for convenience
group-Avnet 0:478cfd88041f 10 #if !defined(SPIRIT1_SPI_MOSI)
group-Avnet 0:478cfd88041f 11 #define SPIRIT1_SPI_MOSI D11
group-Avnet 0:478cfd88041f 12 #endif
group-Avnet 0:478cfd88041f 13 #if !defined(SPIRIT1_SPI_MISO)
group-Avnet 0:478cfd88041f 14 #define SPIRIT1_SPI_MISO D12
group-Avnet 0:478cfd88041f 15 #endif
group-Avnet 0:478cfd88041f 16 #if !defined(SPIRIT1_SPI_SCLK)
group-Avnet 0:478cfd88041f 17 #define SPIRIT1_SPI_SCLK D13
group-Avnet 0:478cfd88041f 18 #endif
group-Avnet 0:478cfd88041f 19 #if !defined(SPIRIT1_DEV_IRQ)
group-Avnet 0:478cfd88041f 20 #define SPIRIT1_DEV_IRQ D9
group-Avnet 0:478cfd88041f 21 #endif
group-Avnet 0:478cfd88041f 22 #if !defined(SPIRIT1_DEV_CS)
group-Avnet 0:478cfd88041f 23 #define SPIRIT1_DEV_CS D10
group-Avnet 0:478cfd88041f 24 #endif
group-Avnet 0:478cfd88041f 25 #if !defined(SPIRIT1_DEV_SDN)
group-Avnet 0:478cfd88041f 26 #define SPIRIT1_DEV_SDN D2
group-Avnet 0:478cfd88041f 27 #endif
group-Avnet 0:478cfd88041f 28 #if !defined(SPIRIT1_BRD_LED)
group-Avnet 0:478cfd88041f 29 #define SPIRIT1_BRD_LED NC
group-Avnet 0:478cfd88041f 30 #endif
group-Avnet 0:478cfd88041f 31
group-Avnet 0:478cfd88041f 32 class NanostackRfPhySpirit1 : public NanostackRfPhy {
group-Avnet 0:478cfd88041f 33 public:
group-Avnet 0:478cfd88041f 34 NanostackRfPhySpirit1(PinName spi_mosi, PinName spi_miso, PinName spi_sclk,
group-Avnet 0:478cfd88041f 35 PinName dev_irq, PinName dev_cs, PinName dev_sdn, PinName brd_led);
group-Avnet 0:478cfd88041f 36 ~NanostackRfPhySpirit1();
group-Avnet 0:478cfd88041f 37 int8_t rf_register();
group-Avnet 0:478cfd88041f 38 void rf_unregister();
group-Avnet 0:478cfd88041f 39 void get_mac_address(uint8_t *mac);
group-Avnet 0:478cfd88041f 40 void set_mac_address(uint8_t *mac);
group-Avnet 0:478cfd88041f 41
group-Avnet 0:478cfd88041f 42 private:
group-Avnet 0:478cfd88041f 43 void rf_init(void);
group-Avnet 0:478cfd88041f 44
group-Avnet 0:478cfd88041f 45 const PinName _spi_mosi;
group-Avnet 0:478cfd88041f 46 const PinName _spi_miso;
group-Avnet 0:478cfd88041f 47 const PinName _spi_sclk;
group-Avnet 0:478cfd88041f 48 const PinName _dev_irq;
group-Avnet 0:478cfd88041f 49 const PinName _dev_cs;
group-Avnet 0:478cfd88041f 50 const PinName _dev_sdn;
group-Avnet 0:478cfd88041f 51 const PinName _brd_led;
group-Avnet 0:478cfd88041f 52 };
group-Avnet 0:478cfd88041f 53
group-Avnet 0:478cfd88041f 54 #endif /* NANOSTACK_RF_PHY_SPIRIT1_H_ */