Bluetooth Low Energy / BLE_API

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.

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

Diff: services/URIBeacon2Service.h

Revision:
172:fb95afa93697
Parent:
171:6092e61690dc
Child:
173:05c4b1cea65f
--- a/services/URIBeacon2Service.h	Fri Nov 28 14:11:22 2014 +0000
+++ b/services/URIBeacon2Service.h	Fri Nov 28 14:11:22 2014 +0000
@@ -32,6 +32,20 @@
 
 class URIBeacon2Service {
 public:
+    /**
+     * @param[ref] ble
+     *                 BLEDevice object for the underlying controller.
+     * @param[in]  urldata
+     *                 URI as a null-terminated string.
+     * @param[in]  flagsIn
+     *                 UriBeacon Flags.
+     * @param[in]  txPowerIn
+     *                 UriBeacon Tx Power Level.
+     * @param[in]  beaconPeriodIn
+     *                 The period in milliseconds that a UriBeacon packet is
+     *                 transmitted. A value of zero disables UriBeacon
+     *                 transmissions.
+     */
     URIBeacon2Service(BLEDevice &ble_, const char *urldata, uint8_t flagsIn = 0, uint8_t txPowerIn = 0, uint16_t beaconPeriodIn = 1000) :
         ble(ble_), payloadIndex(0), serviceDataPayload(),
         lockedState(false),