Fixes to BLE_API for mbedOS Alpha1 release. Mostly relating to doxygen fixes.

Fork of BLE_API by Bluetooth Low Energy

Revision:
200:80dd3e50705c
Parent:
199:6b57874115f6
Child:
201:9bb7b3f45c20
diff -r 6b57874115f6 -r 80dd3e50705c services/URIBeacon2Service.h
--- a/services/URIBeacon2Service.h	Mon Dec 01 14:31:17 2014 +0000
+++ b/services/URIBeacon2Service.h	Mon Dec 01 14:31:17 2014 +0000
@@ -64,7 +64,7 @@
         uriDataLength(0),
         uriData(),
         flags(flagsIn),
-        effectivePower(effectiveTxPowerIn),
+        effectiveTxPower(effectiveTxPowerIn),
         powerLevels(),
         beaconPeriod(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(beaconPeriodIn)),
         lockedStateChar(lockedStateCharUUID, reinterpret_cast<uint8_t *>(&lockedState), 1, 1, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
@@ -92,10 +92,10 @@
         configure();
         if (initSucceeded) {
             /* Preserve the originals to be able to reset() upon request. */
-            memcpy(originalURIData, uriDataIn, MAX_SIZE_URI_DATA_CHAR_VALUE);
-            originalFlags            = flagsIn;
-            originalEffectiveTxPower = effectiveTxPowerIn;
-            originalBeaconPeriod     = beaconPeriodIn;
+            memcpy(defaultURIData, uriDataIn, MAX_SIZE_URI_DATA_CHAR_VALUE);
+            defaultFlags            = flagsIn;
+            defaultEffectiveTxPower = effectiveTxPowerIn;
+            defaultBeaconPeriod     = beaconPeriodIn;
         }
 
         GattCharacteristic *charTable[] = {&lockedStateChar, &uriDataChar, &flagsChar, &txPowerLevelsChar, &beaconPeriodChar, &resetChar};
@@ -147,7 +147,7 @@
      * Set the effective power mode from one of the values in the powerLevels tables.
      */
     void useTxPowerMode(TXPowerModes_t mode) {
-        effectivePower = powerLevels[mode];
+        effectiveTxPower = powerLevels[mode];
         configure();
     }
 
@@ -172,7 +172,7 @@
         serviceDataPayload[payloadIndex++] = BEACON_UUID[0];
         serviceDataPayload[payloadIndex++] = BEACON_UUID[1];
         serviceDataPayload[payloadIndex++] = flags;
-        serviceDataPayload[payloadIndex++] = effectivePower;
+        serviceDataPayload[payloadIndex++] = effectiveTxPower;
 
         const char *urlData  = reinterpret_cast<char *>(uriData);
         size_t sizeofURLData = uriDataLength;
@@ -183,7 +183,7 @@
         ble.accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceDataPayload, encodedBytes + 4);
 
         ble.setAdvertisingInterval(beaconPeriod);
-        ble.setTxPower(effectivePower);
+        ble.setTxPower(effectiveTxPower);
     }
 
     size_t encodeURISchemePrefix(const char *&urldata, size_t &sizeofURLData) {
@@ -309,18 +309,18 @@
                 beaconPeriod = *((uint16_t *)(params->data));
             }
         } else if (params->charHandle == resetChar.getValueAttribute().getHandle()) {
-            resetOriginals();
+            resetDefaults();
         }
         configure();
         ble.setAdvertisingPayload();
     }
 
-    void resetOriginals(void) {
-        memcpy(uriData, originalURIData, MAX_SIZE_URI_DATA_CHAR_VALUE);
+    void resetDefaults(void) {
+        memcpy(uriData, defaultURIData, MAX_SIZE_URI_DATA_CHAR_VALUE);
         memset(powerLevels, 0, sizeof(powerLevels));
-        flags          = originalFlags;
-        effectivePower = originalEffectiveTxPower;
-        beaconPeriod   = originalBeaconPeriod;
+        flags            = defaultFlags;
+        effectiveTxPower = defaultEffectiveTxPower;
+        beaconPeriod     = defaultBeaconPeriod;
 
         ble.updateCharacteristicValue(uriDataChar.getValueAttribute().getHandle(), uriData, uriDataLength);
         ble.updateCharacteristicValue(flagsChar.getValueAttribute().getHandle(), &flags, 1 /* size */);
@@ -356,15 +356,15 @@
     uint16_t uriDataLength;
     uint8_t  uriData[MAX_SIZE_URI_DATA_CHAR_VALUE];
     uint8_t  flags;
-    int8_t   effectivePower;
+    int8_t   effectiveTxPower;
     int8_t   powerLevels[NUM_POWER_MODES];
     uint16_t beaconPeriod;
     bool     resetFlag;
 
-    uint8_t  originalURIData[MAX_SIZE_URI_DATA_CHAR_VALUE];
-    uint8_t  originalFlags;
-    int8_t   originalEffectiveTxPower;
-    uint16_t originalBeaconPeriod;
+    uint8_t  defaultURIData[MAX_SIZE_URI_DATA_CHAR_VALUE];
+    uint8_t  defaultFlags;
+    int8_t   defaultEffectiveTxPower;
+    uint16_t defaultBeaconPeriod;
 
     GattCharacteristic lockedStateChar;
     GattCharacteristic uriDataChar;