Bluetooth Low Energy
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.
Revision 1177:f9060dc8c5ab, committed 2016-04-06
- Comitter:
- vcoubard
- Date:
- Wed Apr 06 19:15:26 2016 +0100
- Parent:
- 1176:8b308f971420
- Child:
- 1178:a4418fcb462f
- Commit message:
- Synchronized with git rev 63864607
Author: Andres Amaya Garcia
Change doxy documentation according to comments
Changed in this revision
--- a/ble/CallChainOfFunctionPointersWithContext.h Wed Apr 06 19:15:24 2016 +0100
+++ b/ble/CallChainOfFunctionPointersWithContext.h Wed Apr 06 19:15:26 2016 +0100
@@ -121,6 +121,9 @@
* FunctionPointerWithContext to detach from this callchain.
*
* @return true if a function pointer has been detached and false otherwise.
+ *
+ * @note It is safe to remove a function pointer while the chain is
+ * traversed by call(ContextType).
*/
bool detach(const FunctionPointerWithContext<ContextType>& toDetach) {
pFunctionPointerWithContext_t current = chainHead;
--- a/ble/DiscoveredCharacteristic.h Wed Apr 06 19:15:24 2016 +0100
+++ b/ble/DiscoveredCharacteristic.h Wed Apr 06 19:15:26 2016 +0100
@@ -43,7 +43,7 @@
class DiscoveredCharacteristic {
public:
/**
- * Enumeration that encapsulates the properties of a discovered
+ * Structure that encapsulates the properties of a discovered
* characteristic.
*/
struct Properties_t {
@@ -57,8 +57,7 @@
public:
/**
- * @brief Check the value of the Properties_t::_broadcast property
- * of the discovered characteristic.
+ * @brief Check if broadcasting is permitted.
*
* @return true if broadcasting the value is permitted, and false
* otherwise.
@@ -68,8 +67,7 @@
}
/**
- * @brief Check the value of the Properties_t::_read property of the
- * discovered characteristic.
+ * @brief Check reading is permitted.
*
* @return true if reading the value is permitted, and false
* otherwise.
@@ -79,8 +77,7 @@
}
/**
- * @brief Check the value of the Properties_t::_writeWoResp property
- * of the discovered characteristic.
+ * @brief Check if writing with Write Command is permitted.
*
* @return true if writing the value with Write Command is permitted,
* false otherwise.
@@ -90,8 +87,7 @@
}
/**
- * @brief Check the value of the Properties_t::_write property of the
- * discovered characteristic.
+ * @brief Check if writing with Write Request is permitted.
*
* @return true if writing the value with Write Request is permitted,
* false otherwise.
@@ -101,8 +97,7 @@
}
/**
- * @brief Check the value of the Properties_t::_notify property of the
- * discovered characteristic.
+ * @brief Check notifications are permitted.
*
* @return true if notifications of the value are permitted, false
* otherwise.
@@ -112,8 +107,7 @@
}
/**
- * @brief Check the value of the Properties_t::_indicate property of
- * the discovered characteristic.
+ * @brief Check if indications are permitted.
*
* @return true if indications of the value are permitted, false
* otherwise.
@@ -123,8 +117,7 @@
}
/**
- * @brief Check the value of the Properties_t::_authSignedWrite
- * property of the discovered characteristic.
+ * @brief Check if writing with Signed Write Command is permitted.
*
* @return true if writing the value with Signed Write Command is
* permitted, false otherwise.