Jan Korycan / WNCInterface

My fork

Dependencies:   WncControllerK64F

Fork of WNCInterface by Jan Korycan

README.md@0:55ec71dc0347, 2016-09-21 (annotated)

Committer:
JMF
Date:
Wed Sep 21 14:30:06 2016 +0000
Revision:
0:55ec71dc0347
Initial Commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JMF 0:55ec71dc0347 1 Interface Library
JMF 0:55ec71dc0347 2 ========================
JMF 0:55ec71dc0347 3
JMF 0:55ec71dc0347 4 The WDCInterface Library is an a C++ API for connecting to the Internet using a Wistron NeWeb Corporation (WNC) M14A2A
JMF 0:55ec71dc0347 5 Series data module. The WDCInterface library consists of a WDC Controller class, a collection of sockets, and an
JMF 0:55ec71dc0347 6 interface class. Collectively, these files creat an interface class that is used in the AT&T Cellular IoT Starter Kit
JMF 0:55ec71dc0347 7 which is sold by Avnet (http://cloudconnectkits.org/product/att-cellular-iot-starter-kit). This interface class library
JMF 0:55ec71dc0347 8 is a drop-in replacement for an EthernetInterface class.
JMF 0:55ec71dc0347 9
JMF 0:55ec71dc0347 10 Occasionally, the WNC Data Module will encounter internal failures that cause the device to cease communicating. To prevent
JMF 0:55ec71dc0347 11 the system from unexpectedly hanging, the WNCInterface class has implemented three user configuration settings as described
JMF 0:55ec71dc0347 12 below:
JMF 0:55ec71dc0347 13
JMF 0:55ec71dc0347 14 1. Configure the WNCInterface for (1) debug enabled OR (2) disabled. The default/current setting is debug enabled. When
JMF 0:55ec71dc0347 15 debug is enabled, it opens stdio over the USB using the OpenSDA (serial over USB running at 115200-N81).
JMF 0:55ec71dc0347 16
JMF 0:55ec71dc0347 17 2. Configure the WNCInterface to either (1) Hang by executing a 'while(true)' loop when the error occurs OR (2) Have the
JMF 0:55ec71dc0347 18 WNCInterface return a Failure (-1) for the current and all subsequent calls. The default/current setting is to
JMF 0:55ec71dc0347 19 Hange execution.
JMF 0:55ec71dc0347 20
JMF 0:55ec71dc0347 21 3. Configure the WNCInterface to either (1) Display the failure location to the debug port OR (2) display nothing when
JMF 0:55ec71dc0347 22 the error occurs. The default/current setting is to display the failure location.
JMF 0:55ec71dc0347 23
JMF 0:55ec71dc0347 24 To create the complete WNCInterface class, you must also install the WncController class. This is the hardware abstraction
JMF 0:55ec71dc0347 25 layer utilized by WNCInterface to communicate wiht the hardware. It is installed within the WNCInterface class from:
JMF 0:55ec71dc0347 26 https://developer.mbed.org/users/fkellermavnet/code/WncControllerK64F/
JMF 0:55ec71dc0347 27
JMF 0:55ec71dc0347 28 To demonstrate the use of the WDCInterface, a series of example programs have been developed. Links to these examples
JMF 0:55ec71dc0347 29 are provided below.
JMF 0:55ec71dc0347 30
JMF 0:55ec71dc0347 31 **NOTE**: This library/class is specific to the AT&T Cellular IoT Starter Kit which uses a FRDM-K64F. The users mbed.org
JMF 0:55ec71dc0347 32 compiler should be configured to use the FRDM-K64F platform.
JMF 0:55ec71dc0347 33
JMF 0:55ec71dc0347 34 Example Programs
JMF 0:55ec71dc0347 35 ================
JMF 0:55ec71dc0347 36
JMF 0:55ec71dc0347 37 Import the example programs below and follow the README.md in each to run the example program.
JMF 0:55ec71dc0347 38
JMF 0:55ec71dc0347 39 * https://github.com/jflynn129/WNCInterface_HTTP
JMF 0:55ec71dc0347 40 * https://github.com/jflynn129/WNCInterface_M2Xdemo
JMF 0:55ec71dc0347 41 * https://github.com/jflynn129/WNCInterface_M2XMQTTdemo
JMF 0:55ec71dc0347 42 * https://github.com/jflynn129/WNCInterface_MQTT_hivemq
JMF 0:55ec71dc0347 43
JMF 0:55ec71dc0347 44 WNC FIRWARE VERSION
JMF 0:55ec71dc0347 45 ===================
JMF 0:55ec71dc0347 46
JMF 0:55ec71dc0347 47 The WNCInterface class currently supports the following version(s):
JMF 0:55ec71dc0347 48 * MPSS: M14A2A_v11.21.162331 APSS: M14A2A_v11.27.162331
JMF 0:55ec71dc0347 49
JMF 0:55ec71dc0347 50
JMF 0:55ec71dc0347 51 License
JMF 0:55ec71dc0347 52 =======
JMF 0:55ec71dc0347 53 This library is released under the Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
JMF 0:55ec71dc0347 54 file except in compliance with the License and may obtain a copy of the License at
JMF 0:55ec71dc0347 55
JMF 0:55ec71dc0347 56 http://www.apache.org/licenses/LICENSE-2.0
JMF 0:55ec71dc0347 57
JMF 0:55ec71dc0347 58 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
JMF 0:55ec71dc0347 59 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
JMF 0:55ec71dc0347 60 language governing permissions and limitations under the License.
JMF 0:55ec71dc0347 61