chore: rearrange files

src/Pepperdash Core/Comm/CommunicationExtras.cs

@@ -0,0 +1,240 @@
+
+using Crestron.SimplSharp.CrestronSockets;
+using PepperDash.Core.Interfaces;
+using System;
+using System.Linq;
+using System.Text;
+using System.Text.RegularExpressions;
+
+namespace PepperDash.Core.Comm
+{
+    /// <summary>
+    /// An incoming communication stream
+    /// </summary>
+    public interface ICommunicationReceiver : IKeyed
+    {
+        /// <summary>
+        /// Notifies of bytes received
+        /// </summary>
+        event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
+        /// <summary>
+        /// Notifies of text received
+        /// </summary>
+        event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
+
+        /// <summary>
+        /// Indicates connection status
+        /// </summary>
+        bool IsConnected { get; }
+        /// <summary>
+        /// Connect to the device
+        /// </summary>
+        void Connect();
+        /// <summary>
+        /// Disconnect from the device
+        /// </summary>
+        void Disconnect();
+    }
+
+    /// <summary>
+    /// Represents a device that uses basic connection
+    /// </summary>
+    public interface IBasicCommunication : ICommunicationReceiver
+    {
+        /// <summary>
+        /// Send text to the device
+        /// </summary>
+        /// <param name="text"></param>
+		void SendText(string text);
+
+        /// <summary>
+        /// Send bytes to the device
+        /// </summary>
+        /// <param name="bytes"></param>
+		void SendBytes(byte[] bytes);
+    }
+
+    /// <summary>
+    /// Represents a device that implements IBasicCommunication and IStreamDebugging
+    /// </summary>
+    public interface IBasicCommunicationWithStreamDebugging : IBasicCommunication, IStreamDebugging
+    {
+
+    }
+
+    /// <summary>
+    /// Represents a device with stream debugging capablities
+    /// </summary>
+    public interface IStreamDebugging
+    {
+        /// <summary>
+        /// Object to enable stream debugging
+        /// </summary>
+        CommunicationStreamDebugging StreamDebugging { get; }
+    }
+
+    /// <summary>
+    /// For IBasicCommunication classes that have SocketStatus. GenericSshClient,
+    /// GenericTcpIpClient
+    /// </summary>
+    public interface ISocketStatus : IBasicCommunication
+    {
+        /// <summary>
+        /// Notifies of socket status changes
+        /// </summary>
+		event EventHandler<GenericSocketStatusChageEventArgs> ConnectionChange;
+
+        /// <summary>
+        /// The current socket status of the client
+        /// </summary>
+		SocketStatus ClientStatus { get; }
+    }
+
+    /// <summary>
+    /// Describes a device that implements ISocketStatus and IStreamDebugging
+    /// </summary>
+    public interface ISocketStatusWithStreamDebugging : ISocketStatus, IStreamDebugging
+    {
+
+    }
+
+    /// <summary>
+    /// Describes a device that can automatically attempt to reconnect
+    /// </summary>
+	public interface IAutoReconnect
+    {
+        /// <summary>
+        /// Enable automatic recconnect
+        /// </summary>
+		bool AutoReconnect { get; set; }
+        /// <summary>
+        /// Interval in ms to attempt automatic recconnections
+        /// </summary>
+		int AutoReconnectIntervalMs { get; set; }
+    }
+
+    /// <summary>
+    /// 
+    /// </summary>
+    public enum eGenericCommMethodStatusChangeType
+    {
+        /// <summary>
+        /// Connected
+        /// </summary>
+		Connected,
+        /// <summary>
+        /// Disconnected
+        /// </summary>
+        Disconnected
+    }
+
+    /// <summary>
+    /// This delegate defines handler for IBasicCommunication status changes
+    /// </summary>
+    /// <param name="comm">Device firing the status change</param>
+    /// <param name="status"></param>
+    public delegate void GenericCommMethodStatusHandler(IBasicCommunication comm, eGenericCommMethodStatusChangeType status);
+
+    /// <summary>
+    /// 
+    /// </summary>
+    public class GenericCommMethodReceiveBytesArgs : EventArgs
+    {
+        /// <summary>
+        /// 
+        /// </summary>
+		public byte[] Bytes { get; private set; }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="bytes"></param>
+		public GenericCommMethodReceiveBytesArgs(byte[] bytes)
+        {
+            Bytes = bytes;
+        }
+
+        /// <summary>
+        /// S+ Constructor
+        /// </summary>
+        public GenericCommMethodReceiveBytesArgs() { }
+    }
+
+    /// <summary>
+    /// 
+    /// </summary>
+    public class GenericCommMethodReceiveTextArgs : EventArgs
+    {
+        /// <summary>
+        /// 
+        /// </summary>
+		public string Text { get; private set; }
+        /// <summary>
+        /// 
+        /// </summary>
+        public string Delimiter { get; private set; }
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="text"></param>
+		public GenericCommMethodReceiveTextArgs(string text)
+        {
+            Text = text;
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="text"></param>
+        /// <param name="delimiter"></param>
+        public GenericCommMethodReceiveTextArgs(string text, string delimiter)
+            : this(text)
+        {
+            Delimiter = delimiter;
+        }
+
+        /// <summary>
+        /// S+ Constructor
+        /// </summary>
+        public GenericCommMethodReceiveTextArgs() { }
+    }
+
+
+
+    /// <summary>
+    /// 
+    /// </summary>
+    public class ComTextHelper
+    {
+        /// <summary>
+        /// Gets escaped text for a byte array
+        /// </summary>
+        /// <param name="bytes"></param>
+        /// <returns></returns>
+		public static string GetEscapedText(byte[] bytes)
+        {
+            return string.Concat(bytes.Select(b => string.Format(@"[{0:X2}]", (int)b)).ToArray());
+        }
+
+        /// <summary>
+        /// Gets escaped text for a string
+        /// </summary>
+        /// <param name="text"></param>
+        /// <returns></returns>
+		public static string GetEscapedText(string text)
+        {
+            var bytes = Encoding.GetEncoding(28591).GetBytes(text);
+            return string.Concat(bytes.Select(b => string.Format(@"[{0:X2}]", (int)b)).ToArray());
+        }
+
+        /// <summary>
+        /// Gets debug text for a string
+        /// </summary>
+        /// <param name="text"></param>
+        /// <returns></returns>
+        public static string GetDebugText(string text)
+        {
+            return Regex.Replace(text, @"[^\u0020-\u007E]", a => GetEscapedText(a.Value));
+        }
+    }
+}

src/Pepperdash Core/Interfaces/CoreInterfaces.cs

@@ -0,0 +1,24 @@
+namespace PepperDash.Core.Interfaces
+{
+    /// <summary>
+    /// Unique key interface to require a unique key for the class
+    /// </summary>
+	public interface IKeyed
+    {
+        /// <summary>
+        /// Unique Key
+        /// </summary>
+		string Key { get; }
+    }
+
+    /// <summary>
+    /// Named Keyed device interface. Forces the devie to have a Unique Key and a name. 
+    /// </summary>
+	public interface IKeyName : IKeyed
+    {
+        /// <summary>
+        /// Isn't it obvious :)
+        /// </summary>
+		string Name { get; }
+    }
+}