Varun Bahl / BahlDecrypModified

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

Files at this revision

API Documentation at this revision

Revision 779:6fd9004bc4b7, committed 2015-08-10

Comitter:
rgrover1
Date:
Mon Aug 10 15:19:43 2015 +0100
Parent:
778:04488024e560
Child:
780:a910652015cd
Commit message:
Synchronized with git rev 8ed4a14b
Author: Rohit Grover
minor improvements in the form of comments to Joshua's commit around AdvParams::get/setInterval

Changed in this revision

ble/GapAdvertisingParams.h Show annotated file Show diff for this revision Revisions of this file 
--- a/ble/GapAdvertisingParams.h	Mon Aug 10 15:19:43 2015 +0100
+++ b/ble/GapAdvertisingParams.h	Mon Aug 10 15:19:43 2015 +0100
@@ -17,8 +17,6 @@
 #ifndef __GAP_ADVERTISING_PARAMS_H__
 #define __GAP_ADVERTISING_PARAMS_H__
 
- #include "mbed.h"
-
 /**************************************************************************/
 /*!
     \brief
@@ -96,10 +94,27 @@
         return (gapUnits * UNIT_0_625_MS) / 1000;
     }
 
-    AdvertisingType_t getAdvertisingType(void) const {return _advType; }
-    uint16_t          getInterval(void)        const {return ADVERTISEMENT_DURATION_UNITS_TO_MS(_interval);}
-    uint16_t          getIntervalInAdvUnits(void) const {return _interval;}
-    uint16_t          getTimeout(void)         const {return _timeout; }
+    AdvertisingType_t getAdvertisingType(void) const {
+        return _advType;
+    }
+
+    /**
+     * @return the advertisement interval (in milliseconds)
+     */
+    uint16_t getInterval(void) const {
+        return ADVERTISEMENT_DURATION_UNITS_TO_MS(_interval);
+    }
+
+    /**
+     * @return the advertisement interval in units advertisement duration units--i.e. 0.625ms units.
+     */
+    uint16_t getIntervalInAdvUnits(void) const {
+        return _interval;
+    }
+
+    uint16_t getTimeout(void) const {
+        return _timeout;
+    }
 
     void setAdvertisingType(AdvertisingType_t newAdvType) {_advType = newAdvType;  }
     void setInterval(uint16_t newInterval)                {_interval = MSEC_TO_ADVERTISEMENT_DURATION_UNITS(newInterval);}
@@ -107,8 +122,8 @@
 
 private:
     AdvertisingType_t _advType;
-    uint16_t          _interval;
-    uint16_t          _timeout;
+    uint16_t          _interval; /* in ADV duration units (i.e. 0.625ms) */
+    uint16_t          _timeout;  /* in seconds */
 };
 
 #endif // ifndef __GAP_ADVERTISING_PARAMS_H__
\ No newline at end of file