Revision 17:e2c0a1696e39, committed 2015-03-13

Comitter:

rgrover1

Date:

Fri Mar 13 10:13:18 2015 +0000

Parent:

16:1daa78939a3b

Child:

18:569257e0af4e

Commit message:

updated to the latest from BLE_API.; Moving persistence checking into the Nordic specific flash adaptor code.

Changed in this revision

--- a/BLE_API.lib	Mon Mar 09 16:35:03 2015 +0000
+++ b/BLE_API.lib	Fri Mar 13 10:13:18 2015 +0000
@@ -1,1 +1,1 @@
-http://mbed.org/teams/Bluetooth-Low-Energy/code/BLE_API/#193908f2b13b
+http://mbed.org/teams/Bluetooth-Low-Energy/code/BLE_API/#d87182a62c1b

--- a/ConfigParamsPersistence.h	Mon Mar 09 16:35:03 2015 +0000
+++ b/ConfigParamsPersistence.h	Fri Mar 13 10:13:18 2015 +0000
@@ -19,7 +19,6 @@
 
 #include "URIBeaconConfigService.h"
 
-
 /**
  * Generic API to load the URIBeacon configuration parameters from persistent
  * storage. If persistent storage isn't available, the persistenceSignature
@@ -27,19 +26,28 @@
  * a reset to default values.
  *
  * @param[out] paramsP
- *                 The parameters to be filled in from persistence storage.
+ *                 The parameters to be filled in from persistence storage. This
+                   argument can be NULL if the caller is only interested in
+                   discovering the persistence status of params.
+
+ * @return true if params were loaded from persistent storage and have usefully
+ *         initialized fields.
  */
-void loadURIBeaconConfigParams(URIBeaconConfigService::Params_t *paramsP);
+bool loadURIBeaconConfigParams(URIBeaconConfigService::Params_t *paramsP);
 
 /**
  * Generic API to store the URIBeacon configuration parameters to persistent
  * storage. It typically initializes the persistenceSignature member of the
  * params to the MAGIC value to indicate persistence.
  *
+ * @note: the save operation may be asynchronous. It may be a short while before
+ * the request takes affect. Reading back saved configParams may not yield
+ * correct behaviour if attempted soon after a store.
+ *
  * @param[in/out] paramsP
  *                    The params to be saved; persistenceSignature member gets
  *                    updated if persistence is successful.
  */
-void saveURIBeaconConfigParams(URIBeaconConfigService::Params_t *paramsP);
+void saveURIBeaconConfigParams(const URIBeaconConfigService::Params_t *paramsP);
 
 #endif /* #ifndef __BLE_CONFIG_PARAMS_PERSISTENCE_H__*/

--- a/main.cpp	Mon Mar 09 16:35:03 2015 +0000
+++ b/main.cpp	Fri Mar 13 10:13:18 2015 +0000
@@ -24,6 +24,36 @@
 BLEDevice ble;
 URIBeaconConfigService *uriBeaconConfig;
 
+/**
+ * URIBeaconConfig service can operate in two modes: a configuration mode which
+ * allows a user to update settings over a connection; and normal URIBeacon mode
+ * which involves advertising a URI. Constructing an object from URIBeaconConfig
+ * service sets up advertisements for the configuration mode. It is then up to
+ * the application to switch to URIBeacon mode based on some timeout.
+ *
+ * The following help with this switch.
+ */
+static const int CONFIG_ADVERTISEMENT_TIMEOUT_SECONDS = 60;  // Duration after power-on that config service is available.
+Ticker configAdvertisementTimeoutTicker;
+
+/**
+ * Stop advertising the UriBeaconConfig Service after a delay; and switch to normal URIBeacon.
+ */
+void timeout(void)
+{
+    Gap::GapState_t state;
+    state = ble.getGapState();
+    if (!state.connected) { /* don't switch if we're in a connected state. */
+        uriBeaconConfig->setupURIBeaconAdvertisements();
+        ble.startAdvertising();
+
+        configAdvertisementTimeoutTicker.detach(); /* disable the callback from the timeout Ticker. */
+    }
+}
+
+/**
+ * Callback triggered upon a disconnection event. Needs to re-enable advertisements.
+ */
 void disconnectionCallback(Gap::Handle_t handle, Gap::DisconnectionReason_t reason)
 {
     ble.startAdvertising();
@@ -42,14 +72,15 @@
      * operation.
      */
     URIBeaconConfigService::Params_t params;
-    loadURIBeaconConfigParams(&params);
+    bool fetchedFromPersistentStorage = loadURIBeaconConfigParams(&params);
 
     /* Initialize a URIBeaconConfig service providing config params, default URI, and power levels. */
     static URIBeaconConfigService::PowerLevels_t defaultAdvPowerLevels = {-20, -4, 0, 10}; // Values for ADV packets related to firmware levels
-    uriBeaconConfig = new URIBeaconConfigService(ble, params, "http://uribeacon.org", defaultAdvPowerLevels);
+    uriBeaconConfig = new URIBeaconConfigService(ble, params, !fetchedFromPersistentStorage, "http://uribeacon.org", defaultAdvPowerLevels);
     if (!uriBeaconConfig->configuredSuccessfully()) {
         error("failed to accommodate URI");
     }
+    configAdvertisementTimeoutTicker.attach(timeout, CONFIG_ADVERTISEMENT_TIMEOUT_SECONDS);
 
     // Setup auxiliary services to allow over-the-air firmware updates, etc
     DFUService dfu(ble);

--- a/nrfConfigParamsPersistence.cpp	Mon Mar 09 16:35:03 2015 +0000
+++ b/nrfConfigParamsPersistence.cpp	Fri Mar 13 10:13:18 2015 +0000
@@ -18,50 +18,86 @@
 #include "nrf_error.h"
 #include "ConfigParamsPersistence.h"
 
+/**
+ * Nordic specific structure used to store params persistently.
+ * It extends URIBeaconConfigService::Params_t with a persistence signature.
+ */
+struct PersistentParams_t {
+    URIBeaconConfigService::Params_t params;
+    uint32_t                         persistenceSignature; /* This isn't really a parameter, but having the expected
+                                                            * magic value in this field indicates persistence. */
+
+    static const uint32_t MAGIC = 0x1BEAC000;              /* Magic that identifies persistence */
+};
+
+/**
+ * The following is a module-local variable to hold configuration parameters for
+ * short periods during flash access. This is necessary because the pstorage
+ * APIs don't copy in the memory provided as data source. The memory cannot be
+ * freed or reused by the application until this flash access is complete. The
+ * load and store operations in this module initialize persistentParams and then
+ * pass it on to the 'pstorage' APIs.
+ */
+static PersistentParams_t persistentParams;
+
 static pstorage_handle_t pstorageHandle;
 
-/* Dummy callback handler needed by Nordic's pstorage module. */
+/**
+ * Dummy callback handler needed by Nordic's pstorage module. This is called
+ * after every flash access.
+ */
 static void pstorageNotificationCallback(pstorage_handle_t *p_handle,
-                                  uint8_t            op_code,
-                                  uint32_t           result,
-                                  uint8_t *          p_data,
-                                  uint32_t           data_len)
+                                         uint8_t            op_code,
+                                         uint32_t           result,
+                                         uint8_t           *p_data,
+                                         uint32_t           data_len)
 {
     /* APP_ERROR_CHECK(result); */
 }
 
 /* Platform-specific implementation for persistence on the nRF5x. Based on the
  * pstorage module provided by the Nordic SDK. */
-void loadURIBeaconConfigParams(URIBeaconConfigService::Params_t *paramsP)
+bool loadURIBeaconConfigParams(URIBeaconConfigService::Params_t *paramsP)
 {
-    pstorage_init();
-    static pstorage_module_param_t pstorageParams = {
-        .cb          = pstorageNotificationCallback,
-        .block_size  = sizeof(URIBeaconConfigService::Params_t),
-        .block_count = 1
-    };
+    static bool pstorageInitied = false;
+    if (!pstorageInitied) {
+        pstorage_init();
 
-    pstorage_register(&pstorageParams, &pstorageHandle);
-    if (pstorage_load(reinterpret_cast<uint8_t *>(paramsP), &pstorageHandle, sizeof(URIBeaconConfigService::Params_t), 0) != NRF_SUCCESS) {
+        static pstorage_module_param_t pstorageParams = {
+            .cb          = pstorageNotificationCallback,
+            .block_size  = sizeof(PersistentParams_t),
+            .block_count = 1
+        };
+        pstorage_register(&pstorageParams, &pstorageHandle);
+        pstorageInitied = true;
+    }
+
+    if ((pstorage_load(reinterpret_cast<uint8_t *>(&persistentParams), &pstorageHandle, sizeof(PersistentParams_t), 0) != NRF_SUCCESS) ||
+        (persistentParams.persistenceSignature != PersistentParams_t::MAGIC)) {
         // On failure zero out and let the service reset to defaults
         memset(paramsP, 0, sizeof(URIBeaconConfigService::Params_t));
+        return false;
     }
+
+    memcpy(paramsP, &persistentParams.params, sizeof(URIBeaconConfigService::Params_t));
+    return true;
 }
 
 /* Platform-specific implementation for persistence on the nRF5x. Based on the
  * pstorage module provided by the Nordic SDK. */
-void saveURIBeaconConfigParams(URIBeaconConfigService::Params_t *paramsP)
+void saveURIBeaconConfigParams(const URIBeaconConfigService::Params_t *paramsP)
 {
-    if (paramsP->persistenceSignature != URIBeaconConfigService::Params_t::MAGIC) {
-        paramsP->persistenceSignature = URIBeaconConfigService::Params_t::MAGIC;
+    memcpy(&persistentParams.params, paramsP, sizeof(URIBeaconConfigService::Params_t));
+    if (persistentParams.persistenceSignature != PersistentParams_t::MAGIC) {
+        persistentParams.persistenceSignature = PersistentParams_t::MAGIC;
         pstorage_store(&pstorageHandle,
-                       reinterpret_cast<uint8_t *>(paramsP),
-                       sizeof(URIBeaconConfigService::Params_t),
+                       reinterpret_cast<uint8_t *>(&persistentParams),
+                       sizeof(PersistentParams_t),
                        0 /* offset */);
     } else {
         pstorage_update(&pstorageHandle,
-                        reinterpret_cast<uint8_t *>(paramsP),
-                        sizeof(URIBeaconConfigService::Params_t),
+                        reinterpret_cast<uint8_t *>(&persistentParams),
+                        sizeof(PersistentParams_t),
                         0 /* offset */);
     }
 }