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 BufferedSerial.h
group-Avnet 0:478cfd88041f 4 * @brief Software Buffer - Extends mbed Serial functionallity adding irq driven TX and RX
group-Avnet 0:478cfd88041f 5 * @author sam grove
group-Avnet 0:478cfd88041f 6 * @version 1.0
group-Avnet 0:478cfd88041f 7 * @see
group-Avnet 0:478cfd88041f 8 *
group-Avnet 0:478cfd88041f 9 * Copyright (c) 2013
group-Avnet 0:478cfd88041f 10 *
group-Avnet 0:478cfd88041f 11 * Licensed under the Apache License, Version 2.0 (the "License");
group-Avnet 0:478cfd88041f 12 * you may not use this file except in compliance with the License.
group-Avnet 0:478cfd88041f 13 * You may obtain a copy of the License at
group-Avnet 0:478cfd88041f 14 *
group-Avnet 0:478cfd88041f 15 * http://www.apache.org/licenses/LICENSE-2.0
group-Avnet 0:478cfd88041f 16 *
group-Avnet 0:478cfd88041f 17 * Unless required by applicable law or agreed to in writing, software
group-Avnet 0:478cfd88041f 18 * distributed under the License is distributed on an "AS IS" BASIS,
group-Avnet 0:478cfd88041f 19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-Avnet 0:478cfd88041f 20 * See the License for the specific language governing permissions and
group-Avnet 0:478cfd88041f 21 * limitations under the License.
group-Avnet 0:478cfd88041f 22 */
group-Avnet 0:478cfd88041f 23
group-Avnet 0:478cfd88041f 24 #ifndef BUFFEREDSERIAL_H
group-Avnet 0:478cfd88041f 25 #define BUFFEREDSERIAL_H
group-Avnet 0:478cfd88041f 26
group-Avnet 0:478cfd88041f 27 #include "mbed.h"
group-Avnet 0:478cfd88041f 28 #include "MyBuffer.h"
group-Avnet 0:478cfd88041f 29
group-Avnet 0:478cfd88041f 30 /** A serial port (UART) for communication with other serial devices
group-Avnet 0:478cfd88041f 31 *
group-Avnet 0:478cfd88041f 32 * Can be used for Full Duplex communication, or Simplex by specifying
group-Avnet 0:478cfd88041f 33 * one pin as NC (Not Connected)
group-Avnet 0:478cfd88041f 34 *
group-Avnet 0:478cfd88041f 35 * Example:
group-Avnet 0:478cfd88041f 36 * @code
group-Avnet 0:478cfd88041f 37 * #include "mbed.h"
group-Avnet 0:478cfd88041f 38 * #include "BufferedSerial.h"
group-Avnet 0:478cfd88041f 39 *
group-Avnet 0:478cfd88041f 40 * BufferedSerial pc(USBTX, USBRX);
group-Avnet 0:478cfd88041f 41 *
group-Avnet 0:478cfd88041f 42 * int main()
group-Avnet 0:478cfd88041f 43 * {
group-Avnet 0:478cfd88041f 44 * while(1)
group-Avnet 0:478cfd88041f 45 * {
group-Avnet 0:478cfd88041f 46 * Timer s;
group-Avnet 0:478cfd88041f 47 *
group-Avnet 0:478cfd88041f 48 * s.start();
group-Avnet 0:478cfd88041f 49 * pc.printf("Hello World - buffered\n");
group-Avnet 0:478cfd88041f 50 * int buffered_time = s.read_us();
group-Avnet 0:478cfd88041f 51 * wait(0.1f); // give time for the buffer to empty
group-Avnet 0:478cfd88041f 52 *
group-Avnet 0:478cfd88041f 53 * s.reset();
group-Avnet 0:478cfd88041f 54 * printf("Hello World - blocking\n");
group-Avnet 0:478cfd88041f 55 * int polled_time = s.read_us();
group-Avnet 0:478cfd88041f 56 * s.stop();
group-Avnet 0:478cfd88041f 57 * wait(0.1f); // give time for the buffer to empty
group-Avnet 0:478cfd88041f 58 *
group-Avnet 0:478cfd88041f 59 * pc.printf("printf buffered took %d us\n", buffered_time);
group-Avnet 0:478cfd88041f 60 * pc.printf("printf blocking took %d us\n", polled_time);
group-Avnet 0:478cfd88041f 61 * wait(0.5f);
group-Avnet 0:478cfd88041f 62 * }
group-Avnet 0:478cfd88041f 63 * }
group-Avnet 0:478cfd88041f 64 * @endcode
group-Avnet 0:478cfd88041f 65 */
group-Avnet 0:478cfd88041f 66
group-Avnet 0:478cfd88041f 67 /**
group-Avnet 0:478cfd88041f 68 * @class BufferedSerial
group-Avnet 0:478cfd88041f 69 * @brief Software buffers and interrupt driven tx and rx for Serial
group-Avnet 0:478cfd88041f 70 */
group-Avnet 0:478cfd88041f 71 class BufferedSerial : public RawSerial
group-Avnet 0:478cfd88041f 72 {
group-Avnet 0:478cfd88041f 73 private:
group-Avnet 0:478cfd88041f 74 MyBuffer <char> _rxbuf;
group-Avnet 0:478cfd88041f 75 MyBuffer <char> _txbuf;
group-Avnet 0:478cfd88041f 76 uint32_t _buf_size;
group-Avnet 0:478cfd88041f 77 uint32_t _tx_multiple;
group-Avnet 0:478cfd88041f 78
group-Avnet 0:478cfd88041f 79 void rxIrq(void);
group-Avnet 0:478cfd88041f 80 void txIrq(void);
group-Avnet 0:478cfd88041f 81 void prime(void);
group-Avnet 0:478cfd88041f 82
group-Avnet 0:478cfd88041f 83 Callback<void()> _cbs[2];
group-Avnet 0:478cfd88041f 84
group-Avnet 0:478cfd88041f 85 public:
group-Avnet 0:478cfd88041f 86 /** Create a BufferedSerial port, connected to the specified transmit and receive pins
group-Avnet 0:478cfd88041f 87 * @param tx Transmit pin
group-Avnet 0:478cfd88041f 88 * @param rx Receive pin
group-Avnet 0:478cfd88041f 89 * @param buf_size printf() buffer size
group-Avnet 0:478cfd88041f 90 * @param tx_multiple amount of max printf() present in the internal ring buffer at one time
group-Avnet 0:478cfd88041f 91 * @param name optional name
group-Avnet 0:478cfd88041f 92 * @note Either tx or rx may be specified as NC if unused
group-Avnet 0:478cfd88041f 93 */
group-Avnet 0:478cfd88041f 94 BufferedSerial(PinName tx, PinName rx, uint32_t buf_size = 256, uint32_t tx_multiple = 4,const char* name=NULL);
group-Avnet 0:478cfd88041f 95
group-Avnet 0:478cfd88041f 96 /** Destroy a BufferedSerial port
group-Avnet 0:478cfd88041f 97 */
group-Avnet 0:478cfd88041f 98 virtual ~BufferedSerial(void);
group-Avnet 0:478cfd88041f 99
group-Avnet 0:478cfd88041f 100 /** Check on how many bytes are in the rx buffer
group-Avnet 0:478cfd88041f 101 * @return 1 if something exists, 0 otherwise
group-Avnet 0:478cfd88041f 102 */
group-Avnet 0:478cfd88041f 103 virtual int readable(void);
group-Avnet 0:478cfd88041f 104
group-Avnet 0:478cfd88041f 105 /** Check to see if the tx buffer has room
group-Avnet 0:478cfd88041f 106 * @return 1 always has room and can overwrite previous content if too small / slow
group-Avnet 0:478cfd88041f 107 */
group-Avnet 0:478cfd88041f 108 virtual int writeable(void);
group-Avnet 0:478cfd88041f 109
group-Avnet 0:478cfd88041f 110 /** Get a single byte from the BufferedSerial Port.
group-Avnet 0:478cfd88041f 111 * Should check readable() before calling this.
group-Avnet 0:478cfd88041f 112 * @return A byte that came in on the Serial Port
group-Avnet 0:478cfd88041f 113 */
group-Avnet 0:478cfd88041f 114 virtual int getc(void);
group-Avnet 0:478cfd88041f 115
group-Avnet 0:478cfd88041f 116 /** Write a single byte to the BufferedSerial Port.
group-Avnet 0:478cfd88041f 117 * @param c The byte to write to the Serial Port
group-Avnet 0:478cfd88041f 118 * @return The byte that was written to the Serial Port Buffer
group-Avnet 0:478cfd88041f 119 */
group-Avnet 0:478cfd88041f 120 virtual int putc(int c);
group-Avnet 0:478cfd88041f 121
group-Avnet 0:478cfd88041f 122 /** Write a string to the BufferedSerial Port. Must be NULL terminated
group-Avnet 0:478cfd88041f 123 * @param s The string to write to the Serial Port
group-Avnet 0:478cfd88041f 124 * @return The number of bytes written to the Serial Port Buffer
group-Avnet 0:478cfd88041f 125 */
group-Avnet 0:478cfd88041f 126 virtual int puts(const char *s);
group-Avnet 0:478cfd88041f 127
group-Avnet 0:478cfd88041f 128 /** Write a formatted string to the BufferedSerial Port.
group-Avnet 0:478cfd88041f 129 * @param format The string + format specifiers to write to the Serial Port
group-Avnet 0:478cfd88041f 130 * @return The number of bytes written to the Serial Port Buffer
group-Avnet 0:478cfd88041f 131 */
group-Avnet 0:478cfd88041f 132 virtual int printf(const char* format, ...);
group-Avnet 0:478cfd88041f 133
group-Avnet 0:478cfd88041f 134 /** Write data to the Buffered Serial Port
group-Avnet 0:478cfd88041f 135 * @param s A pointer to data to send
group-Avnet 0:478cfd88041f 136 * @param length The amount of data being pointed to
group-Avnet 0:478cfd88041f 137 * @return The number of bytes written to the Serial Port Buffer
group-Avnet 0:478cfd88041f 138 */
group-Avnet 0:478cfd88041f 139 virtual ssize_t write(const void *s, std::size_t length);
group-Avnet 0:478cfd88041f 140
group-Avnet 0:478cfd88041f 141 /** Attach a function to call whenever a serial interrupt is generated
group-Avnet 0:478cfd88041f 142 * @param func A pointer to a void function, or 0 to set as none
group-Avnet 0:478cfd88041f 143 * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
group-Avnet 0:478cfd88041f 144 */
group-Avnet 0:478cfd88041f 145 virtual void attach(Callback<void()> func, IrqType type=RxIrq);
group-Avnet 0:478cfd88041f 146
group-Avnet 0:478cfd88041f 147 /** Attach a member function to call whenever a serial interrupt is generated
group-Avnet 0:478cfd88041f 148 * @param obj pointer to the object to call the member function on
group-Avnet 0:478cfd88041f 149 * @param method pointer to the member function to call
group-Avnet 0:478cfd88041f 150 * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
group-Avnet 0:478cfd88041f 151 */
group-Avnet 0:478cfd88041f 152 template <typename T>
group-Avnet 0:478cfd88041f 153 void attach(T *obj, void (T::*method)(), IrqType type=RxIrq) {
group-Avnet 0:478cfd88041f 154 attach(Callback<void()>(obj, method), type);
group-Avnet 0:478cfd88041f 155 }
group-Avnet 0:478cfd88041f 156
group-Avnet 0:478cfd88041f 157 /** Attach a member function to call whenever a serial interrupt is generated
group-Avnet 0:478cfd88041f 158 * @param obj pointer to the object to call the member function on
group-Avnet 0:478cfd88041f 159 * @param method pointer to the member function to call
group-Avnet 0:478cfd88041f 160 * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
group-Avnet 0:478cfd88041f 161 */
group-Avnet 0:478cfd88041f 162 template <typename T>
group-Avnet 0:478cfd88041f 163 void attach(T *obj, void (*method)(T*), IrqType type=RxIrq) {
group-Avnet 0:478cfd88041f 164 attach(Callback<void()>(obj, method), type);
group-Avnet 0:478cfd88041f 165 }
group-Avnet 0:478cfd88041f 166 };
group-Avnet 0:478cfd88041f 167
group-Avnet 0:478cfd88041f 168 #endif