feat: remove non-xml commentary for readability

Create essentialsplugins-betabuilds-caller.yml

.github/ISSUE_TEMPLATE/essentials-plugin-request.md

@@ -0,0 +1,17 @@
+---
+name: Essentials Plugin Request
+about: Request an Essentials Plugin
+title: "[REQUEST] - "
+labels: plugin request
+assignees: ''
+
+---
+
+** Describe the Plugin **
+What do you want the plugin to do? Is it for a specific device? If it's for a specific device, include the manufacturer and model, along with links to API documentation if available.
+
+** Does it need to be available in SIMPL Windows? **
+If it does, describe the functionality that should be exposed to SIMPL Windows via EISC. This may include an example join map, or other way of documenting the layout of the EISC.
+
+** Additional Features or functionality **
+Describe additional features or functionality that this plugin should have.

.github/scripts/GenerateVersionNumber.ps1

@@ -7,7 +7,8 @@ Foreach ($version in $latestVersions) {
       $latestVersion = $version
       Write-Host "Setting latest version to: $latestVersion"
     }
-  } catch {
+  }
+  catch {
     Write-Host "Unable to convert $($version). Skipping"
     continue;
   }
@@ -18,21 +19,27 @@ $phase = ""
 $newVersionString = ""
 switch -regex ($Env:GITHUB_REF) {
   '^refs\/heads\/main*.' {
-    $newVersionString = "{0}.{1}.{2}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1)
+    $newVersionString = "{0}.{1}.{2}" -f $newVersion.Major, $newVersion.Minor, $newVersion.Build
   }
   '^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\/*.' {
+    $splitRef = $Env:GITHUB_REF -split "/"
+    $version = [version]($splitRef[-1] -replace "v", "")
     $phase = 'rc'
+    $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $version.Major, $version.Minor, $version.Build, $phase, $Env:GITHUB_RUN_NUMBER
   }
-  '^refs\/heads\/development*.' {
+  '^refs\/heads\/dev*.' {
     $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/scripts/ZipBuildOutput.ps1

@@ -10,7 +10,7 @@ Get-ChildItem ($destination)
 $exclusions = @(git submodule foreach --quiet 'echo $name')
 # Trying to get any .json schema files (not currently working)
 # Gets any files with the listed extensions.
-Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz" | ForEach-Object {
+Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.cplz" | ForEach-Object {
   $allowed = $true;
   # Exclude any files in submodules
   foreach ($exclude in $exclusions) {
@@ -36,6 +36,7 @@ Get-ChildItem -Path $destination | Where-Object {($_.Extension -eq ".clz") -or (
     Get-ChildItem -Recurse -Path "$($Env:GITHUB_WORKSPACE)" -include $filenames | Copy-Item -Destination ($destination) -Force
   }
 }
+Get-ChildItem -Path $destination\*.cplz | Rename-Item -NewName { "$($_.BaseName)-$($Env:VERSION)$($_.Extension)" }
 Compress-Archive -Path $destination -DestinationPath "$($Env:GITHUB_WORKSPACE)\$($Env:SOLUTION_FILE)-$($Env:VERSION).zip" -Force
 Write-Host "Output Contents post Zip"
 Get-ChildItem -Path $destination

.github/workflows/EssentialsPlugins-builds-caller.yml

@@ -0,0 +1,31 @@
+name: Build Essentials Plugin
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  getVersion:
+    uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-getversion.yml@main
+    secrets: inherit
+  build-3Series:  
+    uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-3Series-builds.yml@main
+    secrets: inherit
+    needs: getVersion
+    if: needs.getVersion.outputs.newVersion == 'true'
+    with:
+      newVersion: ${{ needs.getVersion.outputs.newVersion }}
+      version: ${{ needs.getVersion.outputs.version }}
+      tag: ${{ needs.getVersion.outputs.tag }}
+      channel: ${{ needs.getVersion.outputs.channel }}
+  build-4Series:
+    uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-4Series-builds.yml@main
+    secrets: inherit
+    needs: getVersion
+    if: needs.getVersion.outputs.newVersion == 'true'
+    with:
+      newVersion: ${{ needs.getVersion.outputs.newVersion }}
+      version: ${{ needs.getVersion.outputs.version }}
+      tag: ${{ needs.getVersion.outputs.tag }}
+      channel: ${{ needs.getVersion.outputs.channel }}

.github/workflows/docker.yml

@@ -1,103 +0,0 @@
-name: Branch Build Using Docker
-
-on:
-  push:
-    branches:
-      - feature/*
-      - hotfix/*
-      - release/*
-      - main
-      - development
-
-env:
-  # solution path doesn't need slashes unless there it is multiple folders deep
-  # solution name does not include extension. .sln is assumed
-  SOLUTION_PATH: PDT.EssentialsPluginTemplate.EPI
-  SOLUTION_FILE: PDT.EssentialsPluginTemplate.EPI
-  # Do not edit this, we're just creating it here
-  VERSION: 0.0.0-buildtype-buildnumber
-  # Defaults to debug for build type
-  BUILD_TYPE: Debug
-  # Defaults to main as the release branch.  Change as necessary
-  RELEASE_BRANCH: main
-jobs:
-  Build_Project:
-    runs-on: windows-latest
-    steps:
-      # First we checkout the source repo
-      - name: Checkout repo
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      # And any submodules
-      - name: Checkout submodules
-        shell: bash
-        run: |
-          git config --global url."https://github.com/".insteadOf "git@github.com:"
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
-      # Set the BUILD_TYPE environment variable
-      - name: Set Build to Release if triggered from main
-        run: |
-          if("$($Env:GITHUB_REF)".contains("$($Env:RELEASE_BRANCH)")) {
-            Write-Host "Setting build type to Release"
-            Write-Output "::set-env name=BUILD_TYPE::Release"
-          }
-      # Fetch all tags
-      - name: Fetch tags
-        run: git fetch --tags
-      # Generate the appropriate version number
-      - name: Set Version Number
-        shell: powershell
-        run: |
-          $version = ./.github/scripts/GenerateVersionNumber.ps1
-          Write-Output "::set-env name=VERSION::$version"
-      # Use the version number to set the version of the assemblies
-      - name: Update AssemblyInfo.cs
-        shell: powershell
-        run: |
-          Write-Output ${{ env.VERSION }}
-          ./.github/scripts/UpdateAssemblyVersion.ps1 ${{ env.VERSION }}
-      - name: restore Nuget Packages
-        run: nuget install .\packages.config -OutputDirectory .\packages -ExcludeVersion
-      - name: Login to Docker
-        uses: azure/docker-login@v1
-        with:
-          username: ${{ secrets.DOCKERHUB_USER }}
-          password: ${{ secrets.DOCKERHUB_PASSWORD }}
-      # Build the solutions in the docker image
-      - name: Build Solution
-        shell: powershell
-        run: |
-          Invoke-Expression "docker run --rm --mount type=bind,source=""$($Env:GITHUB_WORKSPACE)"",target=""c:/project"" pepperdash/sspbuilder c:\cihelpers\vsidebuild.exe -Solution ""c:\project\$($Env:SOLUTION_PATH)\$($Env:SOLUTION_FILE).sln"" -BuildSolutionConfiguration $($ENV:BUILD_TYPE)"
-      # Zip up the output files as needed
-      - name: Zip Build Output
-        shell: powershell
-        run: ./.github/scripts/ZipBuildOutput.ps1
-      - name: Upload Build Output
-        uses: actions/upload-artifact@v1
-        with:
-          name: Build
-          path: ./${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip
-      # Create the release on the source repo
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        with:
-          tag_name: ${{ env.VERSION  }}
-          release_name: ${{ env.VERSION }}
-          prerelease: ${{contains('debug', env.BUILD_TYPE)}}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      # Upload the build package to the release
-      - name: Upload Release Package
-        id: upload_release
-        uses: actions/upload-release-asset@v1
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ./${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip
-          asset_name: ${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip
-          asset_content_type: application/zip
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

GetPackages.BAT

@@ -0,0 +1,2 @@
+@Echo ON
+nuget install .\packages.config -OutputDirectory .\packages -excludeVersion

PDT.EssentialsPluginTemplate.EPI.4Series.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.11.35327.3
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PDT.EssentialsPluginTemplate.EPI.4Series.", "src\PDT.EssentialsPluginTemplate.EPI.4Series..csproj", "{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {45BE70E2-A4DC-4851-92ED-CE67B99F5D86}
+	EndGlobalSection
+EndGlobal

PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs

@@ -1,37 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-
-using PepperDash.Core;
-
-using Newtonsoft.Json;
-
-namespace EssentialsPluginTemplateEPI
-{
-    /// <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 
-	{
-        // Below are some example properties
-
-
-        /// <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>
-        /// Add custom properties here 
-        /// </summary>
-        [JsonProperty("myDeviceProperty")]
-        string MyDeviceProperty { get; set; }
-	}
-}

PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs

@@ -1,67 +0,0 @@
-using Crestron.SimplSharpPro.DeviceSupport;
-using Newtonsoft.Json;
-using PDT.EssentialsPluginTemplate.EPI;
-using PepperDash.Essentials.Core;
-using PepperDash.Essentials.Core.Bridges;
-using PepperDash.Core;
-
-namespace EssentialsPluginTemplateEPI
-{
-    /// <summary>
-    /// Example of a plugin device
-    /// </summary>
-    public class EssentialsPluginTemplateDevice : EssentialsDevice, IBridgeAdvanced
-    {
-        /// <summary>
-        /// Device Constructor.  Called by BuildDevice
-        /// </summary>
-        /// <param name="key"></param>
-        /// <param name="name"></param>
-        /// <param name="config"></param>
-        public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplatePropertiesConfig config)
-            : base(key, name)
-        {
-
-        }
-
-        /// <summary>
-        /// Add items to be executed during the Activaction phase
-        /// </summary>
-        /// <returns></returns>
-        public override bool CustomActivate()
-        {
-
-            return base.CustomActivate();
-        }
-
-        /// <summary>
-        /// This method gets called by the EiscApi bridge and calls your bridge extension method
-        /// </summary>
-        /// <param name="trilist"></param>
-        /// <param name="joinStart"></param>
-        /// <param name="joinMapKey"></param>
-        public void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
-        {
-            // Construct the default join map
-            var joinMap = new EssentialsPluginTemplateBridgeJoinMap(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
-            if (bridge != null)
-            {
-                bridge.AddJoinMap(Key, joinMap);
-            }
-
-            // Set all your join actions here
-
-
-            // Link all your feedbacks to joins here
-        }
-    }
-}

PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs

@@ -1,43 +0,0 @@
-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 PepperDash.Core;
-
-namespace EssentialsPluginTemplateEPI 
-{
-    /// <summary>
-    /// This class contains the necessary properties and methods required to function as an Essentials Plugin
-    /// </summary>
-	public class EssentialsPluginFactory:EssentialsPluginDeviceFactory<EssentialsPluginTemplateDevice>
-    {
-        public EssentialsPluginFactory()
-        {
-            // This string is used to define the minimum version of the
-            // Essentials Framework required for this plugin
-            MinimumEssentialsFrameworkVersion = "1.6.1";
-
-            //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
-    }
-}
-

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/PDT.EssentialsPluginTemplate.EPI.csproj.user

@@ -1,5 +0,0 @@
-<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <PropertyGroup>
-    <DeployDeviceID>E282E6BE-C7C3-4ece-916A-88FB1CF8AF3C</DeployDeviceID>
-  </PropertyGroup>
-</Project>

PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln

@@ -1,20 +0,0 @@
-
-Microsoft Visual Studio Solution File, Format Version 10.00
-# Visual Studio 2008
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PDT.EssentialsPluginTemplate.EPI", "PDT.EssentialsPluginTemplate.EPI.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}"
-EndProject
-Global
-	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-		Debug|Any CPU = Debug|Any CPU
-		Release|Any CPU = Release|Any CPU
-	EndGlobalSection
-	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU
-	EndGlobalSection
-	GlobalSection(SolutionProperties) = preSolution
-		HideSolutionNode = FALSE
-	EndGlobalSection
-EndGlobal

PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log

@@ -1,63 +0,0 @@
-8/30/2019 3:01:01 PM, Info: Initializing SIMPLSharp Services...
-8/30/2019 3:01:01 PM, Info: ProjectInfo successfully initialized.
-8/30/2019 3:01:02 PM, Info: Saving project information...
-8/30/2019 3:01:02 PM, Info: Saving project information...
-8/30/2019 3:01:02 PM, Info: Saving project information...
-8/30/2019 3:01:02 PM, Info: Saving project information...
-8/30/2019 3:01:02 PM, Info: Saving project information...
-8/30/2019 3:01:02 PM, Info: Saving project information...
-8/30/2019 3:04:48 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDashEssentials.dll...
-8/30/2019 3:05:10 PM, Info: Saving project information...
-8/30/2019 3:05:10 PM, Info: Saving project information...
-8/30/2019 3:05:10 PM, Info: Saving project information...
-8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Core.dll...
-8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll...
-8/30/2019 3:05:40 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_DM.dll...
-8/30/2019 3:06:24 PM, Info: Saving project information...
-8/30/2019 3:06:24 PM, Info: Saving project information...
-8/30/2019 3:06:24 PM, Info: Saving project information...
-8/30/2019 3:06:24 PM, Info: Saving project information...
-8/30/2019 3:06:24 PM, Info: Saving project information...
-8/30/2019 3:06:24 PM, Info: Saving project information...
-8/30/2019 3:06:36 PM, Info: Saving project information...
-8/30/2019 3:06:36 PM, Info: Saving project information...
-8/30/2019 3:06:36 PM, Info: Saving project information...
-8/30/2019 3:06:36 PM, Info: Saving project information...
-8/30/2019 3:06:36 PM, Info: Saving project information...
-8/30/2019 3:06:36 PM, Info: Saving project information...
-8/30/2019 3:08:54 PM, Info: Saving project information...
-8/30/2019 3:08:54 PM, Info: Saving project information...
-8/30/2019 3:08:54 PM, Info: Saving project information...
-8/30/2019 3:08:54 PM, Info: Saving project information...
-8/30/2019 3:08:54 PM, Info: Saving project information...
-8/30/2019 3:08:54 PM, Info: Saving project information...
-8/30/2019 3:09:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll...
-8/30/2019 3:10:10 PM, Info: Saving project information...
-8/30/2019 3:10:10 PM, Info: Saving project information...
-8/30/2019 3:10:10 PM, Info: Saving project information...
-8/30/2019 3:15:10 PM, Info: Saving project information...
-8/30/2019 3:15:10 PM, Info: Saving project information...
-8/30/2019 3:15:10 PM, Info: Saving project information...
-8/30/2019 3:20:10 PM, Info: Saving project information...
-8/30/2019 3:20:10 PM, Info: Saving project information...
-8/30/2019 3:20:10 PM, Info: Saving project information...
-8/30/2019 3:25:10 PM, Info: Saving project information...
-8/30/2019 3:25:10 PM, Info: Saving project information...
-8/30/2019 3:25:10 PM, Info: Saving project information...
-8/30/2019 3:30:10 PM, Info: Saving project information...
-8/30/2019 3:30:10 PM, Info: Saving project information...
-8/30/2019 3:30:10 PM, Info: Saving project information...
-8/30/2019 3:35:10 PM, Info: Saving project information...
-8/30/2019 3:35:10 PM, Info: Saving project information...
-8/30/2019 3:35:10 PM, Info: Saving project information...
-8/30/2019 3:35:38 PM, Info: Saving project information...
-8/30/2019 3:35:38 PM, Info: Saving project information...
-8/30/2019 3:35:38 PM, Info: Saving project information...
-8/30/2019 3:35:38 PM, Info: Saving project information...
-8/30/2019 3:35:38 PM, Info: Saving project information...
-8/30/2019 3:35:38 PM, Info: Saving project information...
-8/30/2019 3:36:52 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll...
-8/30/2019 3:36:52 PM, Info: Verifying assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll
-8/30/2019 3:36:52 PM, Info: Creating Archive C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.cplz...
-8/30/2019 3:36:53 PM, Info: Saving project information...
-9/2/2019 8:34:46 AM, Info: Terminating SIMPLSharp Services

README.md

@@ -1,4 +1,6 @@
-# Essentials Plugin Template (c) 2020
+![PepperDash Essentials Pluign Logo](/images/essentials-plugin-blue.png)
+
+# Essentials Plugin Template (c) 2023
 
 ## License
 
@@ -8,6 +10,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 +31,30 @@ 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`.
+Alternatively, you can simply run the `GetPackages.bat` file.
 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 template.  There is extensive inline documentation and examples as well.
+
+For renaming instructions in particular, see the XML `remarks` tags on class definitions
+
+## Build Instructions (PepperDash Internal) 
+
+## Generating Nuget Package 
+
+In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" 
+
+1. Rename the file to match your plugin solution name 
+2. Edit the file to include your project specifics including
+    1. <id>PepperDash.Essentials.Plugin.MakeModel</id> Convention is to use the prefix "PepperDash.Essentials.Plugin" and include the MakeModel of the device. 
+    2. <projectUrl>https://github.com/PepperDash/EssentialsPluginTemplate</projectUrl> Change to your url to the project repo
+
+There is no longer a requirement to adjust workflow files for nuget generation for private and public repositories.  This is now handled automatically in the workflow.
+
+__If you do not make these changes to the nuspec file, the project will not generate a nuget package__  

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.10.2" targetFramework="net35" allowedVersions="[1.0,2.0)"/>
 </packages>

releaserc.json

@@ -0,0 +1,34 @@
+{
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "releaseRules": [
+          { "scope": "force-patch", "release": "patch" },
+          { "scope": "no-release", "release": false }
+        ]
+      }
+    ],
+    "@semantic-release/release-notes-generator",    
+    ["@semantic-release/changelog", 
+      {
+        "changelogFile": "CHANGELOG.md"
+      }
+    ],
+    [
+      "@semantic-release/exec",
+      {
+        "verifyReleaseCmd": "echo \"newVersion=true\" >> $GITHUB_OUTPUT",
+        "publishCmd": "echo \"version=${nextRelease.version}\" >> $GITHUB_OUTPUT && echo \"tag=${nextRelease.gitTag}\" >> $GITHUB_OUTPUT && echo \"type=${nextRelease.type}\" >> $GITHUB_OUTPUT && echo \"channel=${nextRelease.channel}\" >> $GITHUB_OUTPUT"
+      }
+    ]
+  ],  
+  "branches": [
+    "main",
+    {
+      "name": "replace-me-feature-branch",
+      "prerelease": "replace-me-prerelease",
+      "channel": "replace-me-prerelease"
+    }
+  ]
+}

src/Directory.Build.props

@@ -0,0 +1,21 @@
+<Project>
+  <PropertyGroup>
+    <Version>1.0.0-local</Version>
+    <InformationalVersion>$(Version)</InformationalVersion>
+    <Authors>PepperDash Technologies</Authors>
+    <Company>PepperDash Technologies</Company>
+    <Product>PepperDash Essentials Plugin Template</Product>
+    <Copyright>Copyright ©  2024</Copyright>
+    <RepositoryUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <PackageTags>Crestron; 4series</PackageTags>
+    <PackageOutputPath>../output</PackageOutputPath>
+    <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+    <PackageLicenseFile>LICENSE.md</PackageLicenseFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
+  <ItemGroup>
+    <None Include="..\LICENSE.md" Pack="true" PackagePath=""/>
+    <None Include="..\README.md" Pack="true" PackagePath=""/>
+  </ItemGroup>
+</Project>

src/Directory.Build.targets

@@ -0,0 +1,20 @@
+<Project>
+  <ItemGroup>
+    <None Include="$(TargetDir)\$(TargetName).$(Version).cpz" Condition="$(ProjectType) == 'Program'">
+      <Pack>true</Pack>
+      <PackagePath>content;</PackagePath>
+    </None>
+    <None Include="$(PackageOutputPath)\$(TargetName).$(Version).cplz" Condition="$(ProjectType) == 'ProgramLibrary'">
+      <Pack>true</Pack>
+      <PackagePath>content;</PackagePath>
+    </None>
+  </ItemGroup>
+  <Target Name="Create CPLZ" AfterTargets="Build; Rebuild" Condition="$(ProjectType) == 'ProgramLibrary'">
+    <Message Text="Creating CPLZ"></Message>
+    <MakeDir Directories="$(PackageOutputPath)" Condition="!Exists($(PackageOutputPath))"></MakeDir>
+    <ZipDirectory SourceDirectory="$(TargetDir)" DestinationFile="$(PackageOutputPath)\$(TargetName).$(Version).cplz" Overwrite="true"/>    
+  </Target>
+  <Target Name="Clean CPLZ" AfterTargets="AfterClean" Condition="$(ProjectType) == 'ProgramLibrary'">
+    <Delete Files="$(PackageOutputPath)\$(TargetName).$(Version).cplz"/>
+  </Target>
+</Project>

src/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 EssentialsPluginTemplateBridgeJoinMap : 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 EssentialsPluginTemplateBridgeJoinMap(uint joinStart)
+            : base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap))
+		{
+		}
+	}
+}

src/EssentialsPluginTemplateConfigObject.cs

@@ -0,0 +1,195 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using PepperDash.Essentials.Core;
+
+namespace EssentialsPluginTemplate
+{
+	/// <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 EssentialsPluginTemplateConfigObject
+	{
+		/// <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>
+		/// 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>
+		/// 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, EssentialsPluginTemplateConfigObjectDictionary> 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 EssentialsPluginTemplateConfigObject()
+		{
+			DeviceDictionary = new Dictionary<string, EssentialsPluginTemplateConfigObjectDictionary>();
+		}
+	}
+
+	/// <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 EssentialsPluginTemplateConfigObjectDictionary
+	{
+		/// <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; }
+	}
+}

src/EssentialsPluginTemplateDevice.cs

@@ -0,0 +1,256 @@
+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 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
+    {
+        private EssentialsPluginTemplateConfigObject _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.
+
+		private readonly IBasicCommunication _comms;
+		private readonly GenericCommunicationMonitor _commsMonitor;
+		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";
+		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, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms)
+			: base(key, name)
+		{
+			Debug.Console(0, this, "Constructing new {0} instance", name);
+
+			_config = config;
+
+            ReceiveQueue = new GenericQueue(key + "-rxqueue");
+
+			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)
+			{
+				socket.ConnectionChange += socket_ConnectionChange;
+				Connect = true;
+            }
+
+            #region Communication data event handlers.  Comment out any that don't apply to the API type
+
+			_commsGather = new CommunicationGather(_comms, CommsDelimiter);
+			_commsGather.LineReceived += Handle_LineRecieved;
+			_comms.BytesReceived += Handle_BytesReceived;
+            _comms.TextReceived += Handle_TextReceived;
+
+            #endregion
+        }
+
+
+		private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args)
+		{
+			if (ConnectFeedback != null)
+				ConnectFeedback.FireUpdate();
+
+			if (StatusFeedback != null)
+				StatusFeedback.FireUpdate();
+		}
+
+		private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args)
+		{
+            ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage));
+		}
+
+		private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args)
+		{
+			throw new System.NotImplementedException();
+		}
+
+        void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e)
+        {
+            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)
+        {
+            throw new System.NotImplementedException();
+        }
+
+        /// <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($"{text}{CommsDelimiter}");
+		}
+
+		/// <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()
+		{
+			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 EssentialsPluginTemplateBridgeJoinMap(joinStart);
+
+            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);
+
+
+            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()
+        {
+            ConnectFeedback.FireUpdate();
+            OnlineFeedback.FireUpdate();
+            StatusFeedback.FireUpdate();
+        }
+
+        #endregion
+
+    }
+}
+

src/EssentialsPluginTemplateFactory.cs

@@ -0,0 +1,239 @@
+using System.Collections.Generic;
+using PepperDash.Core;
+using PepperDash.Essentials.Core;
+using Crestron.SimplSharpPro.UI;
+
+namespace EssentialsPluginTemplate
+{
+	/// <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 EssentialsPluginTemplateFactory : EssentialsPluginDeviceFactory<EssentialsPluginTemplateDevice>
+    {
+		/// <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 EssentialsPluginTemplateFactory()
+        {
+            // 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<EssentialsPluginTemplateConfigObject>();
+            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);
+            }
+
+        }
+
+    }
+
+    /// <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 EssentialsPluginTemplateFactoryLogicDevice : 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 EssentialsPluginTemplateFactoryLogicDevice()
+        {
+            // 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<EssentialsPluginTemplateConfigObject>();
+            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 EssentialsPluginTemplateFactoryCrestronDevice : 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 EssentialsPluginTemplateFactoryCrestronDevice()
+        {
+            // 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<EssentialsPluginTemplateConfigObject>();
+            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;
+            }
+        }
+    }
+
+}
+
+          

src/PDT.EssentialsPluginTemplate.EPI.4Series..csproj

@@ -0,0 +1,40 @@
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<ProjectType>ProgramLibrary</ProjectType>
+	</PropertyGroup>
+	<PropertyGroup>
+		<TargetFramework>net472</TargetFramework>
+		<RootNamespace>PDT.EssentialsPluginTemplate.EPI</RootNamespace>
+		<Deterministic>false</Deterministic>
+		<AssemblyTitle>PDT.EssentialsPluginTemplate.EPI</AssemblyTitle>
+		<Company>PepperDash Technologies</Company>
+		<Description>This software is a template for a PepperDash Essentials Plugin.</Description>
+		<Copyright>Copyright 2024</Copyright>
+		<Version>1.0.0-local</Version>
+		<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
+		<InformationalVersion>$(Version)</InformationalVersion>
+		<OutputPath>4Series\bin\$(Configuration)\</OutputPath>
+		<Authors>PepperDash Technologies</Authors>
+		<PackageId>Pepperdash.Essentials.Plugins.Template</PackageId>
+		<PackageProjectUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</PackageProjectUrl>
+		<PackageTags>crestron 4series essentials plugin template</PackageTags>
+	</PropertyGroup>
+
+	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+		<DefineConstants>$(DefineConstants);SERIES4</DefineConstants>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<Compile Remove="Properties\**" />
+		<EmbeddedResource Remove="Properties\**" />
+		<None Remove="Properties\**" />
+	</ItemGroup>
+
+	<ItemGroup>
+		<None Remove="PDT.EssentialsPluginTemplate.projectinfo" />
+	</ItemGroup>
+
+	<ItemGroup>
+	  <PackageReference Include="PepperDashEssentials" Version="2.0.0-beta-2559" />
+	</ItemGroup>
+</Project>

src/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" />

src/PDT.EssentialsPluginTemplate.nuspec

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package >
+  <metadata>
+    <id>PDT.EssentialsPluginTemplate</id>
+    <readme>docs\README.md</readme>
+    <version>2.0.2</version>
+    <title>Essentials Plugin Template</title>
+    <authors>PepperDash Technologies</authors>
+    <owners>pepperdash</owners>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <license type="expression">MIT</license>
+    <projectUrl>https://github.com/PepperDash/EssentialsPluginTemplate</projectUrl>
+    <copyright>Copyright 2022</copyright>
+    <description>This software iserves as a template for generating new Essentials-Compliant plugins</description>
+    <tags>crestron 3series 4series essentials pepperdash pepperdashessentials epi essentials plugin</tags>
+    <repository type="git" url="https://github.com/PepperDash/EssentialsPluginTemplate"/>
+  </metadata>
+    <files>
+      <file src="**" target="lib\net35"/>
+      <file src="**" target="lib\net47"/>
+      <file src="README.md" target="docs\"/>
+    </files>
+</package>

src/Properties/AssemblyInfo.cs

@@ -3,6 +3,6 @@
 [assembly: AssemblyTitle("EssentialsPluginTemplateEpi")]
 [assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("EssentialsPluginTemplateEpi")]
-[assembly: AssemblyCopyright("Copyright ©  2019")]
+[assembly: AssemblyCopyright("Copyright ©  2022")]
 [assembly: AssemblyVersion("1.0.0.*")]