Diff: AltBeaconService.h

Revision:

1:cc428f427838

Parent:

0:f519dff5c6a7

Child:

2:6ec277483638

diff -r f519dff5c6a7 -r cc428f427838 AltBeaconService.h
--- a/AltBeaconService.h	Tue Feb 03 18:23:07 2015 +0000
+++ b/AltBeaconService.h	Fri Mar 20 21:10:12 2015 +0000
@@ -13,19 +13,36 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-#ifndef __BLE_IBEACON_SERVICE_H__
-#define __BLE_IBEACON_SERVICE_H__
+#ifndef __BLE_ALTBEACON_SERVICE_H__
+#define __BLE_ALTBEACON_SERVICE_H__
 
 #include "BLEDevice.h"
 
 /**
-* @class iBeaconService
-* @brief iBeacon Service. This service sets up a device to broadcast advertising packets to mimic an iBeacon<br>
+* @class AltBeaconService
+* @brief AltBeacon Service. This service sets up a device to broadcast advertising packets to mimic an AltBeacon<br>
 */
 
 class AltBeaconService
 {
 public:
+    /**
+    * @param[ref] _ble
+    *               BLEDevice object for the underlying controller.
+    * @param[in] mfgID
+    *               The beacon device manufacturer's company identifier code. 
+    *               Usually this will coorespond to the companies BLE SIG assigned number.
+    * @param[in] beaconID
+    *               A 20-byte value uniquely identifying the beacon. 
+    *               The big endian representation of the beacon identifier. 
+    *               For interoperability purposes, the first 16+ bytes of the beacon 
+    *               identifier should be unique to the advertiser's organizational unit. 
+    *               Any remaining bytes of the beacon identifier may be subdivided as needed for the use case.
+    * @param[in] refRSSI
+    *               The RSSI of the beacon (as signed value from 0 to -127) as measured 1 meter from the device. Used for micro-location.
+    * @param[in] mfgReserved
+    *               Used for special manufacturer data. Defaults to 0x00 if not specified.
+    */
     AltBeaconService(BLEDevice &_ble, uint16_t mfgID, uint8_t beaconID[20], int8_t refRSSI, uint8_t mfgReserved = 0x00):
         ble(_ble)
     {
@@ -66,4 +83,4 @@
 
 };
 
-#endif //__BLE_IBEACON_SERVICE_H__
+#endif //__BLE_ALTBEACON_SERVICE_H__