Diff: platform/ezconnect/README.md

Revision:

0:082731ede69f

diff -r 000000000000 -r 082731ede69f platform/ezconnect/README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/platform/ezconnect/README.md	Wed May 30 20:59:51 2018 +0000
@@ -0,0 +1,69 @@
+# EZ Connect - A derivative of ARM's Easy-Connect to easily add supported for Avnet connectivity solutions to your mbed OS project
+
+
+Give your application the ability to switch between connectivity methods. The NetworkInterface API makes this easy, but you need a mechanism for the user to chooce the method. EZ Connect handles all of this for you. Just declare the desired connectivity method in the mbed_app.json file and call easy_connect() from your application.
+
+## Specifying the connectivity method
+
+Add the following to your `mbed_app.json` file:
+
+```json
+{
+    "config": {
+        "network-interface":{
+            "help": "options are ETHERNET, CELLULAR_WNC14A2A, CELLULAR_BG96",
+            "value": "ETHERNET"
+        }
+    }
+}
+```
+
+
+## Using EZ Connect from your application
+
+EZ Connect has just one function that returns either a `NetworkInterface`-pointer or `NULL`:
+
+```cpp
+#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
+}
+```
+## BG96 overrides
+If you need to change the pins used by the BG96 driver, you can enter the following into your `mbed_app.json`:
+
+```json
+    "target_overrides": {
+        "*": {
+            "platform.bg96-library.bg96-tx": "D8",
+            "platform.bg96-library.bg96-rx": "D2",
+            "platform.bg96-library.bg96-reset": "D7",
+            "platform.bg96-library.bg96-wake": "D11",
+            "platform.bg96-library.bg96-pwrkey": "D10"
+       }
+   }
+```
+
+## CR/LF in serial output
+
+If you want to avoid using `\r\n` in your printouts and just use normal C style `\n` instead, please specify these to your `mbed_app.json`:
+
+```json
+       "target_overrides": {
+        "*": {
+            "platform.stdio-baud-rate": 115200,
+            "platform.stdio-convert-newlines": true
+        }
+    }
+```
+
+## Extra defines
+
+If you'd like to use EZ Connect with mbed Client then you're in luck. EZ Connect automatically defines the `MBED_SERVER_ADDRESS` macro depending on your connectivity method (either IPv4 or IPv6 address). Use this address to connect to the right instance of mbed Device Connector.