JIRA-685, Peripheral sketches shall state associated Central sketch.

unknown · calvinatintel · commit d2b7d1d732ca · 2016-09-22T11:53:32.000-07:00
diff --git a/libraries/CurieBLE/examples/BatteryAdvChange/BatteryAdvChange.ino b/libraries/CurieBLE/examples/BatteryAdvChange/BatteryAdvChange.ino
@@ -1,13 +1,16 @@
-/* Please see code cpyright at the bottom of this example code */
+/* Please see code copyright at the bottom of this example code */
+
 /*
-   This sketch illustrates how to change the advertising data so that it is visible but not
-   connectable. Then after 10 seconds it changes to being connectable
-   This sketch example partially implements the standard Bluetooth Low-Energy Battery service.
-   
-   This sketch is not paired with a specific central example sketch, 
-   but to see how it works you need to use a BLE APP on your phone or central device 
-    and try connecting when it is either a connectable or not connectable state 
-    as displayed in the serial monitor.
+  This example can work with phone BLE app.
+
+  This sketch illustrates how to change the advertising data so that it is visible but not
+  connectable. Then after 10 seconds it changes to being connectable.
+  This sketch example partially implements the standard Bluetooth Low-Energy Battery service.
+
+  This sketch is not paired with a specific central example sketch,
+  but to see how it works you need to use a BLE APP on your phone or central device
+  and try connecting when it is either a connectable or not connectable state
+  as displayed in the serial monitor.
 */
 
 #include <CurieBLE.h>
diff --git a/libraries/CurieBLE/examples/BatteryMonitor/BatteryMonitor.ino b/libraries/CurieBLE/examples/BatteryMonitor/BatteryMonitor.ino
@@ -6,11 +6,12 @@
 #include <CurieBLE.h>
 
 /*
-   This sketch can work with UpdateConnectionInterval. 
-   You can also use an android or IOS app that supports notifications   
-   This sketch example partially implements the standard Bluetooth Low-Energy Battery service
-   and connection interval paramater update.
-   For more information: https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx
+  This sketch can work with UpdateConnectionInterval.
+
+  You can also use an android or IOS app that supports notifications.
+  This sketch example partially implements the standard Bluetooth Low-Energy Battery service
+  and connection interval paramater update.
+  For more information: https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx
 */
 
 /*  */
diff --git a/libraries/CurieBLE/examples/ButtonLED/ButtonLED.ino b/libraries/CurieBLE/examples/ButtonLED/ButtonLED.ino
@@ -3,12 +3,14 @@
  * See the bottom of this file for the license terms.
  */
 
- /*  This examples needs a button connected similarly as described here
-     https://www.arduino.cc/en/Tutorial/Button
-	 The only difference is that instead of connecting to pin 2 connect to pin 4
-	 After the sketch starts connect to a BLE app on a phone and set notification to the Characteristic and you should see it update
-	 whenever the button is pressed. This sketch is not written to pair with any of the central examples. 
- */	 
+/*
+  This example can work with phone BLE app.
+
+  This examples needs a button connected similarly as described here https://www.arduino.cc/en/Tutorial/Button
+  The only difference is that instead of connecting to pin 2, it connects to pin 4
+  After the sketch starts connect to a BLE app on a phone and set notification to the Characteristic and you should see it update
+  whenever the button is pressed. This sketch is not written to pair with any of the central examples.
+*/
  
 #include <CurieBLE.h>
 
diff --git a/libraries/CurieBLE/examples/CallbackLED/CallbackLED.ino b/libraries/CurieBLE/examples/CallbackLED/CallbackLED.ino
@@ -3,14 +3,17 @@
  * See the bottom of this file for the license terms.
  */
  
- // This example can work with LEDCentral
- // You should see the LED blink on and off
- // This example demonstrates the use of Callback or event Handlers responding to events
- // BLECoonected, BLEDisconnected and BLEWritten are events.
- // To test interactively use a Phone app like nrf Controller (Android) or Light Blue (iOS)
- // Connect to BLE device named LEDCB and explore characteristic with UUID 19B10001-E8F2-537E-4F6C-D104768A1214
- // Writing a byte value such as 0x40 should turn on the LED
- // Writng a byte value of 0x00 should turn off the LED
+ /*
+  This example can work with LEDCentral.
+
+  You should see the LED blink on and off.
+  This example demonstrates the use of Callback or event Handlers responding to events.
+  BLEConnected, BLEDisconnected and BLEWritten are events.
+  To test interactively, use a Phone app like nrf Controller (Android) or Light Blue (iOS).
+  Connect to BLE device named LEDCB and explore characteristic with UUID 19B10001-E8F2-537E-4F6C-D104768A1214.
+  Writing a byte value such as 0x40 should turn on the LED.
+  Writing a byte value of 0x00 should turn off the LED.
+ */
 
 #include <CurieBLE.h>
 
diff --git a/libraries/CurieBLE/examples/IMUBleCentral/IMUBleCentral.ino b/libraries/CurieBLE/examples/IMUBleCentral/IMUBleCentral.ino
@@ -6,12 +6,12 @@
 #include <CurieBLE.h>
 
 /*
-    This sketch example works with IMUBleNotification.ino
-    IMUBleNotification.ino will send notification to this sketch.
-    This sketch will receive the notifications and out put the received data in the serial monitor
-	It also illustrates using a non typed characteristic
-	Set the baud rate to 115200 on the serial monitor to accomodate the  speed of constant data updates from IMU subsystem
-	
+  This sketch example works with IMUBleNotification.ino
+
+  IMUBleNotification.ino will send notification to this central sketch.
+  This sketch will receive the notifications and output the received data in the serial monitor.
+  It also illustrates using a non-typed characteristic.
+  Set the baud rate to 115200 on the serial monitor to accomodate the speed of constant data updates from IMU subsystem.
 */
 
 #define MAX_IMU_RECORD 1
diff --git a/libraries/CurieBLE/examples/IMUBleNotification/IMUBleNotification.ino b/libraries/CurieBLE/examples/IMUBleNotification/IMUBleNotification.ino
@@ -7,9 +7,10 @@
 #include <CurieIMU.h>
 
 /*
-    This sketch example works with IMUBleCentral.ino
-    This sketch will read IMU data from sensor and send notification to IMUBleCentral.ino
-    IMUBleCentral.ino will receive the Notifications and output the received data.
+    This sketch example works with IMUBleCentral.ino.
+
+    This sketch will read IMU data from sensor and send notifications to IMUBleCentral.ino.
+    IMUBleCentral.ino will receive the notifications and output the received data.
 */
 
 #define MAX_IMU_RECORD 1
diff --git a/libraries/CurieBLE/examples/LED/LED.ino b/libraries/CurieBLE/examples/LED/LED.ino
@@ -3,15 +3,17 @@
  * See the bottom of this file for the license terms.
  */
  
- // This example can work with LEDCentral
- // 
- // This example is similar to CallbackLED example in functionality
- // It does not use callbacks. In the loop it interogates the connection state with central
- // Checks if the characteristic is wriiten and turns  the LED on or off accordingly
- // To test interactively, use a phone app like nrf Controller (Android) or Light Blue (iOS)
- // Connect to BLE device named LEDCB and explore characteristic with UUID 19B10001-E8F2-537E-4F6C-D104768A1214
- // Writing a byte value such as 0x40 should turn on the LED
- // Writng a byte value of 0x00 should turn off the LED
+ /*
+  This example can work with LEDCentral
+
+  This example is similar to CallbackLED example in functionality.
+  It does not use callbacks. In the loop it interogates the connection state with central.
+  Checks if the characteristic is written and turns the LED on or off accordingly.
+  To test interactively, use a phone app like nrf Controller (Android) or Light Blue (iOS).
+  Connect to BLE device named LEDCB and explore characteristic with UUID 19B10001-E8F2-537E-4F6C-D104768A1214.
+  Writing a byte value such as 0x40 should turn on the LED.
+  Writing a byte value of 0x00 should turn off the LED.
+ */
  
 #include <CurieBLE.h>
 
diff --git a/libraries/CurieBLE/examples/LEDCentral/LEDCentral.ino b/libraries/CurieBLE/examples/LEDCentral/LEDCentral.ino
@@ -6,9 +6,10 @@
 #include <CurieBLE.h>
 
 /* 
-    This example can work with CallbackLED  and LED
-    to show how a central device can do charcteristic read and write operations.
-	A third party serial terminal is recommended to see outputs from central and peripheral device
+  This example can work with CallbackLED and LED sketches.
+
+  To show how a central device can do charcteristic read and write operations.
+  A third party serial terminal is recommended to see outputs from central and peripheral device.
 */
 
 // set up connection params
diff --git a/libraries/CurieBLE/examples/Scanning/Scanning.ino b/libraries/CurieBLE/examples/Scanning/Scanning.ino
@@ -6,11 +6,12 @@
 #include <CurieBLE.h>
 
 /*
-     This sketch try to show the scan function
-     The sketch will list the device's MAC address and device name to the console
-     The list will refresh every 3s
-	 This sketch is meaningful if one or more BLE peripheral devices (any of the peripheral examples will do)
-	 are present.
+  This sketch is meaningful if one or more BLE peripheral devices (any of the peripheral examples will do)
+  are present.
+
+  This sketch try to show the scan function.
+  The sketch will list the device's MAC address and device name to the console.
+  The list will refresh every 3s.
 */
 
 
diff --git a/libraries/CurieBLE/examples/UpdateConnectionInterval/UpdateConnectionInterval.ino b/libraries/CurieBLE/examples/UpdateConnectionInterval/UpdateConnectionInterval.ino
@@ -6,8 +6,9 @@
 #include <CurieBLE.h>
 
 /* 
-    This example can work with BatteryMonitor
-    to show how to control and response the connection intelval request.
+    This example can work with BatteryMonitor.
+
+    Show how to control and response the connection interval request.
 */
 
 // set up connection params
