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/EssentialsPluginTemplateBridgeJoinMap.cs

@@ -0,0 +1,101 @@
+using PepperDash.Essentials.Core;
+
+namespace EssentialsPluginTemplate
+{
+	/// <summary>
+	/// Plugin device Bridge Join Map
+	/// </summary>
+	/// <remarks>
+	/// Rename the class to match the device plugin being developed.  Reference Essentials JoinMaps, if one exists for the device plugin being developed
+	/// </remarks>
+	/// <see cref="PepperDash.Essentials.Core.Bridges"/>
+	/// <example>
+	/// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap"
+	/// </example>
+	public class EssentialsPluginBridgeJoinMapTemplate : JoinMapBaseAdvanced
+	{
+		#region Digital
+
+		// TODO [ ] Add digital joins below plugin being developed
+
+		[JoinName("IsOnline")]
+		public JoinDataComplete IsOnline = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 1,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Is Online",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.Digital
+			});
+
+		[JoinName("Connect")]
+		public JoinDataComplete Connect = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 2,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Connect (Held)/Disconnect (Release) & corresponding feedback",
+				JoinCapabilities = eJoinCapabilities.ToFromSIMPL,
+				JoinType = eJoinType.Digital
+			});		
+
+		#endregion
+
+
+		#region Analog
+
+		// TODO [ ] Add analog joins below plugin being developed
+
+		[JoinName("Status")]
+		public JoinDataComplete Status = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 1,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Socket Status",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.Analog
+			});
+
+		#endregion
+
+
+		#region Serial
+
+		// TODO [ ] Add serial joins below plugin being developed
+
+		public JoinDataComplete DeviceName = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 1,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Device Name",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.Serial
+			});
+
+		#endregion
+
+		/// <summary>
+		/// Plugin device BridgeJoinMap constructor
+		/// </summary>
+		/// <param name="joinStart">This will be the join it starts on the EISC bridge</param>
+		public EssentialsPluginBridgeJoinMapTemplate(uint joinStart)
+			: base(joinStart, typeof(EssentialsPluginBridgeJoinMapTemplate))
+		{
+		}
+	}
+}

PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs

@@ -1,37 +1,195 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-
-using PepperDash.Core;
-
+using System.Collections.Generic;
 using Newtonsoft.Json;
+using PepperDash.Essentials.Core;
 
-namespace EssentialsPluginTemplateEPI
+namespace EssentialsPluginTemplate
 {
-    /// <summary>
-    /// Example of a config class that represents the structure of the Properties object of a DeviceConfig.
-    /// The BuildDevice method will attempt to deserialize the Properties object into this class.
-    /// Populate with any necssary properties for your device
-    /// </summary>
-	public class EssentialsPluginTemplatePropertiesConfig 
+	/// <summary>
+	/// Plugin device configuration object
+	/// </summary>
+	/// <remarks>
+	/// Rename the class to match the device plugin being created
+	/// </remarks>
+	/// <example>
+	/// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig"
+	/// </example>
+	[ConfigSnippet("\"properties\":{\"control\":{}")]
+	public class EssentialsPluginConfigObjectTemplate
 	{
-        // Below are some example properties
+		/// <summary>
+		/// JSON control object
+		/// </summary>
+		/// <remarks>
+		/// Typically this object is not required, but in some instances it may be needed.  For example, when building a 
+		/// plugin that is using Telnet (TCP/IP) communications and requires login, the device will need to handle the login.
+		/// In order to do so, you will need the username and password in the "tcpSshProperties" object.
+		/// </remarks>
+		/// <example>
+		/// <code>
+		/// "control": {
+        ///		"method": "tcpIp",
+		///		"controlPortDevKey": "processor",
+		///		"controlPortNumber": 1,
+		///		"comParams": {
+		///			"baudRate": 9600,
+		///			"dataBits": 8,
+		///			"stopBits": 1,
+		///			"parity": "None",
+		///			"protocol": "RS232",
+		///			"hardwareHandshake": "None",
+		///			"softwareHandshake": "None"
+		///		},
+		///		"tcpSshProperties": {
+		///			"address": "172.22.0.101",
+		///			"port": 23,
+		///			"username": "admin",
+		///			"password": "password",
+		///			"autoReconnect": true,
+		///			"autoReconnectIntervalMs": 10000
+		///		}
+		///	}
+		/// </code>
+		/// </example>
+		[JsonProperty("control")]
+		public EssentialsControlPropertiesConfig Control { get; set; }
 
+		/// <summary>
+		/// Serializes the poll time value
+		/// </summary>
+		/// <remarks>
+		/// This is an exmaple device plugin property.  This should be modified or deleted as needed for the plugin being built.
+		/// </remarks>
+		/// <value>
+		/// PollTimeMs property gets/sets the value as a long
+		/// </value>
+		/// <example>
+		/// <code>
+		/// "properties": {
+		///		"polltimeMs": 30000
+		/// }
+		/// </code>
+		/// </example>
+		[JsonProperty("pollTimeMs")]
+		public long PollTimeMs { get; set; }
 
-        /// <summary>
-        /// Control properties if needed to communicate with device.
-        /// The JsonProperty attribute has been added to specify the name
-        /// of the object and that it is required
-        /// </summary>
-        [JsonProperty("control", Required = Required.Always)]
-        ControlPropertiesConfig Control { get; set; }
+		/// <summary>
+		/// Serializes the warning timeout value
+		/// </summary>
+		/// <remarks>
+		/// This is an exmaple device plugin property.  This should be modified or deleted as needed for the plugin being built.
+		/// </remarks>
+		/// <value>
+		/// WarningTimeoutMs property gets/sets the value as a long
+		/// </value>
+		/// <example>
+		/// <code>
+		/// "properties": {
+		///		"warningTimeoutMs": 180000
+		/// }
+		/// </code>
+		/// </example>
+		[JsonProperty("warningTimeoutMs")]
+		public long WarningTimeoutMs { get; set; }
 
-        /// <summary>
-        /// Add custom properties here 
-        /// </summary>
-        [JsonProperty("myDeviceProperty")]
-        string MyDeviceProperty { get; set; }
+		/// <summary>
+		/// Serializes the error timeout value
+		/// </summary>
+		/// /// <remarks>
+		/// This is an exmaple device plugin property.  This should be modified or deleted as needed for the plugin being built.
+		/// </remarks>
+		/// <value>
+		/// ErrorTimeoutMs property gets/sets the value as a long
+		/// </value>
+		/// <example>
+		/// <code>
+		/// "properties": {
+		///		"errorTimeoutMs": 300000
+		/// }
+		/// </code>
+		/// </example>
+		[JsonProperty("errorTimeoutMs")]
+		public long ErrorTimeoutMs { get; set; }
+
+		/// <summary>
+		/// Example dictionary of objects
+		/// </summary>
+		/// <remarks>
+		/// This is an example collection configuration object.  This should be modified or deleted as needed for the plugin being built.
+		/// </remarks>
+		/// <example>
+		/// <code>
+		/// "properties": {
+		///		"presets": {
+		///			"preset1": {
+		///				"enabled": true,
+		///				"name": "Preset 1"
+		///			}
+		///		}
+		/// }
+		/// </code>
+		/// </example>
+		/// <example>
+		/// <code>
+		/// "properties": {
+		///		"inputNames": {
+		///			"input1": "Input 1",
+		///			"input2": "Input 2"		
+		///		}
+		/// }
+		/// </code>
+		/// </example>
+		[JsonProperty("DeviceDictionary")]
+		public Dictionary<string, EssentialsPluginConfigObjectDictionaryTemplate> DeviceDictionary { get; set; }
+
+		/// <summary>
+		/// Constuctor
+		/// </summary>
+		/// <remarks>
+		/// If using a collection you must instantiate the collection in the constructor
+		/// to avoid exceptions when reading the configuration file 
+		/// </remarks>
+		public EssentialsPluginConfigObjectTemplate()
+		{
+			DeviceDictionary = new Dictionary<string, EssentialsPluginConfigObjectDictionaryTemplate>();
+		}
+	}
+
+	/// <summary>
+	/// Example plugin configuration dictionary object
+	/// </summary>
+	/// <remarks>
+	/// This is an example collection of configuration objects.  This can be modified or deleted as needed for the plugin being built.
+	/// </remarks>
+	/// <example>
+	/// <code>
+	/// "properties": {
+	///		"dictionary": {
+	///			"item1": {
+	///				"name": "Item 1 Name",
+	///				"value": "Item 1 Value"
+	///			}
+	///		}
+	/// }
+	/// </code>
+	/// </example>
+	public class EssentialsPluginConfigObjectDictionaryTemplate
+	{
+		/// <summary>
+		/// Serializes collection name property
+		/// </summary>
+		/// <remarks>
+		/// This is an example collection of configuration objects.  This can be modified or deleted as needed for the plugin being built.
+		/// </remarks>
+		[JsonProperty("name")]
+		public string Name { get; set; }
+
+		/// <summary>
+		/// Serializes collection value property
+		/// </summary>
+		/// <remarks>
+		/// This is an example collection of configuration objects.  This can be modified or deleted as needed for the plugin being built.
+		/// </remarks>
+		[JsonProperty("value")]
+		public uint Value { get; set; }
 	}
 }

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

@@ -1,67 +1,299 @@
-using Crestron.SimplSharpPro.DeviceSupport;
-using Newtonsoft.Json;
-using PDT.EssentialsPluginTemplate.EPI;
+// For Basic SIMPL# Classes
+// For Basic SIMPL#Pro classes
+
+using Crestron.SimplSharpPro.DeviceSupport;
+using PepperDash.Core;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Bridges;
-using PepperDash.Core;
+using PepperDash_Essentials_Core.Queues;
 
-namespace EssentialsPluginTemplateEPI
+
+namespace EssentialsPluginTemplate
 {
-    /// <summary>
-    /// Example of a plugin device
-    /// </summary>
-    public class EssentialsPluginTemplateDevice : EssentialsDevice, IBridgeAdvanced
+	/// <summary>
+	/// Plugin device template for third party devices that use IBasicCommunication
+	/// </summary>
+	/// <remarks>
+	/// Rename the class to match the device plugin being developed.
+	/// </remarks>
+	/// <example>
+	/// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
+	/// </example>
+	public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice
     {
         /// <summary>
-        /// Device Constructor.  Called by BuildDevice
+        /// It is often desirable to store the config
         /// </summary>
-        /// <param name="key"></param>
-        /// <param name="name"></param>
-        /// <param name="config"></param>
-        public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplatePropertiesConfig config)
-            : base(key, name)
+        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
+		// TODO [ ] If not using an HEX/byte based API, delete the properties below
+		private byte[] _commsByteBuffer = { };
+
+
+
+		/// <summary>
+		/// Connects/disconnects the comms of the plugin device
+		/// </summary>
+		/// <remarks>
+		/// triggers the _comms.Connect/Disconnect as well as thee comms monitor start/stop
+		/// </remarks>
+		public bool Connect
+		{
+			get { return _comms.IsConnected; }
+			set
+			{
+				if (value)
+				{
+					_comms.Connect();
+					_commsMonitor.Start();
+				}
+				else
+				{
+					_comms.Disconnect();
+					_commsMonitor.Stop();
+				}
+			}
+		}
+
+		/// <summary>
+		/// Reports connect feedback through the bridge
+		/// </summary>
+		public BoolFeedback ConnectFeedback { get; private set; }
+
+		/// <summary>
+		/// Reports online feedback through the bridge
+		/// </summary>
+		public BoolFeedback OnlineFeedback { get; private set; }
+
+		/// <summary>
+		/// Reports socket status feedback through the bridge
+		/// </summary>
+		public IntFeedback StatusFeedback { get; private set; }
+
+		/// <summary>
+		/// 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 EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, IBasicCommunication comms)
+			: 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;
+
+            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);
+
+			_comms = comms;
+			_commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll);
+
+			var socket = _comms as ISocketStatus;
+			if (socket != null)
+			{
+				// device comms is IP **ELSE** device comms is RS232
+				socket.ConnectionChange += socket_ConnectionChange;
+				Connect = true;
+            }
+
+            #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);
+			_commsGather.LineReceived += Handle_LineRecieved;
+
+			// _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;
+
+            // _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;
+
+            #endregion
+        }
+
+
+		private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args)
+		{
+			if (ConnectFeedback != null)
+				ConnectFeedback.FireUpdate();
+
+			if (StatusFeedback != null)
+				StatusFeedback.FireUpdate();
+		}
+
+		// TODO [ ] If not using an API with a delimeter, delete the method below
+		private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args)
+		{
+			// TODO [ ] Implement method 
+			
+            // 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 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)
         {
 
         }
 
-        /// <summary>
-        /// Add items to be executed during the Activaction phase
-        /// </summary>
-        /// <returns></returns>
-        public override bool CustomActivate()
-        {
 
-            return base.CustomActivate();
+		// TODO [ ] If not using an ACII based API, delete the properties below
+		/// <summary>
+		/// Sends text to the device plugin comms
+		/// </summary>
+		/// <remarks>
+		/// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
+		/// </remarks>
+		/// <param name="text">Command to be sent</param>		
+		public void SendText(string text)
+		{
+			if (string.IsNullOrEmpty(text)) return;
+
+			_comms.SendText(string.Format("{0}{1}", text, CommsDelimiter));
+		}
+
+		// TODO [ ] If not using an HEX/byte based API, delete the properties below
+		/// <summary>
+		/// Sends bytes to the device plugin comms
+		/// </summary>
+		/// <remarks>
+		/// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
+		/// </remarks>
+		/// <param name="bytes">Bytes to be sent</param>		
+		public void SendBytes(byte[] bytes)
+		{
+			if (bytes == null) return;
+
+			_comms.SendBytes(bytes);
+		}
+
+		/// <summary>
+		/// Polls the device
+		/// </summary>
+		/// <remarks>
+		/// Poll method is used by the communication monitor.  Update the poll method as needed for the plugin being developed
+		/// </remarks>
+		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>
-        /// This method gets called by the EiscApi bridge and calls your bridge extension method
+        /// Links the plugin device to the EISC bridge
         /// </summary>
         /// <param name="trilist"></param>
         /// <param name="joinStart"></param>
         /// <param name="joinMapKey"></param>
-        public void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
+        /// <param name="bridge"></param>
+        public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
         {
-            // Construct the default join map
-            var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
+            var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart);
 
-            // Attempt to get a custom join map if specified in config
-            var joinMapSerialized = JoinMapHelper.GetJoinMapForDevice(joinMapKey);
-
-            // If we find a custom join map, deserialize it
-            if (!string.IsNullOrEmpty(joinMapSerialized))
-                joinMap = JsonConvert.DeserializeObject<EssentialsPluginTemplateBridgeJoinMap>(joinMapSerialized);
-
-            //Checking if the bridge is null allows for backwards compatability with configurations that use EiscApi instead of EiscApiAdvanced
+            // This adds the join map to the collection on the bridge
             if (bridge != null)
             {
                 bridge.AddJoinMap(Key, joinMap);
             }
 
-            // Set all your join actions here
+            var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
 
+            if (customJoins != null)
+            {
+                joinMap.SetCustomJoinData(customJoins);
+            }
 
-            // Link all your feedbacks to joins here
+            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,43 +1,239 @@
-using System;
-using System.Collections.Generic;
-using Crestron.SimplSharp;                          				// For Basic SIMPL# Classes
-using Crestron.SimplSharpPro;                       				// For Basic SIMPL#Pro classes
-
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
-
-using PepperDash.Essentials;
-using PepperDash.Essentials.Core;
-using PepperDash.Essentials.Core.Config;
+using System.Collections.Generic;
 using PepperDash.Core;
+using PepperDash.Essentials.Core;
+using Crestron.SimplSharpPro.UI;
 
-namespace EssentialsPluginTemplateEPI 
+namespace EssentialsPluginTemplate
 {
-    /// <summary>
-    /// This class contains the necessary properties and methods required to function as an Essentials Plugin
-    /// </summary>
-	public class EssentialsPluginFactory:EssentialsPluginDeviceFactory<EssentialsPluginTemplateDevice>
+	/// <summary>
+	/// 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 "MyDeviceFactory"
+	/// </example>
+    public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory<EssentialsPluginTemplateDevice>
     {
-        public EssentialsPluginFactory()
+		/// <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 EssentialsPluginFactoryTemplate()
         {
-            // This string is used to define the minimum version of the
-            // Essentials Framework required for this plugin
-            MinimumEssentialsFrameworkVersion = "1.6.1";
+            // 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>() { "examplePluginDevice" };
+        }
+        
+		/// <summary>
+		/// Builds and returns an instance of EssentialsPluginDeviceTemplate
+		/// </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;
+            }
+
+            // 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);
+            }
 
-            //The strings defined in this list will be used in the configuration file to build the device in this plugin.
-            TypeNames = new List<string> {"essentialsPluginTemplateDevice"};
         }
 
-        #region Overrides of EssentialsDeviceFactory<EssentialsPluginTemplateDevice>
-
-        public override EssentialsDevice BuildDevice(DeviceConfig dc)
-        {
-            var config = dc.Properties.ToObject<EssentialsPluginTemplatePropertiesConfig>();
-			var newDevice = new EssentialsPluginTemplateDevice(dc.Key, dc.Name, config);
-			return newDevice;
-        }
-
-        #endregion
     }
+
+    /// <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/EssentialsPluginTemplateJoinMap.cs

@@ -1,27 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-using PepperDash.Essentials.Core;
-
-namespace PDT.EssentialsPluginTemplate.EPI
-{
-    public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced
-    {
-        [JoinName("IsOnline")]
-        public JoinDataComplete IsOnline = new JoinDataComplete(new JoinData {JoinNumber = 1, JoinSpan = 1},
-            new JoinMetadata
-            {
-                Description = "Device is Online",
-                JoinType = eJoinType.Digital,
-                JoinCapabilities = eJoinCapabilities.ToSIMPL
-            });
-
-
-        public EssentialsPluginTemplateBridgeJoinMap(uint joinStart):base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap))
-        {
-            
-        }
-    }
-}

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,9 +99,11 @@
     <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" />
-    <Compile Include="EssentialsPluginTemplateJoinMap.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="EssentialsPluginTemplateDevice.cs" />
     <None Include="Properties\ControlSystem.cfg" />

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.
@@ -20,8 +29,14 @@ The [Essentials](https://github.com/PepperDash/Essentials) libraries are require
 
 To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository:
 `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion`.
-To verify that the packages installed correctly, open Essentials and make sure that all references are found, then try and build it.
+To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it.
 
 ### Installing Different versions of PepperDash Core
 
 If you need a different version of PepperDash Core, use the command `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion -Version {versionToGet}`. Omitting the `-Version` option will pull the version indicated in the packages.config file.
+
+### Instructions for Renaming Solution and Files
+
+See the Task List in Visual Studio for a guide on how to start using the templage.  There is extensive inline documentation and examples as well.
+
+For renaming instructions in particular, see the XML `remarks` tags on class definitions

packages.config

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