Commented 'fox-rio-modify'

Commented the files in the 'fox-rio-modify' folder.

Author: tjohnston-softdev

changelog.md

@@ -1,41 +1,7 @@
 # Changelog
 
 **Commented Files**
-* ./databases/
-	* device.database.js
-* ./fox-devices/
-	* device.settings.js
-	* _classes/
-		* device.class.js
-		* device-model.class.js
-	* remote_io/
-		* advantech.models.js
-		* moxa.models.js
-		* remote_io.settings.js
-		* remote-io-factories.js
-		* remote-io.index.js
-		* sonoff.models.js
-* node-red-settings.js
-* service.main.js
-* settings.js
-
----
-
-**./fox-devices/remote_io/remote-io-factories.js**
-* These variables are declared and assigned separately:
-	* createRemoteIoModule
-		* storedDeviceObject
-		* connectedDeviceObject
-	* registerRemoteIoNodeCallback
-		* ioSet
-		* parsedPrefix
-		* parsedIndex
-		* registerFunction
-
----
-
-**./service.main.js - getHealth**
-* These variables are declared and assigned separately:
-	* envFunc
-	* databaseFunc
-	* logFunc
+* ./fox-rio-modify/
+	* rm-add-new.js
+	* rm-delete-existing.js
+	* rm-update-existing.js

fox-rio-modify/rm-add-new.js

@@ -1,23 +1,33 @@
+// Script adds Remote IO device to database.
+
+
 const rioEntryHelp = require("../fox-custom/rio-entry-help");
 const rioDeviceStatus = require("../fox-custom/rio-device-status");
 
+
+// Main function.
 function addNewDeviceEntry(inpDeviceObj, rioDatabase, runDeviceList, addNewCallback)
 {
+	// Validate input.
 	rioEntryHelp.checkInputType(inpDeviceObj, function (inpTypeErr, inpTypeRes)
 	{
 		if (inpTypeErr !== null)
 		{
+			// Input error.
 			return addNewCallback(inpTypeErr, null);
 		}
 		else
 		{
+			// Prepare input.
 			rioEntryHelp.setMaker(inpDeviceObj);
 			handleDeviceEntryCreation(inpDeviceObj, rioDatabase, runDeviceList, addNewCallback);
 		}
 	});
 }
 
 
+
+// Prepare database entry input.
 function handleDeviceEntryCreation(inpDevice, rioDbaseObject, runDevices, entryCreationCallback)
 {
 	var newStoredDevice = rioEntryHelp.createStoredDevice(inpDevice);
@@ -26,30 +36,36 @@ function handleDeviceEntryCreation(inpDevice, rioDbaseObject, runDevices, entryC
 	{
 		if (eCreateErr !== null)
 		{
+			// Error
 			return entryCreationCallback(eCreateErr, null);
 		}
 		else
 		{
+			// Preperation successful.
 			insertNewDeviceObject(inpDevice, newStoredDevice.modelObject, rioDbaseObject, runDevices, entryCreationCallback);
 		}
 	});
 }
 
 
+// Insert entry into database.
 function insertNewDeviceObject(origInput, prepInput, rioDbaseObj, runDevListObject, insertNewCallback)
 {	
 	rioDbaseObj.createDeviceEntity(prepInput, function (insertEntryErr, insertEntryRes)
 	{
 		if (insertEntryErr !== null)
 		{
+			// Insert error.
 			return insertNewCallback(insertEntryErr, null);
 		}
 		else if (prepInput.isEnabled === true)
 		{
+			// Enable new device.
 			rioDeviceStatus.enableDevice(insertEntryRes, rioDbaseObj, runDevListObject, insertNewCallback);
 		}
 		else
 		{
+			// Success without enable.
 			return insertNewCallback(null, insertEntryRes);
 		}
 	});

fox-rio-modify/rm-delete-existing.js

@@ -1,3 +1,6 @@
+// Script deletes existing Remote IO device from database.
+
+
 const rioDeviceStatus = require("../fox-custom/rio-device-status");
 
 
@@ -9,10 +12,12 @@ function deleteDeviceEntry(inpDeleteID, inpPerm, rioDatabase, runDeviceList, dro
 	{
 		if (deleteDeviceErr !== null)
 		{
+			// Error.
 			return dropCallback(deleteDeviceErr, null);
 		}
 		else
 		{
+			// Successful.
 			return dropCallback(null, true);
 		}
 	});

fox-rio-modify/rm-update-existing.js

@@ -1,10 +1,15 @@
+// Script updates existing Remote IO device in database.
+
 const series = require("run-series");
 const rioEntryHelp = require("../fox-custom/rio-entry-help");
 const rioDeviceStatus = require("../fox-custom/rio-device-status");
 
 
+
+// Main function.
 function updateExistingDeviceEntry(updatedDeviceObj, rioDatabase, runDeviceList, updateExistingCallback)
 {
+	// Validate input
 	series(
 	[
 		rioEntryHelp.checkInputType.bind(null, updatedDeviceObj),
@@ -13,18 +18,25 @@ function updateExistingDeviceEntry(updatedDeviceObj, rioDatabase, runDeviceList,
 	],
 	function (existDeviceErr, existDeviceRes)
 	{
+		// Validation complete.
 		if (existDeviceErr !== null)
 		{
+			// Error.
 			return updateExistingCallback(existDeviceErr, null);
 		}
 		else
 		{
+			// Successful.
 			handleUpdateCreation(updatedDeviceObj, rioDatabase, runDeviceList, updateExistingCallback);
 		}
 	});
 }
 
 
+
+
+
+// Prepare update input.
 function handleUpdateCreation(updatedDevice, rioDbaseObject, runDevices, entryCreationCallback)
 {
 	var modifiedStoredDevice = rioEntryHelp.createStoredDevice(updatedDevice);
@@ -33,31 +45,38 @@ function handleUpdateCreation(updatedDevice, rioDbaseObject, runDevices, entryCr
 	{
 		if (eCreateErr !== null)
 		{
+			// Error.
 			return entryCreationCallback(eCreateErr, null);
 		}
 		else
 		{
+			// Successful.
 			saveDeviceChanges(updatedDevice.id, modifiedStoredDevice.modelObject, rioDbaseObject, runDevices, entryCreationCallback);
 		}
 	});
 }
 
 
+// Save device changes.
 function saveDeviceChanges(newIdString, newDataObject, rioDbaseObj, runDevListObject, saveCallback)
 {
+	// Call UPDATE.
 	rioDbaseObj.updateDeviceEntity(newIdString, newDataObject, function (saveChangeErr, saveChangeRes)
 	{
 		if (saveChangeErr !== null)
 		{
+			// Update error.
 			return saveCallback(saveChangeErr, null);
 		}
 		else if (newDataObject.isEnabled === true)
 		{
+			// Refresh device.
 			rioDeviceStatus.disableDevice(newIdString, runDevListObject);
 			rioDeviceStatus.enableDevice(newIdString, rioDbaseObj, runDevListObject, saveCallback);
 		}
 		else
 		{
+			// Disable device.
 			rioDeviceStatus.disableDevice(newIdString, runDevListObject);
 			return saveCallback(null, newIdString);
 		}