Adjust the example comments and functions

sgbihu · sgbihu · commit abbc14ad2d26 · 2016-08-22T10:00:39.000+08:00
1. Fix Jira 675 - BLE callbacks should use passed arguments instead of global variables
2. Adjust the code struture to align with Arduino's requirement
diff --git a/libraries/CurieBLE/examples/CallbackLED/CallbackLED.ino b/libraries/CurieBLE/examples/CallbackLED/CallbackLED.ino
@@ -61,7 +61,7 @@ void switchCharacteristicWritten(BLEHelper& central, BLECharacteristic& characte
   // central wrote new value to characteristic, update LED
   Serial.print("Characteristic event, written: ");
 
-  if (switchChar.value()) {
+  if (characteristic.value()) {
     Serial.println("LED on");
     digitalWrite(ledPin, HIGH);
   } else {
diff --git a/libraries/CurieBLE/examples/IMUBleCentral/IMUBleCentral.ino b/libraries/CurieBLE/examples/IMUBleCentral/IMUBleCentral.ino
@@ -1,20 +1,7 @@
 /*
-   Copyright (c) 2016 Intel Corporation.  All rights reserved.
-
-   This library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Lesser General Public
-   License as published by the Free Software Foundation; either
-   version 2.1 of the License, or (at your option) any later version.
-
-   This library is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Lesser General Public License for more details.
-
-   You should have received a copy of the GNU Lesser General Public
-   License along with this library; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-*/
+ * Copyright (c) 2016 Intel Corporation.  All rights reserved.
+ * See the bottom of this file for the license terms.
+ */
 
 #include <CurieBLE.h>
 
@@ -44,6 +31,42 @@ BLECharacteristic bleImuChar("F7580003-153E-D4F6-F26D-43D8D98EEB13",    // stand
                              BLERead | BLENotify, sizeof(imuBuf));      // remote clients will be able to
                                                                         // get notifications if this characteristic changes
 
+bool adv_found(uint8_t type,
+               const uint8_t *data,
+               uint8_t data_len,
+               void *user_data);
+
+void setup()
+{
+    Serial.begin(115200);    // initialize serial communication
+    pinMode(13, OUTPUT);   // initialize the LED on pin 13 to indicate when a central is connected
+
+    bleImuChar.setEventHandler(BLEWritten, bleImuCharacteristicWritten);
+    
+    /* Set a local name for the BLE device
+     This name will appear in advertising packets
+     and can be used by remote devices to identify this BLE device
+     The name can be changed but maybe be truncated based on space 
+     left in advertisement packet */
+    bleCentral.addAttribute(bleImuService); // Add the BLE IMU service
+    bleCentral.addAttribute(bleImuChar);    // Add the BLE IMU characteristic
+
+    /* Setup callback */
+    bleCentral.setAdvertiseHandler(adv_found);
+    bleCentral.setEventHandler(BLEConnected, ble_connected);
+    
+    /* Now activate the BLE device.  It will start continuously transmitting BLE
+     advertising packets and will be visible to remote BLE central devices
+     until it receives a new connection */
+    bleCentral.begin();
+}
+
+
+void loop()
+{
+    delay(2000);
+}
+
 void ble_connected(BLEHelper &role)
 {
     BLEPeripheralHelper&peripheral = *(BLEPeripheralHelper*)(&role);
@@ -116,33 +139,20 @@ bool adv_found(uint8_t type,
     return true;
 }
 
-void setup() {    
-    Serial.begin(115200);    // initialize serial communication
-    pinMode(13, OUTPUT);   // initialize the LED on pin 13 to indicate when a central is connected
-
-    bleImuChar.setEventHandler(BLEWritten, bleImuCharacteristicWritten);
-    
-    /* Set a local name for the BLE device
-     This name will appear in advertising packets
-     and can be used by remote devices to identify this BLE device
-     The name can be changed but maybe be truncated based on space 
-     left in advertisement packet */
-    bleCentral.addAttribute(bleImuService); // Add the BLE IMU service
-    bleCentral.addAttribute(bleImuChar);    // Add the BLE IMU characteristic
-
-    /* Setup callback */
-    bleCentral.setAdvertiseHandler(adv_found);
-    bleCentral.setEventHandler(BLEConnected, ble_connected);
-    
-    /* Now activate the BLE device.  It will start continuously transmitting BLE
-     advertising packets and will be visible to remote BLE central devices
-     until it receives a new connection */
-    bleCentral.begin();
-}
+/*
+   Copyright (c) 2016 Intel Corporation.  All rights reserved.
 
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
-void loop()
-{
-    delay(2000);
-}
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
 
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+*/
diff --git a/libraries/CurieBLE/examples/IMUBleNotification/IMUBleNotification.ino b/libraries/CurieBLE/examples/IMUBleNotification/IMUBleNotification.ino
@@ -1,20 +1,7 @@
 /*
-   Copyright (c) 2016 Intel Corporation.  All rights reserved.
-
-   This library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Lesser General Public
-   License as published by the Free Software Foundation; either
-   version 2.1 of the License, or (at your option) any later version.
-
-   This library is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Lesser General Public License for more details.
-
-   You should have received a copy of the GNU Lesser General Public
-   License along with this library; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-*/
+ * Copyright (c) 2016 Intel Corporation.  All rights reserved.
+ * See the bottom of this file for the license terms.
+ */
 
 #include <CurieBLE.h>
 #include <CurieIMU.h>
@@ -41,8 +28,8 @@ BLEService bleImuService("F7580001-153E-D4F6-F26D-43D8D98EEB13"); // Tx IMU data
 BLECharacteristic bleImuChar("F7580003-153E-D4F6-F26D-43D8D98EEB13", // standard 128-bit characteristic UUID
                              BLERead | BLENotify, sizeof(imuBuf));   // remote clients will be able to
                                                                      // get notifications if this characteristic changes
-void setup() {
-    
+void setup()
+{
     Serial.begin(9600);    // initialize serial communication
     pinMode(13, OUTPUT);   // initialize the LED on pin 13 to indicate when a central is connected
 
@@ -64,23 +51,8 @@ void setup() {
     CurieIMU.begin();
 }
 
-void recordImuData(int index) {
-    /* Read IMU data.
-    */
-    int ax, ay, az;
-    int gx, gy, gz;
-
-    imuBuf[index].index = seqNum++;
-    CurieIMU.readMotionSensor(ax, ay, az, gx, gy, gz);
-
-    imuBuf[index].slot[0] = (unsigned int)((ax << 16) | (ay & 0x0FFFF));
-    imuBuf[index].slot[1] = (unsigned int)((az << 16) | (gx & 0x0FFFF));
-    imuBuf[index].slot[2] = (unsigned int)((gy << 16) | (gz & 0x0FFFF));
-
-}
-
-
-void loop() {
+void loop()
+{
     // listen for BLE peripherals to connect:
     BLECentralHelper central = blePeripheral.central();
 
@@ -119,3 +91,37 @@ void loop() {
     }
 }
 
+void recordImuData(int index)
+{
+    /* Read IMU data.
+    */
+    int ax, ay, az;
+    int gx, gy, gz;
+
+    imuBuf[index].index = seqNum++;
+    CurieIMU.readMotionSensor(ax, ay, az, gx, gy, gz);
+
+    imuBuf[index].slot[0] = (unsigned int)((ax << 16) | (ay & 0x0FFFF));
+    imuBuf[index].slot[1] = (unsigned int)((az << 16) | (gx & 0x0FFFF));
+    imuBuf[index].slot[2] = (unsigned int)((gy << 16) | (gz & 0x0FFFF));
+
+}
+
+
+/*
+   Copyright (c) 2016 Intel Corporation.  All rights reserved.
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+*/
diff --git a/libraries/CurieBLE/examples/LEDCentral/LEDCentral.ino b/libraries/CurieBLE/examples/LEDCentral/LEDCentral.ino
@@ -1,21 +1,7 @@
 /*
-  Copyright (c) 2016 Intel Corporation. All rights reserved.
-
-  This library is free software; you can redistribute it and/or
-  modify it under the terms of the GNU Lesser General Public
-  License as published by the Free Software Foundation; either
-  version 2.1 of the License, or (at your option) any later version.
-
-  This library is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public
-  License along with this library; if not, write to the Free Software
-  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-
-  1301 USA
-*/
+ * Copyright (c) 2016 Intel Corporation.  All rights reserved.
+ * See the bottom of this file for the license terms.
+ */
 
 #include <CurieBLE.h>
 
@@ -37,6 +23,55 @@ BLEPeripheralHelper *blePeripheral1 = NULL;
 BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // create service
 BLECharCharacteristic switchChar("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite);// create switch characteristic and allow remote device to read and write
 
+bool adv_found(uint8_t type,
+               const uint8_t *data,
+               uint8_t data_len,
+               void *user_data);
+
+void setup()
+{
+    Serial.begin(9600);
+    pinMode(ledPin, OUTPUT); // use the LED on pin 13 as an output
+
+    // add service and characteristic
+    bleCentral.addAttribute(ledService);
+    bleCentral.addAttribute(switchChar);
+
+    // assign event handlers for connected, disconnected to central
+    bleCentral.setEventHandler(BLEConnected, bleCentralConnectHandler);
+    bleCentral.setEventHandler(BLEDisconnected, bleCentralDisconnectHandler);
+
+    // advertise the service
+    bleCentral.setAdvertiseHandler(adv_found);
+
+    // assign event handlers for characteristic
+    switchChar.setEventHandler(BLEWritten, switchCharacteristicWritten);
+
+    bleCentral.begin();
+    Serial.println(("Bluetooth device active, waiting for connections..."));
+}
+
+void loop()
+{
+    static unsigned int counter = 0;
+    static char ledstate = 0;
+    delay(2000);
+    if (blePeripheral1)
+    {
+        counter++;
+
+        if (counter % 3)
+        {
+            switchChar.read(*blePeripheral1);
+        }
+        else
+        {
+            ledstate = !ledstate;
+            switchChar.write(*blePeripheral1, (unsigned char *)(&ledstate), sizeof (ledstate));
+        }
+    }
+}
+
 void bleCentralConnectHandler(BLEHelper& peripheral)
 {
     // peripheral connected event handler
@@ -61,7 +96,7 @@ void switchCharacteristicWritten(BLEHelper& peripheral, BLECharacteristic& chara
     // Read response/Notification wrote new value to characteristic, update LED
     Serial.print("Characteristic event, written: ");
 
-    if (switchChar.value()) 
+    if (characteristic.value()) 
     {
         Serial.println("LED on");
         digitalWrite(ledPin, HIGH);
@@ -121,45 +156,20 @@ bool adv_found(uint8_t type,
     return true;
 }
 
-void setup() {
-    Serial.begin(9600);
-    pinMode(ledPin, OUTPUT); // use the LED on pin 13 as an output
-
-    // add service and characteristic
-    bleCentral.addAttribute(ledService);
-    bleCentral.addAttribute(switchChar);
-
-    // assign event handlers for connected, disconnected to central
-    bleCentral.setEventHandler(BLEConnected, bleCentralConnectHandler);
-    bleCentral.setEventHandler(BLEDisconnected, bleCentralDisconnectHandler);
-
-    // advertise the service
-    bleCentral.setAdvertiseHandler(adv_found);
+/*
+   Copyright (c) 2016 Intel Corporation.  All rights reserved.
 
-    // assign event handlers for characteristic
-    switchChar.setEventHandler(BLEWritten, switchCharacteristicWritten);
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
-    bleCentral.begin();
-    Serial.println(("Bluetooth device active, waiting for connections..."));
-}
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
 
-void loop()
-{
-    static unsigned int counter = 0;
-    static char ledstate = 0;
-    delay(2000);
-    if (blePeripheral1)
-    {
-        counter++;
-
-        if (counter % 3)
-        {
-            switchChar.read(*blePeripheral1);
-        }
-        else
-        {
-            ledstate = !ledstate;
-            switchChar.write(*blePeripheral1, (unsigned char *)(&ledstate), sizeof (ledstate));
-        }
-    }
-}
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+*/
diff --git a/libraries/CurieBLE/examples/Scanning/Scanning.ino b/libraries/CurieBLE/examples/Scanning/Scanning.ino
