Extracting MicInfo to separate ElocConfig.hpp file

* No code changes, only movement

Author: LIFsCode

eloc610LowPowerPartition/src/ElocConfig.cpp

@@ -0,0 +1,89 @@
+/*
+ * Created on Wed Apr 26 2023
+ *
+ * Project: International Elephant Project (Wildlife Conservation International)
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 2023 Fabian Lindner
+ * based on the work of @tbgilson (https://github.com/tbgilson)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+ * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+
+#include <FS.h>
+#include "SPIFFS.h"
+
+//BUGME: encapsulate these in a struct & implement a getter
+String gMicType="ns";
+String gMicBitShift="11";
+String gMicGPSCoords="ns";
+String gMicPointingDirectionDegrees="ns";
+String gMicHeight="ns";
+String gMicMountType="ns";
+String gMicBluetoothOnOrOff="on";
+
+
+
+void writeMicInfo() {
+  File file2 = SPIFFS.open("/micinfo.txt", FILE_WRITE);
+  
+  file2.print(gMicType+'\n');
+  file2.print(gMicBitShift+'\n');
+  file2.print(gMicGPSCoords+'\n');
+  file2.print(gMicPointingDirectionDegrees+'\n');
+  file2.print(gMicHeight+'\n');
+  file2.print(gMicMountType+'\n');
+  file2.print(gMicBluetoothOnOrOff+'\n');
+  file2.close();
+  Serial.println("micinfo: "+gMicType+"  "+gMicBitShift+"  "+gMicGPSCoords+"  "+gMicPointingDirectionDegrees+" "+gMicHeight+" "+gMicMountType+" "+gMicBluetoothOnOrOff);
+
+
+
+
+
+}
+
+
+void readMicInfo() {
+     if(!(SPIFFS.exists("/micinfo.txt"))){
+
+      printf("micinfo.txt not exist");
+      writeMicInfo();
+      
+        
+
+    }
+    File file2 = SPIFFS.open("/micinfo.txt", FILE_READ);
+    gMicType=file2.readStringUntil('\n');
+    gMicType.trim();
+    gMicBitShift=file2.readStringUntil('\n');
+    gMicBitShift.trim();
+    gMicGPSCoords=file2.readStringUntil('\n');
+    gMicGPSCoords.trim();
+    gMicPointingDirectionDegrees=file2.readStringUntil('\n');
+    gMicPointingDirectionDegrees.trim();
+    gMicHeight=file2.readStringUntil('\n');
+    gMicHeight.trim();
+    gMicMountType=file2.readStringUntil('\n');
+    gMicMountType.trim();
+    gMicBluetoothOnOrOff=file2.readStringUntil('\n');
+    gMicBluetoothOnOrOff.trim();
+
+    file2.close();
+    Serial.println("micinfo: "+gMicType+"  "+gMicBitShift+"  "+gMicGPSCoords+"  "+gMicPointingDirectionDegrees+" "+gMicHeight+" "+gMicMountType+" "+gMicBluetoothOnOrOff);
+ 
+
+}

eloc610LowPowerPartition/src/ElocConfig.hpp

@@ -0,0 +1,43 @@
+/*
+ * Created on Wed Apr 26 2023
+ *
+ * Project: International Elephant Project (Wildlife Conservation International)
+ *
+ * The MIT License (MIT)
+ * Copyright (c) 2023 Fabian Lindner
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+ * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+
+#ifndef ELOCCONFIG_HPP_
+#define ELOCCONFIG_HPP_
+
+
+//BUGME: encapsulate these in a struct & implement a getter
+#include "WString.h"
+extern String gMicType;
+extern String gMicBitShift;
+extern String gMicGPSCoords;
+extern String gMicPointingDirectionDegrees;
+extern String gMicHeight;
+extern String gMicMountType;
+extern String gMicBluetoothOnOrOff;
+
+
+void writeMicInfo();
+void readMicInfo();
+
+#endif // ELOCCONFIG_HPP_

eloc610LowPowerPartition/src/main.cpp

@@ -43,6 +43,7 @@
 #include "lis3dh.h"
 #include "Battery.hpp"
 #include "ElocSystem.hpp"
+#include "ElocConfig.hpp"
 #include "ManualWakeup.hpp"
 
 static const char *TAG = "main";
@@ -62,14 +63,7 @@ int gBufferCount=18;   // so 6*4000 = 24k buf len
 float gVoltage[] = {0.0f, 0.0f, 0.0f, 0.0f};
 //always keep these in same order
 String gLocation = "not_set";
-String gMicType="ns";
-String gMicBitShift="11";
 int gbitShift;
-String gMicGPSCoords="ns";
-String gMicPointingDirectionDegrees="ns";
-String gMicHeight="ns";
-String gMicMountType="ns";
-String gMicBluetoothOnOrOff="on";
 bool gDisableBluetoothWhenRecording=false;
 
 ////// these are the things you can change for now. 
@@ -1434,59 +1428,6 @@ String getSubstring(String data, char separator, int index)
 
 
 
-void writeMicInfo() {
-  File file2 = SPIFFS.open("/micinfo.txt", FILE_WRITE);
-  
-  file2.print(gMicType+'\n');
-  file2.print(gMicBitShift+'\n');
-  file2.print(gMicGPSCoords+'\n');
-  file2.print(gMicPointingDirectionDegrees+'\n');
-  file2.print(gMicHeight+'\n');
-  file2.print(gMicMountType+'\n');
-  file2.print(gMicBluetoothOnOrOff+'\n');
-  file2.close();
-  Serial.println("micinfo: "+gMicType+"  "+gMicBitShift+"  "+gMicGPSCoords+"  "+gMicPointingDirectionDegrees+" "+gMicHeight+" "+gMicMountType+" "+gMicBluetoothOnOrOff);
-
-
-
-
-
-}
-
-
-void readMicInfo() {
-     if(!(SPIFFS.exists("/micinfo.txt"))){
-
-      printf("micinfo.txt not exist");
-      writeMicInfo();
-      
-        
-
-    }
-    File file2 = SPIFFS.open("/micinfo.txt", FILE_READ);
-    gMicType=file2.readStringUntil('\n');
-    gMicType.trim();
-    gMicBitShift=file2.readStringUntil('\n');
-    gMicBitShift.trim();
-    gMicGPSCoords=file2.readStringUntil('\n');
-    gMicGPSCoords.trim();
-    gMicPointingDirectionDegrees=file2.readStringUntil('\n');
-    gMicPointingDirectionDegrees.trim();
-    gMicHeight=file2.readStringUntil('\n');
-    gMicHeight.trim();
-    gMicMountType=file2.readStringUntil('\n');
-    gMicMountType.trim();
-    gMicBluetoothOnOrOff=file2.readStringUntil('\n');
-    gMicBluetoothOnOrOff.trim();
-
-    file2.close();
-    Serial.println("micinfo: "+gMicType+"  "+gMicBitShift+"  "+gMicGPSCoords+"  "+gMicPointingDirectionDegrees+" "+gMicHeight+" "+gMicMountType+" "+gMicBluetoothOnOrOff);
- 
-
-}
-
-
-
 
 void sendSettings() {
   btwrite("#"+String(gSampleRate)+"#"+String(gSecondsPerFile)+"#"+gLocation);