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 #!/bin/sh
group-Avnet 0:478cfd88041f 2 #
group-Avnet 0:478cfd88041f 3 # An example hook script to blocks unannotated tags from entering.
group-Avnet 0:478cfd88041f 4 # Called by "git receive-pack" with arguments: refname sha1-old sha1-new
group-Avnet 0:478cfd88041f 5 #
group-Avnet 0:478cfd88041f 6 # To enable this hook, rename this file to "update".
group-Avnet 0:478cfd88041f 7 #
group-Avnet 0:478cfd88041f 8 # Config
group-Avnet 0:478cfd88041f 9 # ------
group-Avnet 0:478cfd88041f 10 # hooks.allowunannotated
group-Avnet 0:478cfd88041f 11 # This boolean sets whether unannotated tags will be allowed into the
group-Avnet 0:478cfd88041f 12 # repository. By default they won't be.
group-Avnet 0:478cfd88041f 13 # hooks.allowdeletetag
group-Avnet 0:478cfd88041f 14 # This boolean sets whether deleting tags will be allowed in the
group-Avnet 0:478cfd88041f 15 # repository. By default they won't be.
group-Avnet 0:478cfd88041f 16 # hooks.allowmodifytag
group-Avnet 0:478cfd88041f 17 # This boolean sets whether a tag may be modified after creation. By default
group-Avnet 0:478cfd88041f 18 # it won't be.
group-Avnet 0:478cfd88041f 19 # hooks.allowdeletebranch
group-Avnet 0:478cfd88041f 20 # This boolean sets whether deleting branches will be allowed in the
group-Avnet 0:478cfd88041f 21 # repository. By default they won't be.
group-Avnet 0:478cfd88041f 22 # hooks.denycreatebranch
group-Avnet 0:478cfd88041f 23 # This boolean sets whether remotely creating branches will be denied
group-Avnet 0:478cfd88041f 24 # in the repository. By default this is allowed.
group-Avnet 0:478cfd88041f 25 #
group-Avnet 0:478cfd88041f 26
group-Avnet 0:478cfd88041f 27 # --- Command line
group-Avnet 0:478cfd88041f 28 refname="$1"
group-Avnet 0:478cfd88041f 29 oldrev="$2"
group-Avnet 0:478cfd88041f 30 newrev="$3"
group-Avnet 0:478cfd88041f 31
group-Avnet 0:478cfd88041f 32 # --- Safety check
group-Avnet 0:478cfd88041f 33 if [ -z "$GIT_DIR" ]; then
group-Avnet 0:478cfd88041f 34 echo "Don't run this script from the command line." >&2
group-Avnet 0:478cfd88041f 35 echo " (if you want, you could supply GIT_DIR then run" >&2
group-Avnet 0:478cfd88041f 36 echo " $0 <ref> <oldrev> <newrev>)" >&2
group-Avnet 0:478cfd88041f 37 exit 1
group-Avnet 0:478cfd88041f 38 fi
group-Avnet 0:478cfd88041f 39
group-Avnet 0:478cfd88041f 40 if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then
group-Avnet 0:478cfd88041f 41 echo "Usage: $0 <ref> <oldrev> <newrev>" >&2
group-Avnet 0:478cfd88041f 42 exit 1
group-Avnet 0:478cfd88041f 43 fi
group-Avnet 0:478cfd88041f 44
group-Avnet 0:478cfd88041f 45 # --- Config
group-Avnet 0:478cfd88041f 46 allowunannotated=$(git config --bool hooks.allowunannotated)
group-Avnet 0:478cfd88041f 47 allowdeletebranch=$(git config --bool hooks.allowdeletebranch)
group-Avnet 0:478cfd88041f 48 denycreatebranch=$(git config --bool hooks.denycreatebranch)
group-Avnet 0:478cfd88041f 49 allowdeletetag=$(git config --bool hooks.allowdeletetag)
group-Avnet 0:478cfd88041f 50 allowmodifytag=$(git config --bool hooks.allowmodifytag)
group-Avnet 0:478cfd88041f 51
group-Avnet 0:478cfd88041f 52 # check for no description
group-Avnet 0:478cfd88041f 53 projectdesc=$(sed -e '1q' "$GIT_DIR/description")
group-Avnet 0:478cfd88041f 54 case "$projectdesc" in
group-Avnet 0:478cfd88041f 55 "Unnamed repository"* | "")
group-Avnet 0:478cfd88041f 56 echo "*** Project description file hasn't been set" >&2
group-Avnet 0:478cfd88041f 57 exit 1
group-Avnet 0:478cfd88041f 58 ;;
group-Avnet 0:478cfd88041f 59 esac
group-Avnet 0:478cfd88041f 60
group-Avnet 0:478cfd88041f 61 # --- Check types
group-Avnet 0:478cfd88041f 62 # if $newrev is 0000...0000, it's a commit to delete a ref.
group-Avnet 0:478cfd88041f 63 zero="0000000000000000000000000000000000000000"
group-Avnet 0:478cfd88041f 64 if [ "$newrev" = "$zero" ]; then
group-Avnet 0:478cfd88041f 65 newrev_type=delete
group-Avnet 0:478cfd88041f 66 else
group-Avnet 0:478cfd88041f 67 newrev_type=$(git cat-file -t $newrev)
group-Avnet 0:478cfd88041f 68 fi
group-Avnet 0:478cfd88041f 69
group-Avnet 0:478cfd88041f 70 case "$refname","$newrev_type" in
group-Avnet 0:478cfd88041f 71 refs/tags/*,commit)
group-Avnet 0:478cfd88041f 72 # un-annotated tag
group-Avnet 0:478cfd88041f 73 short_refname=${refname##refs/tags/}
group-Avnet 0:478cfd88041f 74 if [ "$allowunannotated" != "true" ]; then
group-Avnet 0:478cfd88041f 75 echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2
group-Avnet 0:478cfd88041f 76 echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2
group-Avnet 0:478cfd88041f 77 exit 1
group-Avnet 0:478cfd88041f 78 fi
group-Avnet 0:478cfd88041f 79 ;;
group-Avnet 0:478cfd88041f 80 refs/tags/*,delete)
group-Avnet 0:478cfd88041f 81 # delete tag
group-Avnet 0:478cfd88041f 82 if [ "$allowdeletetag" != "true" ]; then
group-Avnet 0:478cfd88041f 83 echo "*** Deleting a tag is not allowed in this repository" >&2
group-Avnet 0:478cfd88041f 84 exit 1
group-Avnet 0:478cfd88041f 85 fi
group-Avnet 0:478cfd88041f 86 ;;
group-Avnet 0:478cfd88041f 87 refs/tags/*,tag)
group-Avnet 0:478cfd88041f 88 # annotated tag
group-Avnet 0:478cfd88041f 89 if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1
group-Avnet 0:478cfd88041f 90 then
group-Avnet 0:478cfd88041f 91 echo "*** Tag '$refname' already exists." >&2
group-Avnet 0:478cfd88041f 92 echo "*** Modifying a tag is not allowed in this repository." >&2
group-Avnet 0:478cfd88041f 93 exit 1
group-Avnet 0:478cfd88041f 94 fi
group-Avnet 0:478cfd88041f 95 ;;
group-Avnet 0:478cfd88041f 96 refs/heads/*,commit)
group-Avnet 0:478cfd88041f 97 # branch
group-Avnet 0:478cfd88041f 98 if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then
group-Avnet 0:478cfd88041f 99 echo "*** Creating a branch is not allowed in this repository" >&2
group-Avnet 0:478cfd88041f 100 exit 1
group-Avnet 0:478cfd88041f 101 fi
group-Avnet 0:478cfd88041f 102 ;;
group-Avnet 0:478cfd88041f 103 refs/heads/*,delete)
group-Avnet 0:478cfd88041f 104 # delete branch
group-Avnet 0:478cfd88041f 105 if [ "$allowdeletebranch" != "true" ]; then
group-Avnet 0:478cfd88041f 106 echo "*** Deleting a branch is not allowed in this repository" >&2
group-Avnet 0:478cfd88041f 107 exit 1
group-Avnet 0:478cfd88041f 108 fi
group-Avnet 0:478cfd88041f 109 ;;
group-Avnet 0:478cfd88041f 110 refs/remotes/*,commit)
group-Avnet 0:478cfd88041f 111 # tracking branch
group-Avnet 0:478cfd88041f 112 ;;
group-Avnet 0:478cfd88041f 113 refs/remotes/*,delete)
group-Avnet 0:478cfd88041f 114 # delete tracking branch
group-Avnet 0:478cfd88041f 115 if [ "$allowdeletebranch" != "true" ]; then
group-Avnet 0:478cfd88041f 116 echo "*** Deleting a tracking branch is not allowed in this repository" >&2
group-Avnet 0:478cfd88041f 117 exit 1
group-Avnet 0:478cfd88041f 118 fi
group-Avnet 0:478cfd88041f 119 ;;
group-Avnet 0:478cfd88041f 120 *)
group-Avnet 0:478cfd88041f 121 # Anything else (is there anything else?)
group-Avnet 0:478cfd88041f 122 echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2
group-Avnet 0:478cfd88041f 123 exit 1
group-Avnet 0:478cfd88041f 124 ;;
group-Avnet 0:478cfd88041f 125 esac
group-Avnet 0:478cfd88041f 126
group-Avnet 0:478cfd88041f 127 # --- Finished
group-Avnet 0:478cfd88041f 128 exit 0