Renamed UtilsRetCode to RaftRetCode

robdobsn · robdobsn · commit 0283002dafac · 2023-06-25T15:13:48.000+01:00
diff --git a/components/ESPOTAUpdate/ESPOTAUpdate.cpp b/components/ESPOTAUpdate/ESPOTAUpdate.cpp
@@ -157,7 +157,7 @@ bool ESPOTAUpdate::fileStreamStart(const char* fileName, size_t fileLen)
 // Firmware update block (handle a firmware data block)
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-UtilsRetCode::RetCode ESPOTAUpdate::fileStreamDataBlock(FileStreamBlock& fileStreamBlock)
+RaftRetCode::RetCode ESPOTAUpdate::fileStreamDataBlock(FileStreamBlock& fileStreamBlock)
 {
     // Get params
     const uint8_t *pBlock = fileStreamBlock.pBlock;
@@ -168,7 +168,7 @@ UtilsRetCode::RetCode ESPOTAUpdate::fileStreamDataBlock(FileStreamBlock& fileStr
     {
         if (!fileStreamStart(fileStreamBlock.filename, 
                     fileStreamBlock.fileLenValid ? fileStreamBlock.fileLen : fileStreamBlock.contentLen))
-            return UtilsRetCode::INVALID_OPERATION;
+            return RaftRetCode::INVALID_OPERATION;
     }
 
     // Check if in progress
@@ -183,18 +183,18 @@ UtilsRetCode::RetCode ESPOTAUpdate::fileStreamDataBlock(FileStreamBlock& fileStr
         {
             _otaDirectInProgress = false;
             LOG_E(MODULE_PREFIX, "esp_ota_write failed! err=0x%x", err);
-            return UtilsRetCode::OTHER_FAILURE;
+            return RaftRetCode::OTHER_FAILURE;
         }
     }
 
     // Check if final
     if (fileStreamBlock.finalBlock)
     {
         if (!firmwareUpdateEnd())
-            return UtilsRetCode::INVALID_DATA;
+            return RaftRetCode::INVALID_DATA;
     }
 
-    return UtilsRetCode::OK;
+    return RaftRetCode::OK;
 }
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -259,7 +259,7 @@ bool ESPOTAUpdate::fileStreamCancelEnd(bool isNormalEnd)
 // Handle the API update
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-UtilsRetCode::RetCode ESPOTAUpdate::fwUpdateAPIPart(FileStreamBlock& fileStreamBlock)
+RaftRetCode::RetCode ESPOTAUpdate::fwUpdateAPIPart(FileStreamBlock& fileStreamBlock)
 {
     // LOG_I(MODULE_PREFIX, "fwUpdateAPIPart %d, %d, %d, %d", contentLen, index, len, finalBlock);
 
@@ -297,7 +297,7 @@ void ESPOTAUpdate::addRestAPIEndpoints(RestAPIEndpointManager& endpointManager)
 }
 
 // ESP Firmware update
-UtilsRetCode::RetCode ESPOTAUpdate::apiESPFirmwarePart(const String& reqStr, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo)
+RaftRetCode::RetCode ESPOTAUpdate::apiESPFirmwarePart(const String& reqStr, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo)
 {
     // Handle with OTA update
 #ifdef DEBUG_ESP_OTA_UPDATE
diff --git a/components/ESPOTAUpdate/ESPOTAUpdate.h b/components/ESPOTAUpdate/ESPOTAUpdate.h
@@ -31,7 +31,7 @@ class ESPOTAUpdate : public SysModBase
 
     // Start/Data/Cancel methods
     virtual bool fileStreamStart(const char* fileName, size_t fileLen) override final;
-    virtual UtilsRetCode::RetCode fileStreamDataBlock(FileStreamBlock& fileStreamBlock) override final;
+    virtual RaftRetCode::RetCode fileStreamDataBlock(FileStreamBlock& fileStreamBlock) override final;
     virtual bool fileStreamCancelEnd(bool isNormalEnd) override final;
 
     // Get debug string
@@ -74,11 +74,11 @@ class ESPOTAUpdate : public SysModBase
     void onDataReceived(uint8_t *pDataReceived, size_t dataReceivedLen);
 
     // API ESP Firmware update
-    UtilsRetCode::RetCode apiESPFirmwarePart(const String& req, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo);
+    RaftRetCode::RetCode apiESPFirmwarePart(const String& req, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo);
     void apiESPFirmwareUpdateDone(const String &reqStr, String &respStr, const APISourceInfo& sourceInfo);
 
     // Direct firmware update
-    virtual UtilsRetCode::RetCode fwUpdateAPIPart(FileStreamBlock& fileStreamBlock);
+    virtual RaftRetCode::RetCode fwUpdateAPIPart(FileStreamBlock& fileStreamBlock);
     void fwUpdateAPIFinal();
     bool firmwareUpdateEnd();
 };
diff --git a/components/FileManager/FileManager.cpp b/components/FileManager/FileManager.cpp
@@ -227,12 +227,12 @@ void FileManager::apiUploadFileComplete(const String &reqStr, String &respStr, c
 // Upload file to file system - part of file
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-UtilsRetCode::RetCode FileManager::apiUploadFileBlock(const String& req, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo)
+RaftRetCode::RetCode FileManager::apiUploadFileBlock(const String& req, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo)
 {
     if (_pProtocolExchange)
         return _pProtocolExchange->handleFileUploadBlock(req, fileStreamBlock, sourceInfo, 
                     FileStreamBase::FILE_STREAM_CONTENT_TYPE_FILE, "");
-    return UtilsRetCode::INVALID_OPERATION;
+    return RaftRetCode::INVALID_OPERATION;
 }
 
 // /////////////////////////////////////////////////////////////////////////////////////////////////////////////////
diff --git a/components/FileManager/FileManager.h b/components/FileManager/FileManager.h
@@ -78,6 +78,6 @@ class FileManager : public SysModBase
     void apiUploadFileComplete(const String &reqStr, String &respStr, const APISourceInfo& sourceInfo);
 
     // Upload file to file system - part of file (from HTTP POST file)
-    UtilsRetCode::RetCode apiUploadFileBlock(const String& req, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo);
+    RaftRetCode::RetCode apiUploadFileBlock(const String& req, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo);
 
 };
diff --git a/components/SerialConsole/SerialConsole.cpp b/components/SerialConsole/SerialConsole.cpp
@@ -383,7 +383,7 @@ bool SerialConsole::sendMsg(CommsChannelMsg& msg)
 // Handle JSON command
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-UtilsRetCode::RetCode SerialConsole::receiveCmdJSON(const char* cmdJSON)
+RaftRetCode::RetCode SerialConsole::receiveCmdJSON(const char* cmdJSON)
 {
     // Extract command from JSON
     ConfigBase jsonInfo(cmdJSON);
@@ -411,18 +411,18 @@ UtilsRetCode::RetCode SerialConsole::receiveCmdJSON(const char* cmdJSON)
             if (err != ESP_OK)
             {
                 LOG_E(MODULE_PREFIX, "receiveCmdJson FAILED to remove uart driver from port %d, err %d", _uartNum, err);
-                return UtilsRetCode::INVALID_DATA;
+                return RaftRetCode::INVALID_DATA;
             }
 
             // Install uart driver            
             err = uart_driver_install((uart_port_t)_uartNum, _rxBufferSize, _txBufferSize, 0, NULL, 0);
             if (err != ESP_OK)
             {
                 LOG_E(MODULE_PREFIX, "receiveCmdJson FAILED to install uart driver to port %d, err %d", _uartNum, err);
-                return UtilsRetCode::INVALID_DATA;
+                return RaftRetCode::INVALID_DATA;
             }
         }
-        return UtilsRetCode::OK;
+        return RaftRetCode::OK;
     }
-    return UtilsRetCode::INVALID_OPERATION;
+    return RaftRetCode::INVALID_OPERATION;
 }
diff --git a/components/SerialConsole/SerialConsole.h b/components/SerialConsole/SerialConsole.h
@@ -53,7 +53,7 @@ class SerialConsole : public SysModBase
     virtual void addCommsChannels(CommsCoreIF& commsCoreIF) override final;
 
     // Handle JSON command
-    virtual UtilsRetCode::RetCode receiveCmdJSON(const char* cmdJSON) override final;
+    virtual RaftRetCode::RetCode receiveCmdJSON(const char* cmdJSON) override final;
 
 public:
     // XON/XOFF hadnling
diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "RaftSysMods",
-  "version": "0.1.14",
+  "version": "0.1.15",
   "description": "System modules for the Raft ESP32 framework",
   "keywords": "esp32, esp32s3, framework",
   "repository": {

Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ bool ESPOTAUpdate::fileStreamStart(const char* fileName, size_t fileLen)`
`157`	`157`	`// Firmware update block (handle a firmware data block)`
`158`	`158`	`/////////////////////////////////////////////////////////////////////////////////////////////////////////////////`
`159`	`159`
`160`		`-UtilsRetCode::RetCode ESPOTAUpdate::fileStreamDataBlock(FileStreamBlock& fileStreamBlock)`
	`160`	`+RaftRetCode::RetCode ESPOTAUpdate::fileStreamDataBlock(FileStreamBlock& fileStreamBlock)`
`161`	`161`	`{`
`162`	`162`	`// Get params`
`163`	`163`	`const uint8_t *pBlock = fileStreamBlock.pBlock;`
`@@ -168,7 +168,7 @@ UtilsRetCode::RetCode ESPOTAUpdate::fileStreamDataBlock(FileStreamBlock& fileStr`
`168`	`168`	`{`
`169`	`169`	`if (!fileStreamStart(fileStreamBlock.filename,`
`170`	`170`	`fileStreamBlock.fileLenValid ? fileStreamBlock.fileLen : fileStreamBlock.contentLen))`
`171`		`- return UtilsRetCode::INVALID_OPERATION;`
	`171`	`+ return RaftRetCode::INVALID_OPERATION;`
`172`	`172`	`}`
`173`	`173`
`174`	`174`	`// Check if in progress`
`@@ -183,18 +183,18 @@ UtilsRetCode::RetCode ESPOTAUpdate::fileStreamDataBlock(FileStreamBlock& fileStr`
`183`	`183`	`{`
`184`	`184`	`_otaDirectInProgress = false;`
`185`	`185`	`LOG_E(MODULE_PREFIX, "esp_ota_write failed! err=0x%x", err);`
`186`		`- return UtilsRetCode::OTHER_FAILURE;`
	`186`	`+ return RaftRetCode::OTHER_FAILURE;`
`187`	`187`	`}`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`// Check if final`
`191`	`191`	`if (fileStreamBlock.finalBlock)`
`192`	`192`	`{`
`193`	`193`	`if (!firmwareUpdateEnd())`
`194`		`- return UtilsRetCode::INVALID_DATA;`
	`194`	`+ return RaftRetCode::INVALID_DATA;`
`195`	`195`	`}`
`196`	`196`
`197`		`- return UtilsRetCode::OK;`
	`197`	`+ return RaftRetCode::OK;`
`198`	`198`	`}`
`199`	`199`
`200`	`200`	`/////////////////////////////////////////////////////////////////////////////////////////////////////////////////`
`@@ -259,7 +259,7 @@ bool ESPOTAUpdate::fileStreamCancelEnd(bool isNormalEnd)`
`259`	`259`	`// Handle the API update`
`260`	`260`	`/////////////////////////////////////////////////////////////////////////////////////////////////////////////////`
`261`	`261`
`262`		`-UtilsRetCode::RetCode ESPOTAUpdate::fwUpdateAPIPart(FileStreamBlock& fileStreamBlock)`
	`262`	`+RaftRetCode::RetCode ESPOTAUpdate::fwUpdateAPIPart(FileStreamBlock& fileStreamBlock)`
`263`	`263`	`{`
`264`	`264`	`// LOG_I(MODULE_PREFIX, "fwUpdateAPIPart %d, %d, %d, %d", contentLen, index, len, finalBlock);`
`265`	`265`
`@@ -297,7 +297,7 @@ void ESPOTAUpdate::addRestAPIEndpoints(RestAPIEndpointManager& endpointManager)`
`297`	`297`	`}`
`298`	`298`
`299`	`299`	`// ESP Firmware update`
`300`		`-UtilsRetCode::RetCode ESPOTAUpdate::apiESPFirmwarePart(const String& reqStr, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo)`
	`300`	`+RaftRetCode::RetCode ESPOTAUpdate::apiESPFirmwarePart(const String& reqStr, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo)`
`301`	`301`	`{`
`302`	`302`	`// Handle with OTA update`
`303`	`303`	`#ifdef DEBUG_ESP_OTA_UPDATE`
Original file line number	Diff line number	Diff line change
`@@ -227,12 +227,12 @@ void FileManager::apiUploadFileComplete(const String &reqStr, String &respStr, c`
`227`	`227`	`// Upload file to file system - part of file`
`228`	`228`	`/////////////////////////////////////////////////////////////////////////////////////////////////////////////////`
`229`	`229`
`230`		`-UtilsRetCode::RetCode FileManager::apiUploadFileBlock(const String& req, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo)`
	`230`	`+RaftRetCode::RetCode FileManager::apiUploadFileBlock(const String& req, FileStreamBlock& fileStreamBlock, const APISourceInfo& sourceInfo)`
`231`	`231`	`{`
`232`	`232`	`if (_pProtocolExchange)`
`233`	`233`	`return _pProtocolExchange->handleFileUploadBlock(req, fileStreamBlock, sourceInfo,`
`234`	`234`	`FileStreamBase::FILE_STREAM_CONTENT_TYPE_FILE, "");`
`235`		`- return UtilsRetCode::INVALID_OPERATION;`
	`235`	`+ return RaftRetCode::INVALID_OPERATION;`
`236`	`236`	`}`
`237`	`237`
`238`	`238`	`// /////////////////////////////////////////////////////////////////////////////////////////////////////////////////`
Original file line number	Diff line number	Diff line change
`@@ -383,7 +383,7 @@ bool SerialConsole::sendMsg(CommsChannelMsg& msg)`
`383`	`383`	`// Handle JSON command`
`384`	`384`	`/////////////////////////////////////////////////////////////////////////////////////////////////////////////////`
`385`	`385`
`386`		`-UtilsRetCode::RetCode SerialConsole::receiveCmdJSON(const char* cmdJSON)`
	`386`	`+RaftRetCode::RetCode SerialConsole::receiveCmdJSON(const char* cmdJSON)`
`387`	`387`	`{`
`388`	`388`	`// Extract command from JSON`
`389`	`389`	`ConfigBase jsonInfo(cmdJSON);`
`@@ -411,18 +411,18 @@ UtilsRetCode::RetCode SerialConsole::receiveCmdJSON(const char* cmdJSON)`
`411`	`411`	`if (err != ESP_OK)`
`412`	`412`	`{`
`413`	`413`	`LOG_E(MODULE_PREFIX, "receiveCmdJson FAILED to remove uart driver from port %d, err %d", _uartNum, err);`
`414`		`- return UtilsRetCode::INVALID_DATA;`
	`414`	`+ return RaftRetCode::INVALID_DATA;`
`415`	`415`	`}`
`416`	`416`
`417`	`417`	`// Install uart driver`
`418`	`418`	`err = uart_driver_install((uart_port_t)_uartNum, _rxBufferSize, _txBufferSize, 0, NULL, 0);`
`419`	`419`	`if (err != ESP_OK)`
`420`	`420`	`{`
`421`	`421`	`LOG_E(MODULE_PREFIX, "receiveCmdJson FAILED to install uart driver to port %d, err %d", _uartNum, err);`
`422`		`- return UtilsRetCode::INVALID_DATA;`
	`422`	`+ return RaftRetCode::INVALID_DATA;`
`423`	`423`	`}`
`424`	`424`	`}`
`425`		`- return UtilsRetCode::OK;`
	`425`	`+ return RaftRetCode::OK;`
`426`	`426`	`}`
`427`		`- return UtilsRetCode::INVALID_OPERATION;`
	`427`	`+ return RaftRetCode::INVALID_OPERATION;`
`428`	`428`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "RaftSysMods",`
`3`		`- "version": "0.1.14",`
	`3`	`+ "version": "0.1.15",`
`4`	`4`	`"description": "System modules for the Raft ESP32 framework",`
`5`	`5`	`"keywords": "esp32, esp32s3, framework",`
`6`	`6`	`"repository": {`