Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: microbit-dal microbit-dal microbit-ble-open microbit-dal ... more
Fork of
BLE_API
by 
Bluetooth Low Energy
Revision 592:58244650991b, committed 2015-06-19
- Comitter:
- rgrover1
- Date:
- Fri Jun 19 15:52:51 2015 +0100
- Parent:
- 591:0545b8836f53
- Child:
- 593:4671808a6e63
- Commit message:
- Synchronized with git rev 639e3c68
Author: Rohit Grover
add a comment header for BLEDevice::connect()
Changed in this revision
| public/BLEDevice.h | Show annotated file Show diff for this revision Revisions of this file |
--- a/public/BLEDevice.h Fri Jun 19 15:52:51 2015 +0100
+++ b/public/BLEDevice.h Fri Jun 19 15:52:51 2015 +0100
@@ -320,10 +320,18 @@
ble_error_t stopScan(void);
/**
- * [connect description]
- * @param peerAddr [description]
- * @param peerAddrType [description]
- * @return [description]
+ * Create a connection (GAP Link Establishment).
+ * @param peerAddr
+ * 48-bit address, LSB format.
+ * @param peerAddrType
+ * Address type of the peer.
+ * @param connectionParams
+ * Connection parameters.
+ * @param scanParams
+ * Paramters to be used while scanning for the peer.
+ * @return BLE_ERROR_NONE if connection establishment procedure is started
+ * successfully. The onConnection callback (if set) will be invoked upon
+ * a connection event.
*/
ble_error_t connect(const Gap::Address_t peerAddr,
Gap::AddressType_t peerAddrType = Gap::ADDR_TYPE_RANDOM_STATIC,