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
Diff: services/BatteryService.h
- Revision:
- 242:0e9201b67e2f
- Parent:
- 238:905d6fc17fda
- Child:
- 277:1407d2f1ce3c
diff -r 00f2410ad9cc -r 0e9201b67e2f services/BatteryService.h --- a/services/BatteryService.h Tue Dec 09 07:41:43 2014 +0000 +++ b/services/BatteryService.h Tue Dec 09 08:18:11 2014 +0000 @@ -19,11 +19,11 @@ #include "BLEDevice.h" -/** +/** * @class BatteryService -* @breif BLE Battery Service. This service displays the battery level from 0%->100% represented as a 8bit number.<br> +* @brief BLE Battery Service. This service displays the battery level from 0%->100% represented as a 8bit number.<br> * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.battery_service.xml <br> -* Battery Level Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.battery_level.xml +* Battery Level Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.battery_level.xml */ class BatteryService { public: @@ -31,7 +31,7 @@ * @param[ref] _ble * BLEDevice object for the underlying controller. * @param[in] level - * 8bit batterly level. Usually used to represent percentage of batterly charge remaining. + * 8bit batterly level. Usually used to represent percentage of batterly charge remaining. */ BatteryService(BLEDevice &_ble, uint8_t level = 100) : ble(_ble), @@ -52,10 +52,10 @@ } /** - * @breif Update the battery level with a new value. Valid values range from + * @brief Update the battery level with a new value. Valid values range from * 0..100. Anything outside this range will be ignored. - * - * @param newLevel + * + * @param newLevel * update to battery level. */ void updateBatteryLevel(uint8_t newLevel) { @@ -64,9 +64,9 @@ } private: - BLEDevice &ble; - uint8_t batteryLevel; - GattCharacteristic batteryLevelCharacteristic; + BLEDevice &ble; + uint8_t batteryLevel; + GattCharacteristic batteryLevelCharacteristic; }; -#endif /* #ifndef __BLE_BATTERY_SERVICE_H__*/ +#endif /* #ifndef __BLE_BATTERY_SERVICE_H__*/ \ No newline at end of file