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: microbit-dal microbit-dal microbit-ble-open microbit-dal ... more
Fork of BLE_API by
Diff: services/URIBeaconConfigService.h
- Revision:
- 239:58642869879c
- Parent:
- 233:4d570d99b8cb
- Child:
- 240:20df772f2374
diff -r 905d6fc17fda -r 58642869879c services/URIBeaconConfigService.h
--- a/services/URIBeaconConfigService.h Mon Dec 08 20:24:12 2014 +0000
+++ b/services/URIBeaconConfigService.h Mon Dec 08 20:43:06 2014 +0000
@@ -149,7 +149,10 @@
}
/**
- * Update the txPowerLevels table.
+ * @breif Update the txPowerLevels table.
+ *
+ * @param[in] powerLevelsIn
+ * Array of power levels
*/
void setTxPowerLevels(const int8_t powerLevelsIn[NUM_POWER_MODES]) {
memcpy(powerLevels, powerLevelsIn, sizeof(powerLevels));
@@ -158,7 +161,10 @@
}
/**
- * Set the effective power mode from one of the values in the powerLevels tables.
+ * @breif Set the effective power mode from one of the values in the powerLevels tables.
+ *
+ * @param[in] mode
+ * Set the TX Power Mode.
*/
void setTxPowerMode(TXPowerModes_t mode) {
txPowerMode = mode;
@@ -170,6 +176,9 @@
* The period in milliseconds that a UriBeacon packet is transmitted.
*
* @Note: A value of zero disables UriBeacon transmissions.
+ *
+ * @param beaconPeriodIn
+ * Beacon advertising period in milliseconds
*/
void setBeaconPeriod(uint16_t beaconPeriodIn) {
beaconPeriod = beaconPeriodIn;
