Bring Portal Core and Mobile Control into Essentials

PepperDash.Essentials.4Series.sln

@@ -4,10 +4,37 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 VisualStudioVersion = 17.4.33213.308
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PepperDash.Essentials.Devices.Common", "src\PepperDash.Essentials.Devices.Common\PepperDash.Essentials.Devices.Common.csproj", "{53E204B7-97DD-441D-A96C-721DF014DF82}"
+	ProjectSection(ProjectDependencies) = postProject
+		{E5336563-1194-501E-BC4A-79AD9283EF90} = {E5336563-1194-501E-BC4A-79AD9283EF90}
+	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PepperDash.Essentials", "src\PepperDash.Essentials\PepperDash.Essentials.csproj", "{CB3B11BA-625C-4D35-B663-FDC5BE9A230E}"
+	ProjectSection(ProjectDependencies) = postProject
+		{E5336563-1194-501E-BC4A-79AD9283EF90} = {E5336563-1194-501E-BC4A-79AD9283EF90}
+	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PepperDash.Essentials.Core", "src\PepperDash.Essentials.Core\PepperDash.Essentials.Core.csproj", "{3D192FED-8FFC-4CB5-B5F7-BA307ABA254B}"
+	ProjectSection(ProjectDependencies) = postProject
+		{E5336563-1194-501E-BC4A-79AD9283EF90} = {E5336563-1194-501E-BC4A-79AD9283EF90}
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Mobile Control", "Mobile Control", "{B24989D7-32B5-48D5-9AE1-5F3B17D25206}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PepperDash.Essentials.MobileControl", "src\PepperDash.Essentials.MobileControl\PepperDash.Essentials.MobileControl.csproj", "{F6D362DE-2256-44B1-927A-8CE4705D839A}"
+	ProjectSection(ProjectDependencies) = postProject
+		{E5336563-1194-501E-BC4A-79AD9283EF90} = {E5336563-1194-501E-BC4A-79AD9283EF90}
+	EndProjectSection
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PepperDash.Essentials.MobileControl.Messengers", "src\PepperDash.Essentials.MobileControl.Messengers\PepperDash.Essentials.MobileControl.Messengers.csproj", "{B438694F-8FF7-464A-9EC8-10427374471F}"
+	ProjectSection(ProjectDependencies) = postProject
+		{E5336563-1194-501E-BC4A-79AD9283EF90} = {E5336563-1194-501E-BC4A-79AD9283EF90}
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Essentials", "Essentials", "{AD98B742-8D85-481C-A69D-D8D8ABED39EA}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Core", "Core", "{02EA681E-C7D8-13C7-8484-4AC65E1B71E8}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PepperDash.Core", "src\PepperDash.Core\PepperDash.Core.csproj", "{E5336563-1194-501E-BC4A-79AD9283EF90}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -34,10 +61,36 @@ Global
 		{3D192FED-8FFC-4CB5-B5F7-BA307ABA254B}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{3D192FED-8FFC-4CB5-B5F7-BA307ABA254B}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{3D192FED-8FFC-4CB5-B5F7-BA307ABA254B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F6D362DE-2256-44B1-927A-8CE4705D839A}.Debug 4.7.2|Any CPU.ActiveCfg = Debug|Any CPU
+		{F6D362DE-2256-44B1-927A-8CE4705D839A}.Debug 4.7.2|Any CPU.Build.0 = Debug|Any CPU
+		{F6D362DE-2256-44B1-927A-8CE4705D839A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F6D362DE-2256-44B1-927A-8CE4705D839A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F6D362DE-2256-44B1-927A-8CE4705D839A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F6D362DE-2256-44B1-927A-8CE4705D839A}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B438694F-8FF7-464A-9EC8-10427374471F}.Debug 4.7.2|Any CPU.ActiveCfg = Debug|Any CPU
+		{B438694F-8FF7-464A-9EC8-10427374471F}.Debug 4.7.2|Any CPU.Build.0 = Debug|Any CPU
+		{B438694F-8FF7-464A-9EC8-10427374471F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B438694F-8FF7-464A-9EC8-10427374471F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B438694F-8FF7-464A-9EC8-10427374471F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B438694F-8FF7-464A-9EC8-10427374471F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{E5336563-1194-501E-BC4A-79AD9283EF90}.Debug 4.7.2|Any CPU.ActiveCfg = Debug|Any CPU
+		{E5336563-1194-501E-BC4A-79AD9283EF90}.Debug 4.7.2|Any CPU.Build.0 = Debug|Any CPU
+		{E5336563-1194-501E-BC4A-79AD9283EF90}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{E5336563-1194-501E-BC4A-79AD9283EF90}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{E5336563-1194-501E-BC4A-79AD9283EF90}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{E5336563-1194-501E-BC4A-79AD9283EF90}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{53E204B7-97DD-441D-A96C-721DF014DF82} = {AD98B742-8D85-481C-A69D-D8D8ABED39EA}
+		{CB3B11BA-625C-4D35-B663-FDC5BE9A230E} = {AD98B742-8D85-481C-A69D-D8D8ABED39EA}
+		{3D192FED-8FFC-4CB5-B5F7-BA307ABA254B} = {AD98B742-8D85-481C-A69D-D8D8ABED39EA}
+		{F6D362DE-2256-44B1-927A-8CE4705D839A} = {B24989D7-32B5-48D5-9AE1-5F3B17D25206}
+		{B438694F-8FF7-464A-9EC8-10427374471F} = {B24989D7-32B5-48D5-9AE1-5F3B17D25206}
+		{E5336563-1194-501E-BC4A-79AD9283EF90} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
+	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {6907A4BF-7201-47CF-AAB1-3597F3B8E1C3}
 	EndGlobalSection

src/Directory.Build.props

@@ -2,10 +2,10 @@
   <PropertyGroup>
     <Version>2.0.0-local</Version>
     <InformationalVersion>$(Version)</InformationalVersion>
-    <Authors>PepperDash Technologies</Authors>
-    <Company>PepperDash Technologies</Company>
+    <Authors>PepperDash Technology</Authors>
+    <Company>PepperDash Technology</Company>
     <Product>PepperDash Essentials</Product>
-    <Copyright>Copyright ©  2023</Copyright>
+    <Copyright>Copyright ©  2025</Copyright>
     <RepositoryUrl>https://github.com/PepperDash/Essentials</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageTags>Crestron; 4series</PackageTags>

src/Directory.Build.targets

@@ -33,6 +33,11 @@
     </Delete>
     <Message Text="Deleted files: '@(DeletedList)'" />
   </Target>
+  <Target Name="Copy CLZ" AfterTargets="SimplSharpPostProcess" Condition="($(ProjectType) == 'Library')">
+    <Message Text="Copying CLZ"></Message>
+    <Move SourceFiles="$(TargetDir)\$(TargetName).clz" DestinationFiles="$(TargetDir)\$(TargetName).$(Version).$(TargetFramework).clz"/>
+    <Copy SourceFiles="$(TargetDir)\$(TargetName).$(Version).$(TargetFramework).clz" DestinationFiles="$(PackageOutputPath)\$(TargetName).$(Version).$(TargetFramework).clz"/>
+  </Target>
   <Target Name="Copy CPZ" AfterTargets="SimplSharpPostProcess" Condition="($(ProjectType) == 'Program' And ( '$(TargetFramework)' != 'net6.0' ) And ( '$(TargetFramework)' != 'net8.0' ))">
     <Message Text="Copying CPZ"></Message>
     <Move SourceFiles="$(TargetDir)$(TargetName).cpz" DestinationFiles="$(TargetDir)$(TargetName).$(Version).$(TargetFramework).cpz" />

src/PepperDash.Core/Comm/CommunicationGather.cs

@@ -0,0 +1,179 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Text.RegularExpressions;
+using Crestron.SimplSharp;
+
+using PepperDash.Core;
+
+
+namespace PepperDash.Core
+{
+	/// <summary>
+	/// Defines the string event handler for line events on the gather
+	/// </summary>
+	/// <param name="text"></param>
+	public delegate void LineReceivedHandler(string text);
+
+	/// <summary>
+	/// Attaches to IBasicCommunication as a text gather
+	/// </summary>
+	public class CommunicationGather
+	{
+		/// <summary>
+		/// Event that fires when a line is received from the IBasicCommunication source.
+		/// The event merely contains the text, not an EventArgs type class.
+		/// </summary>
+		public event EventHandler<GenericCommMethodReceiveTextArgs> LineReceived;
+
+		/// <summary>
+		/// The communication port that this gathers on
+		/// </summary>
+        public ICommunicationReceiver Port { get; private set; }
+
+		/// <summary>
+		/// Default false. If true, the delimiter will be included in the line output
+		/// events
+		/// </summary>
+		public bool IncludeDelimiter { get; set; }
+
+		/// <summary>
+		///	For receive buffer
+		/// </summary>
+		StringBuilder ReceiveBuffer = new StringBuilder();
+
+		/// <summary>
+		/// Delimiter, like it says!
+		/// </summary>
+		char Delimiter;
+
+		string[] StringDelimiters;
+
+		/// <summary>
+		/// Constructor for using a char delimiter
+		/// </summary>
+		/// <param name="port"></param>
+		/// <param name="delimiter"></param>
+		public CommunicationGather(ICommunicationReceiver port, char delimiter)
+		{
+			Port = port;
+			Delimiter = delimiter;
+			port.TextReceived += new EventHandler<GenericCommMethodReceiveTextArgs>(Port_TextReceived);
+		}
+
+		/// <summary>
+		/// Constructor for using a single string delimiter
+		/// </summary>
+		/// <param name="port"></param>
+		/// <param name="delimiter"></param>
+        public CommunicationGather(ICommunicationReceiver port, string delimiter)
+            :this(port, new string[] { delimiter} )
+		{
+		}
+
+        /// <summary>
+        /// Constructor for using an array of string delimiters
+        /// </summary>
+        /// <param name="port"></param>
+        /// <param name="delimiters"></param>
+        public CommunicationGather(ICommunicationReceiver port, string[] delimiters)
+        {
+            Port = port;
+            StringDelimiters = delimiters;
+            port.TextReceived += Port_TextReceivedStringDelimiter;
+        }
+
+		/// <summary>
+		/// Disconnects this gather from the Port's TextReceived event. This will not fire LineReceived
+		/// after the this call.
+		/// </summary>
+		public void Stop()
+		{
+			Port.TextReceived -= Port_TextReceived;
+			Port.TextReceived -= Port_TextReceivedStringDelimiter;
+		}
+
+		/// <summary>
+		/// Handler for raw data coming from port 
+		/// </summary>
+		void Port_TextReceived(object sender, GenericCommMethodReceiveTextArgs args)
+		{
+			var handler = LineReceived;
+			if (handler != null)
+			{
+				ReceiveBuffer.Append(args.Text);
+				var str = ReceiveBuffer.ToString();
+				var lines = str.Split(Delimiter);
+				if (lines.Length > 0)
+				{
+					for (int i = 0; i < lines.Length - 1; i++)
+					{
+						string strToSend = null;
+						if (IncludeDelimiter)
+							strToSend = lines[i] + Delimiter;
+						else
+							strToSend = lines[i];
+						handler(this, new GenericCommMethodReceiveTextArgs(strToSend));
+					}
+					ReceiveBuffer = new StringBuilder(lines[lines.Length - 1]);
+				}
+			}
+		}
+
+		/// <summary>
+		/// 
+		/// </summary>
+		/// <param name="sender"></param>
+		/// <param name="args"></param>
+		void Port_TextReceivedStringDelimiter(object sender, GenericCommMethodReceiveTextArgs args)
+		{
+			var handler = LineReceived;
+			if (handler != null)
+			{
+				// Receive buffer should either be empty or not contain the delimiter
+				// If the line does not have a delimiter, append the 
+				ReceiveBuffer.Append(args.Text);
+				var str = ReceiveBuffer.ToString();
+
+                // Case: Receiving DEVICE get version\x0d\0x0a+OK "value":"1234"\x0d\x0a
+
+                // RX: DEV
+                //  Split: (1) "DEV"
+                // RX: I
+                //  Split: (1) "DEVI"
+                // RX: CE get version
+                //  Split: (1) "DEVICE get version"
+                // RX: \x0d\x0a+OK "value":"1234"\x0d\x0a
+                //  Split: (2) DEVICE get version, +OK "value":"1234"
+
+                // Iterate the delimiters and fire an event for any matching delimiter
+                foreach (var delimiter in StringDelimiters)
+                {
+                    var lines = Regex.Split(str, delimiter);
+                    if (lines.Length == 1)
+                        continue;
+
+                    for (int i = 0; i < lines.Length - 1; i++)
+                    {
+                        string strToSend = null;
+                        if (IncludeDelimiter)
+                            strToSend = lines[i] + delimiter;
+                        else
+                            strToSend = lines[i];
+                        handler(this, new GenericCommMethodReceiveTextArgs(strToSend, delimiter));
+                    }
+                    ReceiveBuffer = new StringBuilder(lines[lines.Length - 1]);          
+                }
+			}
+		}
+
+		/// <summary>
+		/// Deconstructor.  Disconnects from port TextReceived events.
+		/// </summary>
+		~CommunicationGather()
+		{
+			Stop();
+		}
+	}
+}