feature: Add extension methods to format strings with padding, length, and justification options for console notices or more attractive, easy to apply formatting options

Release/1.14.0

.github/workflows/add-issues-to-project.yml

@@ -1,37 +0,0 @@
-name: Add bugs to bugs project
-
-on:
-  issues:
-    types:
-      - opened
-      - labeled
-      
-jobs:
-  check-secret:
-    runs-on: ubuntu-latest
-    outputs:
-      my-key: ${{ steps.my-key.outputs.defined }}
-    steps:
-        - id: my-key
-          if: "${{ env.MY_KEY != '' }}"
-          run: echo "::set-output name=defined::true"
-          env:
-              MY_KEY: ${{ secrets.PROJECT_URL }}
-  throw-error: 
-    name: Check
-    runs-on: ubuntu-latest
-    needs: [check-secret]
-    if: needs.check-secret.outputs.my-key != 'true'
-    steps:
-      - run: echo "The Project URL Repo Secret is empty"
-  add-to-project:
-    name: Add issue to project
-    runs-on: ubuntu-latest
-    needs: [check-secret]
-    if: needs.check-secret.outputs.my-key == 'true'
-    steps:
-      - uses: actions/add-to-project@main
-        with:
-          project-url: ${{ secrets.PROJECT_URL }}
-          github-token: ${{ secrets.GH_PROJECTS_PASSWORD }}
-

essentials-framework/Essentials Core/PepperDashEssentialsBase/Devices/PduInterfaces.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using Crestron.SimplSharp;
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
@@ -8,6 +9,7 @@ namespace PepperDash_Essentials_Core.Devices
     /// <summary>
     /// Interface for any device that is able to control it'spower and has a configurable reboot time
     /// </summary>
+    [Obsolete("PepperDash_Essentials_Core.Devices is Deprecated - use PepperDash.Essentials.Core")]
     public interface IHasPowerCycle : IKeyName, IHasPowerControlWithFeedback
     {
         /// <summary>
@@ -24,6 +26,7 @@ namespace PepperDash_Essentials_Core.Devices
     /// <summary>
     /// Interface for any device that contains a collection of IHasPowerReboot Devices
     /// </summary>
+    [Obsolete("PepperDash_Essentials_Core.Devices is Deprecated - use PepperDash.Essentials.Core")]
     public interface IHasControlledPowerOutlets : IKeyName
     {
         /// <summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Devices/PowerInterfaces.cs

@@ -0,0 +1,87 @@
+using Crestron.SimplSharp;
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// Interface for any device that has a battery that can be monitored
+    /// </summary>
+    public interface IHasBatteryStats : IKeyName
+    {
+        int BatteryPercentage { get; }
+        int BatteryCautionThresholdPercentage { get;  }
+        int BatteryWarningThresholdPercentage { get; }
+        BoolFeedback BatteryIsWarningFeedback { get; }
+        BoolFeedback BatteryIsCautionFeedback { get; }
+        BoolFeedback BatteryIsOkFeedback { get; }
+        IntFeedback BatteryPercentageFeedback { get; }
+    }
+
+    /// <summary>
+    /// Interface for any device that has a battery that can be monitored and the ability to charge and discharge
+    /// </summary>
+    public interface IHasBatteryCharging : IHasBatteryStats
+    {
+        BoolFeedback BatteryIsCharging { get; }
+    }
+
+    /// <summary>
+    /// Interface for any device that has multiple batteries that can be monitored
+    /// </summary>
+    public interface IHasBatteries : IKeyName
+    {
+        ReadOnlyDictionary<string, IHasBatteryStats> Batteries { get; }   
+    }
+
+    public interface IHasBatteryStatsExtended : IHasBatteryStats
+    {
+        int InputVoltage { get; }
+        int OutputVoltage { get; }
+        int InptuCurrent { get; }
+        int OutputCurrent { get; }
+
+        IntFeedback InputVoltageFeedback { get; }
+        IntFeedback OutputVoltageFeedback { get; }
+        IntFeedback InputCurrentFeedback { get; }
+        IntFeedback OutputCurrentFeedback { get; }
+    }
+
+    /// <summary>
+    /// Interface for any device that is able to control its power, has a configurable reboot time, and has batteries that can be monitored
+    /// </summary>
+    public interface IHasPowerCycleWithBattery : IHasPowerCycle, IHasBatteryStats
+    {
+        
+    }
+
+    /// <summary>
+    /// Interface for any device that is able to control it's power and has a configurable reboot time
+    /// </summary>
+    public interface IHasPowerCycle : IKeyName, IHasPowerControlWithFeedback
+    {
+        /// <summary>
+        /// Delay between power off and power on for reboot
+        /// </summary>
+        int PowerCycleTimeMs { get; }
+
+        /// <summary>
+        /// Reboot outlet
+        /// </summary>
+        void PowerCycle();
+    }
+
+    /// <summary>
+    /// Interface for any device that contains a collection of IHasPowerReboot Devices
+    /// </summary>
+    public interface IHasControlledPowerOutlets : IKeyName
+    {
+        /// <summary>
+        /// Collection of IPduOutlets
+        /// </summary>
+        ReadOnlyDictionary<int, IHasPowerCycle> PduOutlets { get; }
+
+    }
+
+
+
+}

essentials-framework/Essentials Core/PepperDashEssentialsBase/Extensions/StringExtensions.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.ComponentModel;
 using Crestron.SimplSharp;
 
 namespace PepperDash.Essentials.Core
@@ -20,5 +21,109 @@ namespace PepperDash.Essentials.Core
         {
             return string.IsNullOrEmpty(s) ? newString : s;
         }
+
+        /// <summary>
+        /// Formats string to meet specified parameters
+        /// </summary>
+        /// <param name="inputString">string to be formatted</param>
+        /// <param name="outputStringLength">length of output string</param>
+        /// <param name="padCharacter">character to pad string with to reach desired output length</param>
+        /// <param name="justification">Justification of input string with regards to the overall string</param>
+        /// <param name="separateInput">If true, seperate input string from pad characters with a single space</param>
+        /// <returns></returns>
+        public static string AutoPadAndJustify(this string inputString, int outputStringLength, char padCharacter,
+                    AutoPadJustification justification, bool separateInput)
+        {
+            var returnString = inputString;
+            var justifiedAndSeparateLength = (
+                separateInput
+                    ? (justification == AutoPadJustification.Center ? 2 : 1)
+                    : 0);
+            if (outputStringLength <= inputString.Length + justifiedAndSeparateLength) return returnString;
+            var fillLength = outputStringLength - inputString.Length - justifiedAndSeparateLength;
+            switch (justification)
+            {
+                case (AutoPadJustification.Left):
+                    {
+                        returnString =
+                            inputString +
+                            new string(' ', separateInput ? 1 : 0) +
+                            new string(padCharacter, fillLength);
+                        break;
+                    }
+                case (AutoPadJustification.Right):
+                    {
+                        returnString =
+                            new string(padCharacter, fillLength) +
+                            new string(' ', separateInput ? 1 : 0) +
+                            inputString;
+                        break;
+                    }
+                case (AutoPadJustification.Center):
+                    {
+                        var halfFill = fillLength / 2;
+                        returnString =
+                            new string(padCharacter, halfFill + (fillLength % 2)) +
+                            new string(' ', separateInput ? 1 : 0) +
+                            inputString +
+                            new string(' ', separateInput ? 1 : 0) +
+                            new string(padCharacter, halfFill);
+                        break;
+                    }
+            }
+            return returnString;
+        }
+
+        /// <summary>
+        /// Formats string to meet specified parameters
+        /// </summary>
+        /// <param name="inputString">string to be formatted</param>
+        /// <param name="options">String formatting options</param>
+        /// <returns></returns>
+        public static string AutoPadAndJustify(this string inputString, AutoPadJustificationOptions options)
+        {
+            if (options == null)
+                return inputString;
+
+            var outputStringLength = options.OutputStringLength;
+            var padCharacter = options.PadCharacter;
+            var justification = options.Justification;
+            var separateInput = options.SeparateInput;
+
+
+
+            return AutoPadAndJustify(inputString, outputStringLength, padCharacter, justification,
+                separateInput);
+        }
+    }
+
+    public enum AutoPadJustification
+    {
+        Center,
+        Left,
+        Right
+    }
+
+    /// <summary>
+    /// Options for setting AutoPadJustification
+    /// </summary>
+    public class AutoPadJustificationOptions
+    {
+        /// <summary>
+        /// Text Justification for the string, relative to the length
+        /// </summary>
+        public AutoPadJustification Justification { get; set; }
+        /// <summary>
+        /// If true, separate input string from pad characters by a single ' ' character
+        /// </summary>
+        public bool SeparateInput { get; set; }
+        /// <summary>
+        /// Pad character to be inserted
+        /// </summary>
+        public char PadCharacter { get; set; }
+        /// <summary>
+        /// Total length of the output string
+        /// </summary>
+        public int OutputStringLength { get; set; }
     }
 }

essentials-framework/Essentials Core/PepperDashEssentialsBase/File/FileIO.cs

@@ -21,35 +21,37 @@ namespace PepperDash.Essentials.Core
 		/// </summary>
 		/// <param name="fileName"></param>
 		/// <returns></returns>
-		public static FileInfo[] GetFiles(string fileName)
-		{
-			DirectoryInfo dirInfo = new DirectoryInfo(Path.GetDirectoryName(fileName));
-			var files = dirInfo.GetFiles(Path.GetFileName(fileName));
-			Debug.Console(0, "FileIO found: {0}, {1}", files.Count(), fileName);
-			if (files.Count() > 0)
-			{
-				return files;
-			}
-			else
-			{
-				return null;
-			}
-		}
+        public static FileInfo[] GetFiles(string fileName)
+        {
+            string fullFilePath = Global.FilePathPrefix + fileName;
+            DirectoryInfo dirInfo = new DirectoryInfo(Path.GetDirectoryName(fullFilePath));
+            var files = dirInfo.GetFiles(Path.GetFileName(fullFilePath));
+            Debug.Console(0, "FileIO found: {0}, {1}", files.Count(), fullFilePath);
+            if (files.Count() > 0)
+            {
+                return files;
+            }
+            else
+            {
+                return null;
+            }
+        }
 
-		public static FileInfo GetFile(string fileName)
-		{
-			DirectoryInfo dirInfo = new DirectoryInfo(Path.GetDirectoryName(fileName));
-			var files = dirInfo.GetFiles(Path.GetFileName(fileName));
-			Debug.Console(0, "FileIO found: {0}, {1}", files.Count(), fileName);
-			if (files.Count() > 0)
-			{
-				return files.FirstOrDefault();
-			}
-			else
-			{
-				return null;
-			}
-		}
+        public static FileInfo GetFile(string fileName)
+        {
+            string fullFilePath = Global.FilePathPrefix + fileName;
+            DirectoryInfo dirInfo = new DirectoryInfo(Path.GetDirectoryName(fullFilePath));
+            var files = dirInfo.GetFiles(Path.GetFileName(fullFilePath));
+            Debug.Console(0, "FileIO found: {0}, {1}", files.Count(), fullFilePath);
+            if (files.Count() > 0)
+            {
+                return files.FirstOrDefault();
+            }
+            else
+            {
+                return null;
+            }
+        }
 
 
 		/// <summary>
@@ -81,7 +83,7 @@ namespace PepperDash.Essentials.Core
 			{
 				if (fileLock.TryEnter())
 				{
-					DirectoryInfo dirInfo = new DirectoryInfo(file.Name);
+					DirectoryInfo dirInfo = new DirectoryInfo(file.DirectoryName);
 					Debug.Console(2, "FileIO Getting Data {0}", file.FullName);
 
 					if (File.Exists(file.FullName))
@@ -202,7 +204,7 @@ namespace PepperDash.Essentials.Core
 		public static void WriteDataToFile(string data, string filePath)
 		{
 			Thread _WriteFileThread;
-			_WriteFileThread = new Thread((O) => _WriteFileMethod(data, filePath), null, Thread.eThreadStartOptions.CreateSuspended);
+            _WriteFileThread = new Thread((O) => _WriteFileMethod(data, Global.FilePathPrefix + "/" + filePath), null, Thread.eThreadStartOptions.CreateSuspended);
 			_WriteFileThread.Priority = Thread.eThreadPriority.LowestPriority;
 			_WriteFileThread.Start();
 			Debug.Console(0, Debug.ErrorLogLevel.Notice, "New WriteFile Thread");
@@ -217,7 +219,8 @@ namespace PepperDash.Essentials.Core
 			{
 				if (fileLock.TryEnter())
 				{
-					using (StreamWriter sw = new StreamWriter(filePath))
+
+                    using (StreamWriter sw = new StreamWriter(filePath))
 					{
 						sw.Write(data);
 						sw.Flush();

essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj

@@ -200,6 +200,7 @@
     <Compile Include="Crestron IO\Relay\GenericRelayDevice.cs" />
     <Compile Include="Crestron IO\Relay\ISwitchedOutput.cs" />
     <Compile Include="Crestron IO\StatusSign\StatusSignController.cs" />
+    <Compile Include="Devices\PowerInterfaces.cs" />
     <Compile Include="Web\RequestHandlers\AppDebugRequestHandler.cs" />
     <Compile Include="Web\RequestHandlers\GetFeedbacksForDeviceRequestHandler.cs" />
     <Compile Include="Web\EssentialsWebApiHelpers.cs" />

essentials-framework/Essentials DM/Essentials_DM/Chassis/DmBladeChassisController.cs

@@ -22,7 +22,7 @@ namespace PepperDash.Essentials.DM
     /// Builds a controller for basic DM-RMCs with Com and IR ports and no control functions
     /// 
     /// </summary>
-    public class DmBladeChassisController : CrestronGenericBridgeableBaseDevice, IDmSwitch, IRoutingNumericWithFeedback
+	public class DmBladeChassisController : CrestronGenericBridgeableBaseDevice, IDmSwitchWithEndpointOnlineFeedback, IRoutingNumericWithFeedback
     {
         private const string NonePortKey = "inputCard0--None";
 

essentials-framework/Essentials DM/Essentials_DM/Chassis/DmChassisController.cs

@@ -23,7 +23,7 @@ namespace PepperDash.Essentials.DM
     /// 
     /// </summary>
     [Description("Wrapper class for all DM-MD chassis variants from 8x8 to 32x32")]
-    public class DmChassisController : CrestronGenericBridgeableBaseDevice, IDmSwitch, IRoutingNumericWithFeedback
+    public class DmChassisController : CrestronGenericBridgeableBaseDevice, IDmSwitchWithEndpointOnlineFeedback, IRoutingNumericWithFeedback
     {
         private const string NonePortKey = "inputCard0--None";
         public DMChassisPropertiesConfig PropertiesConfig { get; set; }

essentials-framework/Essentials DM/Essentials_DM/Endpoints/Receivers/DmRmcHelper.cs

@@ -436,9 +436,9 @@ namespace PepperDash.Essentials.DM
                 }
                 return rx;
             }
-            else if (parentDev is DmChassisController)
+            else if (parentDev is IDmSwitchWithEndpointOnlineFeedback)
             {
-                var controller = parentDev as DmChassisController;
+                var controller = parentDev as IDmSwitchWithEndpointOnlineFeedback;
                 var chassis = controller.Chassis;
                 var num = props.ParentOutputNumber;
                 Debug.Console(1, "Creating DM Chassis device '{0}'. Output number '{1}'.", key, num);

essentials-framework/Essentials DM/Essentials_DM/Endpoints/Transmitters/DmTxHelpers.cs

@@ -127,10 +127,10 @@ namespace PepperDash.Essentials.DM
             BasicDmTxControllerBase tx;
             bool useChassisForOfflineFeedback = false;
 
-            if (parentDev is DmChassisController)
+            if (parentDev is IDmSwitchWithEndpointOnlineFeedback)
             {
                 // Get the Crestron chassis and link stuff up
-                var switchDev = (parentDev as DmChassisController);
+                var switchDev = (parentDev as IDmSwitchWithEndpointOnlineFeedback);
                 var chassis = switchDev.Chassis;
 
                 //Check that the input is within range of this chassis' possible inputs
@@ -179,6 +179,7 @@ namespace PepperDash.Essentials.DM
                     return null;
                 }
             }
+
             if (parentDev is DmpsRoutingController)
             {
                 // Get the DMPS chassis and link stuff up

essentials-framework/Essentials DM/Essentials_DM/IDmSwitch.cs

@@ -16,10 +16,17 @@ using PepperDash.Essentials.Core;
 using PepperDash.Essentials.DM.Config;
 
 namespace PepperDash.Essentials.DM {
-    public interface IDmSwitch {
+    public interface IDmSwitch
+	{
         Switch Chassis { get; }
 
         Dictionary<uint, string> TxDictionary { get; }
         Dictionary<uint, string> RxDictionary { get; }
     }
+
+	public interface IDmSwitchWithEndpointOnlineFeedback : IDmSwitch
+	{
+		Dictionary<uint, BoolFeedback> InputEndpointOnlineFeedbacks { get; }
+		Dictionary<uint, BoolFeedback> OutputEndpointOnlineFeedbacks { get; }
+	}
 }