Merge pull request #14 from PepperDash/feature/add-genericqueue-example

Feature/add genericqueue example

.github/scripts/GenerateVersionNumber.ps1

@@ -22,17 +22,21 @@ switch -regex ($Env:GITHUB_REF) {
   }
   '^refs\/heads\/feature\/*.' {
     $phase = 'alpha'
+    $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER
   }
   '^refs\/heads\/release\/*.' {
     $phase = 'rc'
+    $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER
   }
   '^refs\/heads\/development*.' {
     $phase = 'beta'
+    $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER
   }
   '^refs\/heads\/hotfix\/*.' {
     $phase = 'hotfix'
+    $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER
   }
 }
-$newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER
+
 
 Write-Output $newVersionString

.github/workflows/docker.yml

@@ -42,7 +42,7 @@ jobs:
         run: |
           if("$($Env:GITHUB_REF)".contains("$($Env:RELEASE_BRANCH)")) {
             Write-Host "Setting build type to Release"
-            Write-Output "::set-env name=BUILD_TYPE::Release"
+            Write-Output "echo "BUILD_TYPE='Release'" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append"
           }
       # Fetch all tags
       - name: Fetch tags
@@ -52,7 +52,7 @@ jobs:
         shell: powershell
         run: |
           $version = ./.github/scripts/GenerateVersionNumber.ps1
-          Write-Output "::set-env name=VERSION::$version"
+          Write-Output "echo "VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append"
       # Use the version number to set the version of the assemblies
       - name: Update AssemblyInfo.cs
         shell: powershell

PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs

@@ -0,0 +1,99 @@
+// For Basic SIMPL# Classes
+// For Basic SIMPL#Pro classes
+
+using Crestron.SimplSharpPro.DeviceSupport;
+using Crestron.SimplSharpPro;
+using PepperDash.Core;
+using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core.Bridges;
+
+namespace EssentialsPluginTemplate
+{
+	/// <summary>
+	/// Plugin device
+	/// </summary>
+	/// <remarks>
+	/// Rename the class to match the device plugin being developed.
+	/// </remarks>
+	/// <example>
+	/// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
+	/// </example>
+	public class EssentialsPluginTemplateCrestronDevice : CrestronGenericBridgeableBaseDevice
+    {
+        /// <summary>
+        /// It is often desirable to store the config
+        /// </summary>
+        private EssentialsPluginConfigObjectTemplate _config;
+
+
+        #region Constructor for Devices without IBasicCommunication.  Remove if not needed
+        /// <summary>
+        /// Plugin device constructor for Crestron devices
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="name"></param>
+        /// <param name="config"></param>
+        /// <param name="hardware"></param>
+        public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, GenericBase hardware)
+            : base(key, name, hardware)
+        {
+            Debug.Console(0, this, "Constructing new {0} instance", name);
+
+            // The base class takes care of registering the hardware device for you
+
+            // TODO [ ] Update the constructor as needed for the plugin device being developed
+
+            _config = config;
+        }
+
+        #endregion
+
+
+        #region Overrides of EssentialsBridgeableDevice
+
+        /// <summary>
+        /// Links the plugin device to the EISC bridge
+        /// </summary>
+        /// <param name="trilist"></param>
+        /// <param name="joinStart"></param>
+        /// <param name="joinMapKey"></param>
+        /// <param name="bridge"></param>
+        public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
+        {
+            var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart);
+
+            // This adds the join map to the collection on the bridge
+            if (bridge != null)
+            {
+                bridge.AddJoinMap(Key, joinMap);
+            }
+
+            var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
+
+            if (customJoins != null)
+            {
+                joinMap.SetCustomJoinData(customJoins);
+            }
+
+            Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
+            Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
+
+            // TODO [ ] Implement bridge links as needed
+
+            // links to bridge
+            trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
+
+            trilist.OnlineStatusChange += (o, a) =>
+            {
+                if (!a.DeviceOnLine) return;
+
+                trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
+            };
+        }
+
+
+        #endregion
+
+    }
+}
+

PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs

@@ -5,11 +5,13 @@ using Crestron.SimplSharpPro.DeviceSupport;
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Bridges;
+using PepperDash_Essentials_Core.Queues;
+
 
 namespace EssentialsPluginTemplate
 {
 	/// <summary>
-	/// Plugin device
+	/// Plugin device template for third party devices that use IBasicCommunication
 	/// </summary>
 	/// <remarks>
 	/// Rename the class to match the device plugin being developed.
@@ -17,15 +19,31 @@ namespace EssentialsPluginTemplate
 	/// <example>
 	/// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
 	/// </example>
-	public class EssentialsPluginDeviceTemplate : EssentialsBridgeableDevice
-	{
-		// TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed
+	public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice
+    {
+        /// <summary>
+        /// It is often desirable to store the config
+        /// </summary>
+        private EssentialsPluginConfigObjectTemplate _config;
+
+        /// <summary>
+        /// Provides a queue and dedicated worker thread for processing feedback messages from a device.
+        /// </summary>
+        private GenericQueue ReceiveQueue;
+
+        #region IBasicCommunication Properties and Constructor.  Remove if not needed.
+
+        // TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed
 		private readonly IBasicCommunication _comms;
 		private readonly GenericCommunicationMonitor _commsMonitor;
 
 		// _comms gather for ASCII based API's
 		// TODO [ ] If not using an ASCII based API, delete the properties below
 		private readonly CommunicationGather _commsGather;
+
+        /// <summary>
+        /// Set this value to that of the delimiter used by the API (if applicable)
+        /// </summary>
 		private const string CommsDelimiter = "\r";
 
 		// _comms byte buffer for HEX/byte based API's
@@ -33,7 +51,6 @@ namespace EssentialsPluginTemplate
 		private byte[] _commsByteBuffer = { };
 
 
-		private EssentialsPluginConfigObjectTemplate _config;
 
 		/// <summary>
 		/// Connects/disconnects the comms of the plugin device
@@ -75,13 +92,13 @@ namespace EssentialsPluginTemplate
 		public IntFeedback StatusFeedback { get; private set; }
 
 		/// <summary>
-		/// Plugin device constructor
+		/// Plugin device constructor for devices that need IBasicCommunication
 		/// </summary>
 		/// <param name="key"></param>
 		/// <param name="name"></param>
 		/// <param name="config"></param>
 		/// <param name="comms"></param>
-		public EssentialsPluginDeviceTemplate(string key, string name, EssentialsPluginConfigObjectTemplate config, IBasicCommunication comms)
+		public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, IBasicCommunication comms)
 			: base(key, name)
 		{
 			Debug.Console(0, this, "Constructing new {0} instance", name);
@@ -90,6 +107,8 @@ namespace EssentialsPluginTemplate
 
 			_config = config;
 
+            ReceiveQueue = new GenericQueue(key + "-rxqueue");  // If you need to set the thread priority, use one of the available overloaded constructors.
+
 			ConnectFeedback = new BoolFeedback(() => Connect);
 			OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline);
 			StatusFeedback = new IntFeedback(() => (int)_commsMonitor.Status);
@@ -103,79 +122,28 @@ namespace EssentialsPluginTemplate
 				// device comms is IP **ELSE** device comms is RS232
 				socket.ConnectionChange += socket_ConnectionChange;
 				Connect = true;
-			}
+            }
 
-			// _comms gather for ASCII based API's
-			// TODO [ ] If not using an ASCII based API, delete the properties below
+            #region Communication data event handlers.  Comment out any that don't apply to the API type
+
+            // Only one of the below handlers should be necessary.  
+
+            // _comms gather for any API that has a defined delimiter
+			// TODO [ ] If not using an ASCII based API, remove the line below
 			_commsGather = new CommunicationGather(_comms, CommsDelimiter);
-			AddPostActivationAction(() => _commsGather.LineReceived += Handle_LineRecieved);
+			_commsGather.LineReceived += Handle_LineRecieved;
 
-			// _comms byte buffer for HEX/byte based API's
-			// TODO [ ] If not using an HEX/byte based API, delete the properties below
+			// _comms byte buffer for HEX/byte based API's with no delimiter
+            // TODO [ ] If not using an HEX/byte based API, remove the line below
 			_comms.BytesReceived += Handle_BytesReceived;
-			AddPostActivationAction(() => _comms.BytesReceived += Handle_BytesReceived);
-		}
 
-		#region Overrides of EssentialsBridgeableDevice
+            // _comms byte buffer for HEX/byte based API's with no delimiter
+            // TODO [ ] If not using an HEX/byte based API, remove the line below
+            _comms.TextReceived += Handle_TextReceived;
 
-		/// <summary>
-		/// Links the plugin device to the EISC bridge
-		/// </summary>
-		/// <param name="trilist"></param>
-		/// <param name="joinStart"></param>
-		/// <param name="joinMapKey"></param>
-		/// <param name="bridge"></param>
-		public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
-		{
-			var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart);
+            #endregion
+        }
 
-			// This adds the join map to the collection on the bridge
-			if (bridge != null)
-			{
-				bridge.AddJoinMap(Key, joinMap);
-			}
-
-			var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
-
-			if (customJoins != null)
-			{
-				joinMap.SetCustomJoinData(customJoins);
-			}
-
-			Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
-			Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
-
-			// TODO [ ] Implement bridge links as needed
-
-			// links to bridge
-			trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
-
-			trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig);
-			ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]);
-
-			StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]);
-			OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]);
-
-			UpdateFeedbacks();
-
-			trilist.OnlineStatusChange += (o, a) =>
-			{
-				if (!a.DeviceOnLine) return;
-
-				trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
-				UpdateFeedbacks();
-			};
-		}
-
-		private void UpdateFeedbacks()
-		{
-			// TODO [ ] Update as needed for the plugin being developed
-			ConnectFeedback.FireUpdate();
-			OnlineFeedback.FireUpdate();
-			StatusFeedback.FireUpdate();
-		}
-
-		#endregion
 
 		private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args)
 		{
@@ -186,20 +154,39 @@ namespace EssentialsPluginTemplate
 				StatusFeedback.FireUpdate();
 		}
 
-		// TODO [ ] If not using an ASCII based API, delete the properties below
+		// TODO [ ] If not using an API with a delimeter, delete the method below
 		private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args)
 		{
 			// TODO [ ] Implement method 
-			throw new System.NotImplementedException();
+			
+            // Enqueues the message to be processed in a dedicated thread, but the specified method
+            ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage));
 		}
 
-		// TODO [ ] If not using an HEX/byte based API, delete the properties below
+        // TODO [ ] If not using an HEX/byte based API with no delimeter,  delete the method below
 		private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args)
 		{
 			// TODO [ ] Implement method 
 			throw new System.NotImplementedException();
 		}
 
+        // TODO [ ] If not using an ASCII based API with no delimeter, delete the method below
+        void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e)
+        {
+            // TODO [ ] Implement method 
+            throw new System.NotImplementedException();
+        }
+
+        /// <summary>
+        /// This method should perform any necessary parsing of feedback messages from the device
+        /// </summary>
+        /// <param name="message"></param>
+        void ProcessFeedbackMessage(string message)
+        {
+
+        }
+
+
 		// TODO [ ] If not using an ACII based API, delete the properties below
 		/// <summary>
 		/// Sends text to the device plugin comms
@@ -239,8 +226,74 @@ namespace EssentialsPluginTemplate
 		public void Poll()
 		{
 			// TODO [ ] Update Poll method as needed for the plugin being developed
+            // Example: SendText("getstatus");
 			throw new System.NotImplementedException();
-		}
-	}
+        }
+
+        #endregion
+
+
+        #region Overrides of EssentialsBridgeableDevice
+
+        /// <summary>
+        /// Links the plugin device to the EISC bridge
+        /// </summary>
+        /// <param name="trilist"></param>
+        /// <param name="joinStart"></param>
+        /// <param name="joinMapKey"></param>
+        /// <param name="bridge"></param>
+        public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
+        {
+            var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart);
+
+            // This adds the join map to the collection on the bridge
+            if (bridge != null)
+            {
+                bridge.AddJoinMap(Key, joinMap);
+            }
+
+            var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
+
+            if (customJoins != null)
+            {
+                joinMap.SetCustomJoinData(customJoins);
+            }
+
+            Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
+            Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
+
+            // TODO [ ] Implement bridge links as needed
+
+            // links to bridge
+            trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
+
+            trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig);
+            ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]);
+
+            StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]);
+            OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]);
+
+            UpdateFeedbacks();
+
+            trilist.OnlineStatusChange += (o, a) =>
+            {
+                if (!a.DeviceOnLine) return;
+
+                trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
+                UpdateFeedbacks();
+            };
+        }
+
+        private void UpdateFeedbacks()
+        {
+            // TODO [ ] Update as needed for the plugin being developed
+            ConnectFeedback.FireUpdate();
+            OnlineFeedback.FireUpdate();
+            StatusFeedback.FireUpdate();
+        }
+
+        #endregion
+
+    }
 }
 

PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs

@@ -1,19 +1,20 @@
 using System.Collections.Generic;
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
+using Crestron.SimplSharpPro.UI;
 
 namespace EssentialsPluginTemplate
 {
 	/// <summary>
-	/// Plugin device factory
+	/// Plugin device factory for devices that use IBasicCommunication
 	/// </summary>
 	/// <remarks>
 	/// Rename the class to match the device plugin being developed
 	/// </remarks>
 	/// <example>
-	/// "EssentialsPluginFactoryTemplate" renamed to "SamsungMdcFactory"
+	/// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory"
 	/// </example>
-    public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory<EssentialsPluginDeviceTemplate>
+    public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory<EssentialsPluginTemplateDevice>
     {
 		/// <summary>
 		/// Plugin device factory constructor
@@ -22,14 +23,14 @@ namespace EssentialsPluginTemplate
 		/// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
 		/// </remarks>
 		/// <example>
+ 		/// Set the minimum Essentials Framework Version
 		/// <code>
-		/// // Set the minimum Essentials Framework Version
-		/// MinimumEssentialsFrameworkVersion = "1.5.5";
-		/// // In the constructor we initialize the list with the typenames that will build an instance of this device
-#pragma warning disable 1570
+		/// MinimumEssentialsFrameworkVersion = "1.6.4;
+        /// </code>
+		/// In the constructor we initialize the list with the typenames that will build an instance of this device
+        /// <code>
 		/// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
-#pragma warning restore 1570
-		/// </code>
+        /// </code>
 		/// </example>
         public EssentialsPluginFactoryTemplate()
         {
@@ -54,39 +55,185 @@ namespace EssentialsPluginTemplate
 		/// <seealso cref="PepperDash.Core.eControlMethod"/>
         public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
         {
-            Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type);	       
+            Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type);
 
-			// get the plugin device properties configuration object & check for null 
+            // get the plugin device properties configuration object & check for null 
             var propertiesConfig = dc.Properties.ToObject<EssentialsPluginConfigObjectTemplate>();
-	        if (propertiesConfig == null)
-	        {
-		        Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name);
-		        return null;
-	        }
+            if (propertiesConfig == null)
+            {
+                Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name);
+                return null;
+            }
 
-			// TODO [ ] Discuss with Andrew/Neil on recommended best practice 
-			
-			// Method 1
-			//var username = dc.Properties["control"].Value<TcpSshPropertiesConfig>("tcpSshProperties").Username;
-			//var password = dc.Properties["control"].Value<TcpSshPropertiesConfig>("tcpSshProperties").Password;
-			//var method = dc.Properties["control"].Value<string>("method");
-			
-			// Method 2 - Returns a JValue, has to be casted to string
-	        var username = (string)dc.Properties["control"]["tcpSshProperties"]["username"];
-			var password = (string)dc.Properties["control"]["tcpSshProperties"]["password"];
-	        var method = (string)dc.Properties["control"]["method"];
-	        
-			// build the plugin device comms & check for null
-			// TODO { ] As of PepperDash Core 1.0.41, HTTP and HTTPS are not valid eControlMethods and will throw an exception.
-			var comms = CommFactory.CreateCommForDevice(dc);
-			if (comms == null)
-			{
-				Debug.Console(0, "[{0}] Factory: failed to create comm for {1}", dc.Key, dc.Name);
-				return null;
-			}
+            // attempt build the plugin device comms device & check for null
+            // TODO { ] As of PepperDash Core 1.0.41, HTTP and HTTPS are not valid eControlMethods and will throw an exception.
+            var comms = CommFactory.CreateCommForDevice(dc);
+            if (comms == null)
+            {
+                Debug.Console(1, "[{0}] Factory Notice: No control object present for device {1}", dc.Key, dc.Name);
+                return null;
+            }
+            else
+            {
+                return new EssentialsPluginTemplateDevice(dc.Key, dc.Name, propertiesConfig, comms);
+            }
 
-            return new EssentialsPluginDeviceTemplate(dc.Key, dc.Name, propertiesConfig, comms);
         }
 
     }
-}
+
+    /// <summary>
+    /// Plugin device factory for logic devices that don't communicate
+    /// </summary>
+    /// <remarks>
+    /// Rename the class to match the device plugin being developed
+    /// </remarks>
+    /// <example>
+    /// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory"
+    /// </example>
+    public class EssentialsPluginFactoryLogicDeviceTemplate : EssentialsPluginDeviceFactory<EssentialsPluginTemplateLogicDevice>
+    {
+		/// <summary>
+		/// Plugin device factory constructor
+		/// </summary>
+		/// <remarks>
+		/// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
+		/// </remarks>
+		/// <example>
+ 		/// Set the minimum Essentials Framework Version
+		/// <code>
+		/// MinimumEssentialsFrameworkVersion = "1.6.4;
+        /// </code>
+		/// In the constructor we initialize the list with the typenames that will build an instance of this device
+        /// <code>
+		/// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
+        /// </code>
+		/// </example>
+        public EssentialsPluginFactoryLogicDeviceTemplate()
+        {
+            // Set the minimum Essentials Framework Version
+			// TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against
+			MinimumEssentialsFrameworkVersion = "1.6.4";
+
+            // In the constructor we initialize the list with the typenames that will build an instance of this device
+			// TODO [ ] Update the TypeNames for the plugin being developed
+            TypeNames = new List<string>() { "examplePluginLogicDevice" };
+        }
+        
+		/// <summary>
+        /// Builds and returns an instance of EssentialsPluginTemplateLogicDevice
+		/// </summary>
+		/// <param name="dc">device configuration</param>
+		/// <returns>plugin device or null</returns>
+		/// <remarks>		
+		/// The example provided below takes the device key, name, properties config and the comms device created.
+		/// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device.
+		/// </remarks>
+		/// <seealso cref="PepperDash.Core.eControlMethod"/>
+        public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
+        {
+
+            Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type);
+
+            // get the plugin device properties configuration object & check for null 
+            var propertiesConfig = dc.Properties.ToObject<EssentialsPluginConfigObjectTemplate>();
+            if (propertiesConfig == null)
+            {
+                Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name);
+                return null;
+            }
+
+            var controlConfig = CommFactory.GetControlPropertiesConfig(dc);
+
+            if (controlConfig == null)
+            {
+                return new EssentialsPluginTemplateLogicDevice(dc.Key, dc.Name, propertiesConfig);
+            }
+            else
+            {
+                Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name);
+                return null;
+            }
+        }
+    }
+
+    /// <summary>
+    /// Plugin device factory for Crestron wrapper devices
+    /// </summary>
+    /// <remarks>
+    /// Rename the class to match the device plugin being developed
+    /// </remarks>
+    /// <example>
+    /// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory"
+    /// </example>
+    public class EssentialsPluginFactoryCrestronDeviceTemplate : EssentialsPluginDeviceFactory<EssentialsPluginTemplateCrestronDevice>
+    {
+        /// <summary>
+        /// Plugin device factory constructor
+        /// </summary>
+        /// <remarks>
+        /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
+        /// </remarks>
+        /// <example>
+        /// Set the minimum Essentials Framework Version
+        /// <code>
+        /// MinimumEssentialsFrameworkVersion = "1.6.4;
+        /// </code>
+        /// In the constructor we initialize the list with the typenames that will build an instance of this device
+        /// <code>
+        /// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" };
+        /// </code>
+        /// </example>
+        public EssentialsPluginFactoryCrestronDeviceTemplate()
+        {
+            // Set the minimum Essentials Framework Version
+            // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against
+            MinimumEssentialsFrameworkVersion = "1.7.5";
+
+            // In the constructor we initialize the list with the typenames that will build an instance of this device
+            // TODO [ ] Update the TypeNames for the plugin being developed
+            TypeNames = new List<string>() { "examplePluginCrestronDevice" };
+        }
+
+        /// <summary>
+        /// Builds and returns an instance of EssentialsPluginTemplateCrestronDevice
+        /// </summary>
+        /// <param name="dc">device configuration</param>
+        /// <returns>plugin device or null</returns>
+        /// <remarks>		
+        /// The example provided below takes the device key, name, properties config and the comms device created.
+        /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device.
+        /// </remarks>
+        /// <seealso cref="PepperDash.Core.eControlMethod"/>
+        public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc)
+        {
+
+            Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type);
+
+            // get the plugin device properties configuration object & check for null 
+            var propertiesConfig = dc.Properties.ToObject<EssentialsPluginConfigObjectTemplate>();
+            if (propertiesConfig == null)
+            {
+                Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name);
+                return null;
+            }
+
+            var controlConfig = CommFactory.GetControlPropertiesConfig(dc);
+
+            if (controlConfig == null)
+            {
+                var myTouchpanel = new Tsw760(controlConfig.IpIdInt, Global.ControlSystem);
+
+                return new EssentialsPluginTemplateCrestronDevice(dc.Key, dc.Name, propertiesConfig, myTouchpanel);
+            }
+            else
+            {
+                Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name);
+                return null;
+            }
+        }
+    }
+
+}
+
+          

PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs

@@ -0,0 +1,86 @@
+using Crestron.SimplSharpPro.DeviceSupport;
+using PepperDash.Core;
+using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core.Bridges;
+
+namespace EssentialsPluginTemplate
+{
+	/// <summary>
+	/// Plugin device template for logic devices that don't communicate outside the program
+	/// </summary>
+	/// <remarks>
+	/// Rename the class to match the device plugin being developed.
+	/// </remarks>
+	/// <example>
+    /// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice"
+	/// </example>
+	public class EssentialsPluginTemplateLogicDevice : EssentialsBridgeableDevice
+    {
+        /// <summary>
+        /// It is often desirable to store the config
+        /// </summary>
+        private EssentialsPluginConfigObjectTemplate _config;
+
+        /// <summary>
+        /// Plugin device constructor
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="name"></param>
+        /// <param name="config"></param>
+        public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginConfigObjectTemplate config)
+            : base(key, name)
+        {
+            Debug.Console(0, this, "Constructing new {0} instance", name);
+
+            // TODO [ ] Update the constructor as needed for the plugin device being developed
+
+            _config = config;
+        }
+
+        #region Overrides of EssentialsBridgeableDevice
+
+        /// <summary>
+        /// Links the plugin device to the EISC bridge
+        /// </summary>
+        /// <param name="trilist"></param>
+        /// <param name="joinStart"></param>
+        /// <param name="joinMapKey"></param>
+        /// <param name="bridge"></param>
+        public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
+        {
+            var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart);
+
+            // This adds the join map to the collection on the bridge
+            if (bridge != null)
+            {
+                bridge.AddJoinMap(Key, joinMap);
+            }
+
+            var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
+
+            if (customJoins != null)
+            {
+                joinMap.SetCustomJoinData(customJoins);
+            }
+
+            Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
+            Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
+
+            // TODO [ ] Implement bridge links as needed
+
+            // links to bridge
+            trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
+
+            trilist.OnlineStatusChange += (o, a) =>
+            {
+                if (!a.DeviceOnLine) return;
+
+                trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
+            };
+        }
+
+        #endregion
+
+    }
+}
+

PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj

@@ -46,6 +46,10 @@
     <GenerateSerializationAssemblies>off</GenerateSerializationAssemblies>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="Crestron.SimplSharpPro.UI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll</HintPath>
+    </Reference>
     <Reference Include="Essentials Devices Common, Version=1.6.2.33892, Culture=neutral, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll</HintPath>
@@ -95,6 +99,8 @@
     <Reference Include="System.Data" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="EssentialsPluginTemplateLogicDevice.cs" />
+    <Compile Include="EssentialsPluginTemplateCrestronDevice.cs" />
     <Compile Include="EssentialsPluginTemplateBridgeJoinMap.cs" />
     <Compile Include="EssentialsPluginTemplateConfigObject.cs" />
     <Compile Include="EssentialsPluginTemplateFactory.cs" />

README.md

@@ -8,6 +8,15 @@ Provided under MIT license
 
 Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://github.com/PepperDash/Essentials/wiki/Plugins) article.
 
+This repo contains example classes for the three main categories of devices:
+* `EssentialsPluginTemplateDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc
+* `EssentialsPluginTemplateLogicDevice`:  Used for devices that contain logic, but don't require any communication with third parties outside the program
+* `EssentialsPluginTemplateCrestronDevice`:  Used for devices that represent a piece of Crestron hardware
+
+There are matching factory classes for each of the three categories of devices.  The `EssentialsPluginTemplateConfigObject` should be used as a template and modified for any of the categories of device.  Same goes for the `EssentialsPluginTemplateBridgeJoinMap`.
+
+This also illustrates how a plugin can contain multiple devices.
+
 ## Cloning Instructions
 
 After forking this repository into your own GitHub space, you can create a new repository using this one as the template.  Then you must install the necessary dependencies as indicated below.

packages.config

@@ -1,3 +1,3 @@
 <packages>
-  <package id="PepperDashEssentials" version="1.6.4" targetFramework="net35" allowedVersions="[1.0,2.0)"/>
+  <package id="PepperDashEssentials" version="1.7.5" targetFramework="net35" allowedVersions="[1.0,2.0)"/>
 </packages>