Jacob McEntire / BLE_API_mod2

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.

Fork of BLE_API by Bluetooth Low Energy

Diff: ble/DiscoveredCharacteristic.h

Revision:
1066:980dd95eb920
Parent:
1065:473735376f13
Child:
1070:4f42630b9c9e
--- a/ble/DiscoveredCharacteristic.h	Mon Jan 11 08:51:38 2016 +0000
+++ b/ble/DiscoveredCharacteristic.h	Mon Jan 11 08:51:39 2016 +0000
@@ -25,8 +25,20 @@
 #include "ble/DiscoveredCharacteristicDescriptor.h"
 
 /**
- * Structure for holding information about the service and the characteristics
- * found during the discovery process.
+ * @brief Representation of a characteristic discovered during a GattClient
+ * discovery procedure (see GattClient::launchServiceDiscovery ).
+ *
+ * @detail Provide detailed informations about a discovered characteristic like:
+ *     - Its UUID (see getUUID).
+ *     - The most important handles of the characteristic definition
+ *       (see getDeclHandle, getValueHandle, getLastHandle )
+ *     - Its properties (see getProperties).
+ * This class also provide functions to operate on the characteristic:
+ *     - Read the characteristic value (see read)
+ *     - Writing a characteristic value (see write or writeWoResponse)
+ *     - Discover descriptors inside the characteristic definition. These descriptors
+ *       extends the characteristic. More information about descriptor usage is
+ *       available in DiscoveredCharacteristicDescriptor class.
  */
 class DiscoveredCharacteristic {
 public: