enabled the SD card for the system - now can save/restore prefs from sd card, and log to sd card

Author: gigapod

CMakeLists.txt

@@ -28,8 +28,11 @@ flux_sdk_add_module(
     flux_logging
     flux_system
     flux_prefs
+    flux_prefs_json
     flux_prefs_serial
     flux_network
+    flux_sdcard
+    flux_file
     device_bme280
     device_bme68x
     device_bmp384

sfeIoTNodeLoRaWAN/sfeIoTNodeLoRaWAN.cpp

@@ -12,6 +12,7 @@
 #include "sfeNLCommands.h"
 #include "sfeNLLed.h"
 #include "sfeNLVersion.h"
+#include "sfeNLBoard.h"
 #include <Arduino.h>
 
 #include <Flux/flxDevButton.h>
@@ -74,7 +75,7 @@ static const uint8_t _app_jump[] = {104, 72, 67, 51,  74,  67,  108, 99, 104, 11
 #define kAppClassPrefix "INLW"
 //---------------------------------------------------------------------------
 //
-sfeIoTNodeLoRaWAN::sfeIoTNodeLoRaWAN() : _opFlags{0}
+sfeIoTNodeLoRaWAN::sfeIoTNodeLoRaWAN() : _logTypeSD{kAppLogTypeNone}, _logTypeSer{kAppLogTypeNone}, _opFlags{0}
 {
     // Constructor
 }
@@ -214,8 +215,10 @@ void sfeIoTNodeLoRaWAN::onInit()
     // flxLog_I("in onInit()");
 
     _logTypeSer = kAppLogTypeNone;
+    _logTypeSD = kAppLogTypeNone;
     serialLogType.setTitle("Output");
     flxRegister(serialLogType, "Serial Console Format", "Enable and set the output format");
+    flxRegister(sdCardLogType, "SD Card Format", "Enable and set the output format");
     flxRegister(jsonBufferSize, "JSON Buffer Size", "Output buffer size in bytes");
 
     // Terminal Serial Baud Rate
@@ -241,6 +244,12 @@ void sfeIoTNodeLoRaWAN::onInit()
     _sysStorageDevice.initialize(preStart, kSegmentSize, 10);
     _sysStorage.setStorageDevice(&_sysStorageDevice);
     flxSettings.setStorage(&_sysStorage);
+    flxSettings.setFallback(&_jsonStorage);
+
+    _jsonStorage.setFileSystem(&_theSDCard);
+    _jsonStorage.setFilename("iot-node-lorawan.json");
+
+    _theSDCard.setCSPin(kNLBoardSDCardCSPin);
 
     // Did the user set a serial value?
     uint32_t theRate;
@@ -323,6 +332,11 @@ bool sfeIoTNodeLoRaWAN::onSetup()
     // was list device divers set by startup commands?
     if (inOpMode(kAppOpStartListDevices))
         flux.dumpDeviceAutoLoadTable();
+// setup SD card. Do this before calling start - so prefs can be read off SD if needed
+    if (!setupSDCard())
+    {
+        flxLog_W(F("Unable to initialize the SD Card. Is an SD card installed on the board?"));
+    }
 
     // Button events we're listening on
     _boardButton.on_momentaryPress.call(this, &sfeIoTNodeLoRaWAN::onLogEvent);
@@ -508,6 +522,29 @@ void sfeIoTNodeLoRaWAN::set_jsonBufferSize(uint32_t new_size)
     _fmtJSON.setBufferSize(new_size);
 }
 
+uint8_t sfeIoTNodeLoRaWAN::get_logTypeSD(void)
+{
+    return _logTypeSD;
+}
+//---------------------------------------------------------------------------
+void sfeIoTNodeLoRaWAN::set_logTypeSD(uint8_t logType)
+{
+    if (logType == _logTypeSD)
+        return;
+
+    if (_logTypeSD == kAppLogTypeCSV)
+        _fmtCSV.remove(&_theOutputFile);
+    else if (_logTypeSD == kAppLogTypeJSON)
+        _fmtJSON.remove(&_theOutputFile);
+
+    _logTypeSD = logType;
+
+    if (_logTypeSD == kAppLogTypeCSV)
+        _fmtCSV.add(&_theOutputFile);
+    else if (_logTypeSD == kAppLogTypeJSON)
+        _fmtJSON.add(&_theOutputFile);
+}
+
 //---------------------------------------------------------------------------
 uint8_t sfeIoTNodeLoRaWAN::get_logTypeSer(void)
 {

sfeIoTNodeLoRaWAN/sfeIoTNodeLoRaWAN.h

@@ -24,6 +24,9 @@
 #include <Flux/flxSettingsSerial.h>
 #include <Flux/flxStorageKVPPref.h>
 #include <Flux/flxSystem.h>
+#include <Flux/flxFSSDCard.h>
+#include <Flux/flxFileRotate.h>
+#include <Flux/flxStorageJSONPref.h>
 
 #include "flxLoRaWANDigi.h"
 #include "flxLoRaWANLogger.h"
@@ -78,6 +81,14 @@ class sfeIoTNodeLoRaWAN : public flxApplication
     static constexpr uint8_t kAppLogTypeJSON = 0x2;
 
     static constexpr const char *kLogFormatNames[] = {"Disabled", "CSV Format", "JSON Format"};
+
+
+    //---------------------------------------------------------------------------
+    uint8_t get_logTypeSD(void);
+
+    //---------------------------------------------------------------------------
+    void set_logTypeSD(uint8_t logType);
+    uint8_t _logTypeSD;
     uint8_t _logTypeSer; // type of serial log output format
     //---------------------------------------------------------------------------
     uint8_t get_logTypeSer(void);
@@ -157,6 +168,12 @@ class sfeIoTNodeLoRaWAN : public flxApplication
                       &sfeIoTNodeLoRaWAN::set_verbose_dev_name>
         verboseDevNames;
 
+        flxPropertyRWUInt8<sfeIoTNodeLoRaWAN, &sfeIoTNodeLoRaWAN::get_logTypeSD, &sfeIoTNodeLoRaWAN::set_logTypeSD> sdCardLogType = {
+            kAppLogTypeCSV,
+            {{kLogFormatNames[kAppLogTypeNone], kAppLogTypeNone},
+             {kLogFormatNames[kAppLogTypeCSV], kAppLogTypeCSV},
+             {kLogFormatNames[kAppLogTypeJSON], kAppLogTypeJSON}}};
+    
     flxPropertyRWUInt8<sfeIoTNodeLoRaWAN, &sfeIoTNodeLoRaWAN::get_logTypeSer, &sfeIoTNodeLoRaWAN::set_logTypeSer>
         serialLogType = {kAppLogTypeCSV,
                          {{kLogFormatNames[kAppLogTypeNone], kAppLogTypeNone},
@@ -204,6 +221,7 @@ class sfeIoTNodeLoRaWAN : public flxApplication
     // setup routines
     bool setupTime();
     void setupENS160(void);
+    bool setupSDCard(void);
 
     // Our LoRaWAN network/connection object
     flxLoRaWANDigi _loraWANConnection;
@@ -220,6 +238,10 @@ class sfeIoTNodeLoRaWAN : public flxApplication
     flxFormatJSON<kAppJSONDocSize> _fmtJSON;
     flxFormatCSV _fmtCSV;
 
+    flxFSSDCard _theSDCard;
+    flxFileRotate _theOutputFile;
+    flxStorageJSONPrefFile _jsonStorage;
+
     // Serial Settings editor
     flxSettingsSerial _serialSettings;
 

sfeIoTNodeLoRaWAN/sfeIoTNodeLoRaWANAbout.cpp

@@ -115,24 +115,37 @@ void sfeIoTNodeLoRaWAN::displayAppStatus(bool useInfo)
         flxSerial.textToWhite();
         flxLog_N("    System:");
         flxSerial.textToNormal();
+        flxSerial.flush();
     }
-    // if (_theSDCard.enabled())
-    // {
-
-    //     char szSize[32];
-    //     char szCap[32];
-    //     char szAvail[32];
-
-    //     flx_utils::formatByteString(_theSDCard.size(), 2, szSize, sizeof(szSize));
-    //     flx_utils::formatByteString(_theSDCard.total(), 2, szCap, sizeof(szCap));
-    //     flx_utils::formatByteString(_theSDCard.total() - _theSDCard.used(), 2, szAvail, sizeof(szAvail));
+    if (_theSDCard.enabled())
+    {
 
-    //     flxLog__(logLevel, "%cSD Card - Type: %s Size: %s Capacity: %s Free: %s (%.1f%%)", pre_ch,
-    //     _theSDCard.type(),
-    //              szSize, szCap, szAvail, 100. - (_theSDCard.used() / (float)_theSDCard.total() * 100.));
-    // }
-    // else
-    //     flxLog__(logLevel, "%cSD card not available", pre_ch);
+        char szSize[32];
+        char szCap[32];
+        char szAvail[32];
+
+        uint64_t sd_size = _theSDCard.size();
+        uint64_t sd_total = _theSDCard.total();
+
+        flx_utils::formatByteString(sd_size, 2, szSize, sizeof(szSize));
+        flx_utils::formatByteString(sd_total, 2, szCap, sizeof(szCap));
+
+        flxLog___(logLevel, "%cSD Card - Type: %s Size: %s Capacity: %s ", pre_ch, _theSDCard.type(), szSize, szCap);
+
+        // Getting about used can take time -- so only do if about is called (use info is false)
+        if (!useInfo)
+        {
+            flxLog_N_("...");
+            flxSerial.flush();
+            // This call can take some time .. .so
+            uint64_t sd_used = _theSDCard.used();
+            flx_utils::formatByteString(sd_total - sd_used, 2, szAvail, sizeof(szAvail));
+            flxLog_N("Free: %s (%.1f%%)", szAvail, 100. - (sd_used / (float)sd_total * 100.));
+        }else 
+            flxLog_N("");
+    }
+    else
+        flxLog__(logLevel, "%cSD card not available", pre_ch);
 
     // show heap level
     flxLog__(logLevel, "%cSystem Heap - Total: %dB Free: %dB (%.1f%%)", pre_ch, flxPlatform::heap_size(),
@@ -167,15 +180,15 @@ void sfeIoTNodeLoRaWAN::displayAppStatus(bool useInfo)
     flxLog__(logLevel, "%cJSON Buffer - Size: %dB Max Used: %dB", pre_ch, jsonBufferSize(), _fmtJSON.getMaxSizeUsed());
     flxLog__(logLevel, "%cSerial Output: %s", pre_ch, kLogFormatNames[serialLogType()]);
     flxLog_N("%c    Baud Rate: %d", pre_ch, serialBaudRate());
+    flxLog__(logLevel, "%cSD Card Output: %s", pre_ch, kLogFormatNames[sdCardLogType()]);
 
     // flxLog__(logLevel, "%cSD Card Output: %s", pre_ch, kLogFormatNames[sdCardLogType()]);
 
     // at startup, useInfo == true, the file isn't known, so skip output
-    // if (!useInfo)
-    //     flxLog_N("%c    Current Filename: \t%s", pre_ch,
-    //              _theOutputFile.currentFilename().length() == 0 ? "<none>" :
-    //              _theOutputFile.currentFilename().c_str());
-    // flxLog_N("%c    Rotate Period: %d Hours", pre_ch, _theOutputFile.rotatePeriod());
+    if (!useInfo)
+        flxLog_N("%c    Current Filename: \t%s", pre_ch,
+                 _theOutputFile.currentFilename().length() == 0 ? "<none>" : _theOutputFile.currentFilename().c_str());
+    flxLog_N("%c    Rotate Period: %d Hours", pre_ch, _theOutputFile.rotatePeriod());
 
     flxLog_N("");
 

sfeIoTNodeLoRaWAN/sfeIoTNodeLoRaWANSetup.cpp

@@ -88,4 +88,38 @@ void sfeIoTNodeLoRaWAN::setupENS160(void)
         flxLog_I(F("%s: compensation values applied from %s"), pENS160->name(), pSHTC3->name());
         return;
     }
+}
+
+//---------------------------------------------------------------------------
+// setupSDCard()
+//
+// Set's up the SD card subsystem and the objects/systems that use it.
+bool sfeIoTNodeLoRaWAN::setupSDCard(void)
+{
+    
+    // setup output to the SD card
+    if (_theSDCard.initialize())
+    {
+
+        _theOutputFile.setName("Data File", "Output file rotation manager");
+
+        // SD card is available - lets setup output for it
+        // Add the filesystem to the file output/rotation object
+        _theOutputFile.setFileSystem(_theSDCard);
+
+        // setup our file rotation parameters
+        _theOutputFile.filePrefix = "sfe";
+        _theOutputFile.startNumber = 1;
+        _theOutputFile.rotatePeriod(24); // one day
+
+        // add the file output to the CSV output.
+        //_fmtCSV.add(_theOutputFile);
+
+        // have the CSV format driver listen to the new file event. This
+        // will cause a header to be written next cycle.
+        flxRegisterEventCB(flxEvent::kOnNewFile, &_fmtCSV, &flxFormatCSV::output_header);
+
+        return true;
+    }
+    return false;
 }

sfeIoTNodeLoRaWAN/sfeNLBoard.h

@@ -19,6 +19,9 @@ const uint8_t kNLBoardUserButton = 24;
 // 3v3 pin
 // const uint8_t kNLBoardEn3v3_SW = 32;
 
+// SD Card CS Ping
+const uint8_t kNLBoardSDCardCSPin = 13;
+
 // LED Built in
 const uint8_t kNLBoardLEDBuiltin = 25;
 

sfeIoTNodeLoRaWAN/sfeNLVersion.h

@@ -16,13 +16,13 @@
 #define kDLVersionNumberMajor 1
 
 // Minor version number
-#define kDLVersionNumberMinor 0
+#define kDLVersionNumberMinor 1
 
 // Point version number
-#define kDLVersionNumberPoint 1
+#define kDLVersionNumberPoint 0
 
 // Version string description
-#define kDLVersionDescriptor "RC4"
+#define kDLVersionDescriptor "RC1"
 
 // app name/class ID string
 #define kDLAppClassNameID "SFE-IOT-NODE_LORAWAN"