device provisioning refactor

Author: narangmayank

examples/ESP32/SetupClient/SetupClient.ino

@@ -67,7 +67,9 @@ void setup() {
   //  Your other application setup stuff goes here
   //
 
-  // This method will initialize and start the bytebeam client
+  // This method will initialize and start the bytebeam client 
+  // You can over-ride the default file system and file name options, if needed
+  // eg. Bytebeam.begin(BytebeamArduino::LITTLEFS_FILE_SYSTEM, "/my_device_config.json")
   Bytebeam.begin();
 
   //

examples/ESP32/SetupClient_GSM/SetupClient_GSM.ino

@@ -137,6 +137,8 @@ void setup() {
   //
 
   // This method will initialize and start the bytebeam client
+  // You can over-ride the default file system and file name options, if needed
+  // eg. Bytebeam.begin(&modem, BytebeamArduino::LITTLEFS_FILE_SYSTEM, "/my_device_config.json")
   Bytebeam.begin(&modem);
 
   //

examples/Provisioning/FATFSProvisioning/README.md

@@ -0,0 +1,8 @@
+# Bytebeam FATFS Provisioning Example
+This example will show you how to provison your device with FATFS file system.
+
+## Hardware specification
+1. Dev Board (ESP32 or ESP8266)
+
+## Software Specification
+1. Bytebeam Arduino Library

examples/Provisioning/LITTLEFSProvisioning/LITTLEFSProvisioning.ino

@@ -1,5 +1,4 @@
-#include "FS.h"
-#include "LittleFS.h"
+#include <BytebeamArduino.h>
 
 /* This macro is used to specify the base path of the littlefs partiiton */
 #define LITTLEFS_BASE_PATH "/littlefs"
@@ -36,36 +35,53 @@ char deviceConfigWriteStr[DEVICE_CONFIG_STR_LENGTH] = R"(
 }
 )";
 
-void listDir(fs::FS &fs, const char *dirname, uint8_t levels) {
-  Serial.printf("Listing directory : %s\r\n", dirname);
+#if defined(BYTEBEAM_ARDUINO_ARCH_ESP32)
+  void listDir(fs::FS &fs, const char *dirname, uint8_t levels) {
+    Serial.printf("Listing directory : %s\r\n", dirname);
 
-  File root = fs.open(dirname);
-  if (!root) {
-    Serial.println("- failed to open directory");
-    return;
-  }
-  if (!root.isDirectory()) {
-    Serial.println(" - not a directory");
-    return;
-  }
+    File root = fs.open(dirname);
+    if (!root) {
+      Serial.println("- failed to open directory");
+      return;
+    }
+    if (!root.isDirectory()) {
+      Serial.println(" - not a directory");
+      return;
+    }
 
-  File file = root.openNextFile();
-  while (file) {
-    if (file.isDirectory()) {
-      Serial.print(" - DIR : ");
-      Serial.println(file.name());
-      if (levels) {
-        listDir(fs, file.name(), levels - 1);
+    File file = root.openNextFile();
+    while (file) {
+      if (file.isDirectory()) {
+        Serial.print(" - DIR : ");
+        Serial.println(file.name());
+        if (levels) {
+          listDir(fs, file.name(), levels - 1);
+        }
+      } else {
+        Serial.print(" - FILE: ");
+        Serial.print(file.name());
+        Serial.print("\tSIZE: ");
+        Serial.println(file.size());
       }
-    } else {
-      Serial.print(" - FILE: ");
-      Serial.print(file.name());
-      Serial.print("\tSIZE: ");
-      Serial.println(file.size());
+      file = root.openNextFile();
     }
-    file = root.openNextFile();
+  }
+#elif defined(BYTEBEAM_ARDUINO_ARCH_ESP8266)
+  void listDir(fs::FS &fs, const char *dirname, uint8_t levels) {
+  Serial.printf("Listing directory: %s\n", dirname);
+
+  Dir root = fs.openDir(dirname);
+
+  while (root.next()) {
+    File file = root.openFile("r");
+    Serial.print(" - FILE: ");
+    Serial.print(root.fileName());
+    Serial.print("\tSIZE: ");
+    Serial.println(file.size());
+    file.close();
   }
 }
+#endif
 
 void readFile(fs::FS &fs, const char *path, char *message) {
   Serial.printf("Reading file : %s\r\n", path);
@@ -127,8 +143,16 @@ void setup() {
   Serial.begin(115200);
   Serial.println();
 
-  // initalize the littlefs file system 
-  if (!LittleFS.begin(FORMAT_LITTLEFS_IF_FAILED, LITTLEFS_BASE_PATH)) {  
+  bool beginStatus = false;
+
+  // initalize the spiffs file system
+  #if defined(BYTEBEAM_ARDUINO_ARCH_ESP32)
+    beginStatus = LittleFS.begin(FORMAT_LITTLEFS_IF_FAILED, LITTLEFS_BASE_PATH);
+  #elif defined(BYTEBEAM_ARDUINO_ARCH_ESP8266)
+    beginStatus = LittleFS.begin();
+  #endif
+
+  if (!beginStatus) {
     Serial.println("littlefs mount failed");
     return;
   } else {

examples/Provisioning/LITTLEFSProvisioning/README.md

@@ -0,0 +1,8 @@
+# Bytebeam LITTLEFS Provisioning Example
+This example will show you how to provison your device with LITTLEFS file system.
+
+## Hardware specification
+1. Dev Board (ESP32 or ESP8266)
+
+## Software Specification
+1. Bytebeam Arduino Library

examples/Provisioning/README.md

@@ -0,0 +1,18 @@
+## Provisioning
+
+Before you get started with the **BytebeamArduino** you need to provision your device. Each device have it's own config file which needs to be flased into it's file system. As long as the file system is supported by the device, you can pick any of the following file systems for device provisioning.
+
+- SPIFFSProvisioning
+- LITTLEFSProvisioning
+- FATFSProvisioning
+
+Default Configuration,
+
+| Arch          | File Sytem    | File Name           |
+| ------------- |:-------------:| -------------------:|
+| ESP32         | SPIFFS        | /device_config.json |
+| ESP8266       | LITTLEFS      | /device_config.json |
+
+You can always override the default configurations and here are steps to do so,
+ - Provision your device with the required configurations
+ - Specify the same configurations in your sketch via `begin` method.

examples/Provisioning/SPIFFSProvisioning/README.md

@@ -0,0 +1,8 @@
+# Bytebeam SPIFFS Provisioning Example
+This example will show you how to provison your device with SPIFFS file system.
+
+## Hardware specification
+1. Dev Board (ESP32 or ESP8266)
+
+## Software Specification
+1. Bytebeam Arduino Library

examples/Provisioning/SPIFFSProvisioning/SPIFFSProvisioning.ino

@@ -1,5 +1,4 @@
-#include "FS.h"
-#include "SPIFFS.h"
+#include <BytebeamArduino.h>
 
 /* This macro is used to specify the base path of the spiffs partiiton */
 #define SPIFFS_BASE_PATH "/spiffs"
@@ -8,7 +7,7 @@
 #define FORMAT_SPIFFS_IF_FAILED true
 
 /* This macro is used to format the spiffs in the beginnig i.e reset if not required */
-#define FORMAT_SPIFSS_IN_BEGINNING true  
+#define FORMAT_SPIFSS_IN_BEGINNING true
 
 /* This macro is used to specify the name of the device config file */
 #define DEVICE_CONFIG_FILE_NAME "/device_config.json"
@@ -36,36 +35,53 @@ char deviceConfigWriteStr[DEVICE_CONFIG_STR_LENGTH] = R"(
 }
 )";
 
-void listDir(fs::FS &fs, const char *dirname, uint8_t levels) {
-  Serial.printf("Listing directory : %s\r\n", dirname);
+#if defined(BYTEBEAM_ARDUINO_ARCH_ESP32)
+  void listDir(fs::FS &fs, const char *dirname, uint8_t levels) {
+    Serial.printf("Listing directory : %s\r\n", dirname);
 
-  File root = fs.open(dirname);
-  if (!root) {
-    Serial.println("- failed to open directory");
-    return;
-  }
-  if (!root.isDirectory()) {
-    Serial.println(" - not a directory");
-    return;
-  }
+    File root = fs.open(dirname);
+    if (!root) {
+      Serial.println("- failed to open directory");
+      return;
+    }
+    if (!root.isDirectory()) {
+      Serial.println(" - not a directory");
+      return;
+    }
 
-  File file = root.openNextFile();
-  while (file) {
-    if (file.isDirectory()) {
-      Serial.print(" - DIR : ");
-      Serial.println(file.name());
-      if (levels) {
-        listDir(fs, file.name(), levels - 1);
+    File file = root.openNextFile();
+    while (file) {
+      if (file.isDirectory()) {
+        Serial.print(" - DIR : ");
+        Serial.println(file.name());
+        if (levels) {
+          listDir(fs, file.name(), levels - 1);
+        }
+      } else {
+        Serial.print(" - FILE: ");
+        Serial.print(file.name());
+        Serial.print("\tSIZE: ");
+        Serial.println(file.size());
       }
-    } else {
-      Serial.print(" - FILE: ");
-      Serial.print(file.name());
-      Serial.print("\tSIZE: ");
-      Serial.println(file.size());
+      file = root.openNextFile();
     }
-    file = root.openNextFile();
+  }
+#elif defined(BYTEBEAM_ARDUINO_ARCH_ESP8266)
+  void listDir(fs::FS &fs, const char *dirname, uint8_t levels) {
+  Serial.printf("Listing directory: %s\n", dirname);
+
+  Dir root = fs.openDir(dirname);
+
+  while (root.next()) {
+    File file = root.openFile("r");
+    Serial.print(" - FILE: ");
+    Serial.print(root.fileName());
+    Serial.print("\tSIZE: ");
+    Serial.println(file.size());
+    file.close();
   }
 }
+#endif
 
 void readFile(fs::FS &fs, const char *path, char *message) {
   Serial.printf("Reading file : %s\r\n", path);
@@ -117,8 +133,16 @@ void setup() {
   }
 #endif
 
+  bool beginStatus = false;
+
   // initalize the spiffs file system 
-  if (!SPIFFS.begin(FORMAT_SPIFFS_IF_FAILED, SPIFFS_BASE_PATH)) {  
+  #if defined(BYTEBEAM_ARDUINO_ARCH_ESP32)
+    beginStatus = SPIFFS.begin(FORMAT_SPIFFS_IF_FAILED, SPIFFS_BASE_PATH);
+  #elif defined(BYTEBEAM_ARDUINO_ARCH_ESP8266)
+    beginStatus = SPIFFS.begin();
+  #endif
+
+  if (!beginStatus) {
     Serial.println("spiffs mount failed");
     return;
   } else {

src/BytebeamArduino.cpp

@@ -1,9 +1,5 @@
 #include "BytebeamArduino.h"
 
-#ifndef FILE_READ
-#define FILE_READ "r"
-#endif
-
 /* This object will represent the Time library, We will be exposing the necessary functionality and info
  * for the usage, If you want to do any Timing related stuff this guy is for you.
  */
@@ -65,7 +61,7 @@ void BytebeamArduino::printArchitectureInfo() {
   // log esp8266 arch info to serial :)
   Serial.printf("*\t\t\t Architecture : ESP8266 \t\t\t*\n");
   Serial.printf("*\t\t\t Chip Id      : %d \t\t\t*\n", ESP.getChipId());
-  Serial.printf("*\t\t\t CPU Freq     : %d MHz \t\t\t*\n", ESP.getCpuFreqMHz());
+  Serial.printf("*\t\t\t CPU Freq     : %d MHz \t\t\t\t*\n", ESP.getCpuFreqMHz());
   Serial.printf("*\t\t\t Flash Size   : %d MB \t\t\t\t*\n", ((ESP.getFlashChipSize())/1024)/1024);
   Serial.printf("*\t\t\t Free Heap    : %d KB \t\t\t\t*\n", (ESP.getFreeHeap())/1024);
   Serial.printf("*\t\t\t SDK Version  : %s \t\t*\n", ESP.getSdkVersion());

src/BytebeamArduino.h

@@ -9,6 +9,14 @@
 #include "BytebeamOTA.h"
 #include "BytebeamArduinoDefines.h"
 
+#ifndef FILE_READ
+#define FILE_READ "r"
+#endif
+
+#ifndef FILE_WRITE
+#define FILE_WRITE "w"
+#endif
+
 /* This macro is used to debug the library, we will keep all the unnecessary print under this macro */
 #define DEBUG_BYTEBEAM_ARDUINO false