High level Bluetooth Low Energy API and radio abstraction layer

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

Overview

The BLE_API is a high level abstraction for using Bluetooth Low Energy on multiple platforms. For details and examples using the BLE_API please see the BLE_API Summary Page. Or click on the API Documentation tab above.

Supported Services

Supported services can be found in the BLE_API/services folder.

Files at this revision

API Documentation at this revision

Comitter:
rgrover1
Date:
Tue Jul 21 13:25:38 2015 +0100
Parent:
739:699b2a104ce3
Child:
741:d6dceefb844e
Commit message:
Synchronized with git rev 9d289f81
Author: Rohit Grover
minor changes to comments for porting.

Changed in this revision

ble/Gap.h Show annotated file Show diff for this revision Revisions of this file
ble/GattClient.h Show annotated file Show diff for this revision Revisions of this file
ble/GattServer.h Show annotated file Show diff for this revision Revisions of this file
--- a/ble/Gap.h	Tue Jul 21 13:25:37 2015 +0100
+++ b/ble/Gap.h	Tue Jul 21 13:25:38 2015 +0100
@@ -178,21 +178,21 @@
      * @return Minimum Advertising interval in milliseconds.
      */
     virtual uint16_t getMinAdvertisingInterval(void) const {
-        return 0; /* default implementation; override this API if this capability is supported. */
+        return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
     }
 
     /**
      * @return Minimum Advertising interval in milliseconds for non-connectible mode.
      */
     virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {
-        return 0; /* default implementation; override this API if this capability is supported. */
+        return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
     }
 
     /**
      * @return Maximum Advertising interval in milliseconds.
      */
     virtual uint16_t getMaxAdvertisingInterval(void) const {
-        return 0xFFFF; /* default implementation; override this API if this capability is supported. */
+        return 0xFFFF; /* Requesting action from porter(s): override this API if this capability is supported. */
     }
 
     virtual ble_error_t stopAdvertising(void) {
@@ -410,7 +410,7 @@
         (void)valueArrayPP;
         (void)countP;
 
-        *countP = 0; /* default implementation; override this API if this capability is supported. */
+        *countP = 0; /* Requesting action from porter(s): override this API if this capability is supported. */
     }
 
 protected:
--- a/ble/GattClient.h	Tue Jul 21 13:25:37 2015 +0100
+++ b/ble/GattClient.h	Tue Jul 21 13:25:38 2015 +0100
@@ -186,7 +186,7 @@
      * Is service-discovery currently active?
      */
     virtual bool isServiceDiscoveryActive(void) const {
-        return false; /* default implementation; override this API if this capability is supported. */
+        return false; /* Requesting action from porter(s): override this API if this capability is supported. */
     }
 
     /**
@@ -194,7 +194,7 @@
      * invocation of the TerminationCallback if service-discovery is active.
      */
     virtual void terminateServiceDiscovery(void) {
-        /* default implementation; override this API if this capability is supported. */
+        /* Requesting action from porter(s): override this API if this capability is supported. */
     }
 
     /* Initiate a Gatt Client read procedure by attribute-handle. */
@@ -261,7 +261,7 @@
     virtual void onServiceDiscoveryTermination(ServiceDiscovery::TerminationCallback_t callback) {
         (void)callback; /* avoid compiler warnings about ununsed variables */
 
-        /* default implementation; override this API if this capability is supported. */
+        /* Requesting action from porter(s): override this API if this capability is supported. */
     }
 
     /**
--- a/ble/GattServer.h	Tue Jul 21 13:25:37 2015 +0100
+++ b/ble/GattServer.h	Tue Jul 21 13:25:38 2015 +0100
@@ -220,7 +220,7 @@
      * onDataRead(). It should be overridden to return true as applicable.
      */
     virtual bool isOnDataReadAvailable() const {
-        return false; /* default implementation; override this API if this capability is supported. */
+        return false; /* Requesting action from porter(s): override this API if this capability is supported. */
     }
 
     /*