Bluetooth Low Energy / BLE_API

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.

Diff: ble/services/BatteryService.h

Revision:
1155:e28c7aac64ab
Parent:
1143:4788b7c9cb49
Child:
1156:e1ea38b576c6
--- a/ble/services/BatteryService.h	Wed Apr 06 19:14:32 2016 +0100
+++ b/ble/services/BatteryService.h	Wed Apr 06 19:14:34 2016 +0100
@@ -28,7 +28,7 @@
 class BatteryService {
 public:
     /**
-     * @param[in] _ble
+     * @param[ref] _ble
      *               BLE object for the underlying controller.
      * @param[in] level
      *               8bit batterly level. Usually used to represent percentage of batterly charge remaining.
@@ -45,7 +45,7 @@
     }
 
     /**
-     * @brief Update the battery level with a new value. Valid values lie between 0 and 100,
+     * @brief Update the battery level with a new value. [Valid values lie between 0 and 100];
      * anything outside this range will be ignored.
      *
      * @param newLevel
@@ -57,20 +57,9 @@
     }
 
 protected:
-    /**
-     * A reference to the underlying BLE instance that this object is attached to.
-     * The services and characteristics will be registered in this BLE instance.
-     */
     BLE &ble;
 
-    /**
-     * The current battery level represented as an integer from 0% to 100%.
-     */
     uint8_t    batteryLevel;
-    /**
-     * A ReadOnlyGattCharacteristic that allows access to the peer device to the
-     * batteryLevel value through BLE.
-     */
     ReadOnlyGattCharacteristic<uint8_t> batteryLevelCharacteristic;
 };