diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..c969d2a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]-"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Stacktrace**
+
+Include a stack trace of the exception if possible.
+```
+Paste stack trace here
+```
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..0a854e7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]-"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+If this is a request for support for a new device or type, be as specific as possible and include any pertinent manufacturer and model information.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/scripts/GenerateVersionNumber.ps1 b/.github/scripts/GenerateVersionNumber.ps1
new file mode 100644
index 0000000..98bbf3a
--- /dev/null
+++ b/.github/scripts/GenerateVersionNumber.ps1
@@ -0,0 +1,42 @@
+$latestVersions = $(git tag --merged origin/main)
+$latestVersion = [version]"0.0.0"
+Foreach ($version in $latestVersions) {
+ Write-Host $version
+ try {
+ if (([version]$version) -ge $latestVersion) {
+ $latestVersion = $version
+ Write-Host "Setting latest version to: $latestVersion"
+ }
+ } catch {
+ Write-Host "Unable to convert $($version). Skipping"
+ continue;
+ }
+}
+
+$newVersion = [version]$latestVersion
+$phase = ""
+$newVersionString = ""
+switch -regex ($Env:GITHUB_REF) {
+ '^refs\/heads\/main*.' {
+ $newVersionString = "{0}.{1}.{2}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1)
+ }
+ '^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
+ }
+}
+
+
+Write-Output $newVersionString
diff --git a/.github/scripts/UpdateAssemblyVersion.ps1 b/.github/scripts/UpdateAssemblyVersion.ps1
new file mode 100644
index 0000000..e52b31e
--- /dev/null
+++ b/.github/scripts/UpdateAssemblyVersion.ps1
@@ -0,0 +1,40 @@
+function Update-SourceVersion {
+ Param ([string]$Version)
+ #$fullVersion = $Version
+ $baseVersion = [regex]::Match($Version, "(\d+.\d+.\d+).*").captures.groups[1].value
+ $NewAssemblyVersion = ‘AssemblyVersion("‘ + $baseVersion + ‘.*")’
+ Write-Output "AssemblyVersion = $NewAssemblyVersion"
+ $NewAssemblyInformationalVersion = ‘AssemblyInformationalVersion("‘ + $Version + ‘")’
+ Write-Output "AssemblyInformationalVersion = $NewAssemblyInformationalVersion"
+
+ foreach ($o in $input) {
+ Write-output $o.FullName
+ $TmpFile = $o.FullName + “.tmp”
+ get-content $o.FullName |
+ ForEach-Object {
+ $_ -replace ‘AssemblyVersion\(".*"\)’, $NewAssemblyVersion } |
+ ForEach-Object {
+ $_ -replace ‘AssemblyInformationalVersion\(".*"\)’, $NewAssemblyInformationalVersion
+ } > $TmpFile
+ move-item $TmpFile $o.FullName -force
+ }
+}
+
+function Update-AllAssemblyInfoFiles ( $version ) {
+ foreach ($file in “AssemblyInfo.cs”, “AssemblyInfo.vb” ) {
+ get-childitem -Path $Env:GITHUB_WORKSPACE -recurse | Where-Object { $_.Name -eq $file } | Update-SourceVersion $version ;
+ }
+}
+
+# validate arguments
+$r = [System.Text.RegularExpressions.Regex]::Match($args[0], "\d+\.\d+\.\d+.*");
+if ($r.Success) {
+ Write-Output "Updating Assembly Version to $args ...";
+ Update-AllAssemblyInfoFiles $args[0];
+}
+else {
+ Write-Output ” “;
+ Write-Output “Error: Input version does not match x.y.z format!”
+ Write-Output ” “;
+ Write-Output "Unable to apply version to AssemblyInfo.cs files";
+}
diff --git a/.github/scripts/ZipBuildOutput.ps1 b/.github/scripts/ZipBuildOutput.ps1
new file mode 100644
index 0000000..3f1998b
--- /dev/null
+++ b/.github/scripts/ZipBuildOutput.ps1
@@ -0,0 +1,41 @@
+# Uncomment these for local testing
+# $Env:GITHUB_WORKSPACE = "C:\Working Directories\PD\essentials"
+# $Env:SOLUTION_FILE = "PepperDashEssentials"
+# $Env:VERSION = "0.0.0-buildType-test"
+
+# Sets the root directory for the operation
+$destination = "$($Env:GITHUB_HOME)\output"
+New-Item -ItemType Directory -Force -Path ($destination)
+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 {
+ $allowed = $true;
+ # Exclude any files in submodules
+ foreach ($exclude in $exclusions) {
+ if ((Split-Path $_.FullName -Parent).contains("$($exclude)")) {
+ $allowed = $false;
+ break;
+ }
+ }
+ if ($allowed) {
+ Write-Host "allowing $($_)"
+ $_;
+ }
+} | Copy-Item -Destination ($destination) -Force
+Write-Host "Getting matching files..."
+# Get any files from the output folder that match the following extensions
+Get-ChildItem -Path $destination | Where-Object {($_.Extension -eq ".clz") -or ($_.Extension -eq ".cpz" -or ($_.Extension -eq ".cplz"))} | ForEach-Object {
+ # Replace the extensions with dll and xml and create an array
+ $filenames = @($($_ -replace "cpz|clz|cplz", "dll"), $($_ -replace "cpz|clz|cplz", "xml"))
+ Write-Host "Filenames:"
+ Write-Host $filenames
+ if ($filenames.length -gt 0) {
+ # Attempt to get the files and return them to the output directory
+ Get-ChildItem -Recurse -Path "$($Env:GITHUB_WORKSPACE)" -include $filenames | Copy-Item -Destination ($destination) -Force
+ }
+}
+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
\ No newline at end of file
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
new file mode 100644
index 0000000..0ccab74
--- /dev/null
+++ b/.github/workflows/docker.yml
@@ -0,0 +1,103 @@
+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 }}
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..f218fa0
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,359 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*[.json, .xml, .info]
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Crestron Zip Files
+*.cplz
+*.clz
+*.projectinfo
+*.suo
diff --git a/.gitmodules b/.gitmodules
index 726935e..e69de29 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,3 +0,0 @@
-[submodule "EssentialsBuilds"]
- path = EssentialsBuilds
-url=https://github.com/PepperDash/Essentials-Builds.git
\ No newline at end of file
diff --git a/EssentialsBuilds b/EssentialsBuilds
deleted file mode 160000
index 855dccd..0000000
--- a/EssentialsBuilds
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 855dccd0d41aac272512f58d6bcd4764307bbb14
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentailsPluginTemplate.cs b/PDT.EssentialsPluginTemplate.EPI/EssentailsPluginTemplate.cs
deleted file mode 100644
index 0112c01..0000000
--- a/PDT.EssentialsPluginTemplate.EPI/EssentailsPluginTemplate.cs
+++ /dev/null
@@ -1,52 +0,0 @@
-using System;
-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
-{
- ///
- /// This class contains the necessary properties and static methods required to function as an Essentials Plugin
- ///
- public class EssentialsPluginFactory
- {
- ///
- /// This string is used to define the minimum version of the
- /// Essentials Framework required for this plugin
- ///
- public static string MinimumEssentialsFrameworkVersion = "1.4.31";
-
- ///
- /// This method will get called by Essentials when this plugin is loaded.
- /// Use it to add factory methods for all new Device types defined in this plugin
- ///
- public static void LoadPlugin()
- {
- PepperDash.Essentials.Core.DeviceFactory.AddFactoryForType("EssentialsPluginTemplate", EssentialsPluginFactory.BuildDevice);
-
- // Add additional factories for each type here
- }
-
- ///
- /// Builds an instance of the device type. There should be method like this defined for each device type your plugin needs
- /// to be able to build
- ///
- /// The device configuration
- /// The device
- public static EssentialsPluginTemplateDevice BuildDevice(DeviceConfig dc)
- {
- var config = JsonConvert.DeserializeObject(dc.Properties.ToString());
- var newDevice = new EssentialsPluginTemplateDevice(dc.Key, dc.Name, config);
- return newDevice;
- }
-
- }
-}
-
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridge.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridge.cs
deleted file mode 100644
index e26e2d7..0000000
--- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridge.cs
+++ /dev/null
@@ -1,57 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-
-using Crestron.SimplSharp;
-using Crestron.SimplSharpPro.DeviceSupport;
-
-using PepperDash.Core;
-using PepperDash.Essentials.Core;
-using PepperDash.Essentials.Bridges;
-
-using Newtonsoft.Json;
-
-namespace EssentialsPluginTemplateEPI
-{
- public static class EssentialsPluginTemplateBridge
- {
- public static void LinkToApiExt(this EssentialsPluginFactory DspDevice, BasicTriList trilist, uint joinStart, string joinMapKey)
- {
- // Construct the default join map
- EssentialsPluginTemplateBridgeJoinMap joinMap = new EssentialsPluginTemplateBridgeJoinMap();
-
- // 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(joinMapSerialized);
-
- // Offset the joins based on the join start
- joinMap.OffsetJoinNumbers(joinStart);
-
-
- // Set all your join actions here
-
-
- // Link all your feedbacks to joins here
-
- }
- }
- public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBase
- {
- // Specify your joins here
-
-
- public EssentialsPluginTemplateBridgeJoinMap()
- {
- // Set the values of your joins here
- }
-
- public override void OffsetJoinNumbers(uint joinStart)
- {
- // Offset the joins from joinStart as applicable
- }
- }
-}
\ No newline at end of file
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs
new file mode 100644
index 0000000..1f1f9d0
--- /dev/null
+++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs
@@ -0,0 +1,101 @@
+using PepperDash.Essentials.Core;
+
+namespace EssentialsPluginTemplate
+{
+ ///
+ /// Plugin device Bridge Join Map
+ ///
+ ///
+ /// Rename the class to match the device plugin being developed. Reference Essentials JoinMaps, if one exists for the device plugin being developed
+ ///
+ ///
+ ///
+ /// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap"
+ ///
+ 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
+
+ ///
+ /// Plugin device BridgeJoinMap constructor
+ ///
+ /// This will be the join it starts on the EISC bridge
+ public EssentialsPluginBridgeJoinMapTemplate(uint joinStart)
+ : base(joinStart, typeof(EssentialsPluginBridgeJoinMapTemplate))
+ {
+ }
+ }
+}
\ No newline at end of file
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs
index 5a76b22..027cefe 100644
--- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs
+++ b/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
{
- ///
- /// 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
- ///
- public class EssentialsPluginTemplatePropertiesConfig
+ ///
+ /// Plugin device configuration object
+ ///
+ ///
+ /// Rename the class to match the device plugin being created
+ ///
+ ///
+ /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig"
+ ///
+ [ConfigSnippet("\"properties\":{\"control\":{}")]
+ public class EssentialsPluginConfigObjectTemplate
{
- // Below are some example properties
+ ///
+ /// JSON control object
+ ///
+ ///
+ /// 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.
+ ///
+ ///
+ ///
+ /// "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
+ /// }
+ /// }
+ ///
+ ///
+ [JsonProperty("control")]
+ public EssentialsControlPropertiesConfig Control { get; set; }
+ ///
+ /// Serializes the poll time value
+ ///
+ ///
+ /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built.
+ ///
+ ///
+ /// PollTimeMs property gets/sets the value as a long
+ ///
+ ///
+ ///
+ /// "properties": {
+ /// "polltimeMs": 30000
+ /// }
+ ///
+ ///
+ [JsonProperty("pollTimeMs")]
+ public long PollTimeMs { get; set; }
- ///
- /// 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
- ///
- [JsonProperty("control", Required = Required.Always)]
- ControlPropertiesConfig Control { get; set; }
+ ///
+ /// Serializes the warning timeout value
+ ///
+ ///
+ /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built.
+ ///
+ ///
+ /// WarningTimeoutMs property gets/sets the value as a long
+ ///
+ ///
+ ///
+ /// "properties": {
+ /// "warningTimeoutMs": 180000
+ /// }
+ ///
+ ///
+ [JsonProperty("warningTimeoutMs")]
+ public long WarningTimeoutMs { get; set; }
- ///
- /// Add custom properties here
- ///
- [JsonProperty("myDeviceProperty")]
- string MyDeviceProperty { get; set; }
+ ///
+ /// Serializes the error timeout value
+ ///
+ /// ///
+ /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built.
+ ///
+ ///
+ /// ErrorTimeoutMs property gets/sets the value as a long
+ ///
+ ///
+ ///
+ /// "properties": {
+ /// "errorTimeoutMs": 300000
+ /// }
+ ///
+ ///
+ [JsonProperty("errorTimeoutMs")]
+ public long ErrorTimeoutMs { get; set; }
+
+ ///
+ /// Example dictionary of objects
+ ///
+ ///
+ /// This is an example collection configuration object. This should be modified or deleted as needed for the plugin being built.
+ ///
+ ///
+ ///
+ /// "properties": {
+ /// "presets": {
+ /// "preset1": {
+ /// "enabled": true,
+ /// "name": "Preset 1"
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ ///
+ ///
+ /// "properties": {
+ /// "inputNames": {
+ /// "input1": "Input 1",
+ /// "input2": "Input 2"
+ /// }
+ /// }
+ ///
+ ///
+ [JsonProperty("DeviceDictionary")]
+ public Dictionary DeviceDictionary { get; set; }
+
+ ///
+ /// Constuctor
+ ///
+ ///
+ /// If using a collection you must instantiate the collection in the constructor
+ /// to avoid exceptions when reading the configuration file
+ ///
+ public EssentialsPluginConfigObjectTemplate()
+ {
+ DeviceDictionary = new Dictionary();
+ }
+ }
+
+ ///
+ /// Example plugin configuration dictionary object
+ ///
+ ///
+ /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built.
+ ///
+ ///
+ ///
+ /// "properties": {
+ /// "dictionary": {
+ /// "item1": {
+ /// "name": "Item 1 Name",
+ /// "value": "Item 1 Value"
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ public class EssentialsPluginConfigObjectDictionaryTemplate
+ {
+ ///
+ /// Serializes collection name property
+ ///
+ ///
+ /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built.
+ ///
+ [JsonProperty("name")]
+ public string Name { get; set; }
+
+ ///
+ /// Serializes collection value property
+ ///
+ ///
+ /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built.
+ ///
+ [JsonProperty("value")]
+ public uint Value { get; set; }
}
}
\ No newline at end of file
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs
index 9cfcd62..649c7e6 100644
--- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs
+++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs
@@ -1,54 +1,246 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
+// For Basic SIMPL# Classes
+// For Basic SIMPL#Pro classes
+
using Crestron.SimplSharpPro.DeviceSupport;
-
-using PepperDash.Essentials;
-using PepperDash.Essentials.Core;
-using PepperDash.Essentials.Core.Config;
using PepperDash.Core;
-using PepperDash.Essentials.Bridges;
+using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core.Bridges;
-namespace EssentialsPluginTemplateEPI
+namespace EssentialsPluginTemplate
{
- ///
- /// Example of a plugin device
- ///
- public class EssentialsPluginTemplateDevice : Device, IBridge
- {
- ///
- /// Device Constructor. Called by BuildDevice
- ///
- ///
- ///
- ///
- public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplatePropertiesConfig config)
- : base(key, name)
- {
+ ///
+ /// Plugin device
+ ///
+ ///
+ /// Rename the class to match the device plugin being developed.
+ ///
+ ///
+ /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
+ ///
+ public class EssentialsPluginDeviceTemplate : EssentialsBridgeableDevice
+ {
+ // 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;
+ private const string CommsDelimiter = "\r";
- ///
- /// Add items to be executed during the Activaction phase
- ///
- ///
- public override bool CustomActivate()
- {
+ // _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 = { };
- return base.CustomActivate();
- }
- ///
- /// This method gets called by the EiscApi bridge and calls your bridge extension method
- ///
- ///
- ///
- ///
- public void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey)
- {
- this.LinkToApi(trilist, joinStart, joinMapKey);
- }
- }
-}
\ No newline at end of file
+ private EssentialsPluginConfigObjectTemplate _config;
+
+ ///
+ /// Connects/disconnects the comms of the plugin device
+ ///
+ ///
+ /// triggers the _comms.Connect/Disconnect as well as thee comms monitor start/stop
+ ///
+ public bool Connect
+ {
+ get { return _comms.IsConnected; }
+ set
+ {
+ if (value)
+ {
+ _comms.Connect();
+ _commsMonitor.Start();
+ }
+ else
+ {
+ _comms.Disconnect();
+ _commsMonitor.Stop();
+ }
+ }
+ }
+
+ ///
+ /// Reports connect feedback through the bridge
+ ///
+ public BoolFeedback ConnectFeedback { get; private set; }
+
+ ///
+ /// Reports online feedback through the bridge
+ ///
+ public BoolFeedback OnlineFeedback { get; private set; }
+
+ ///
+ /// Reports socket status feedback through the bridge
+ ///
+ public IntFeedback StatusFeedback { get; private set; }
+
+ ///
+ /// Plugin device constructor
+ ///
+ ///
+ ///
+ ///
+ ///
+ public EssentialsPluginDeviceTemplate(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;
+
+ 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;
+ }
+
+ // _comms gather for ASCII based API's
+ // TODO [ ] If not using an ASCII based API, delete the properties below
+ _commsGather = new CommunicationGather(_comms, CommsDelimiter);
+ AddPostActivationAction(() => _commsGather.LineReceived += Handle_LineRecieved);
+
+ // _comms byte buffer for HEX/byte based API's
+ // TODO [ ] If not using an HEX/byte based API, delete the properties below
+ _comms.BytesReceived += Handle_BytesReceived;
+ AddPostActivationAction(() => _comms.BytesReceived += Handle_BytesReceived);
+ }
+
+ #region Overrides of EssentialsBridgeableDevice
+
+ ///
+ /// Links the plugin device to the EISC bridge
+ ///
+ ///
+ ///
+ ///
+ ///
+ public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
+ {
+ var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart);
+
+ // This adds the join map to the collection on the bridge
+ if (bridge != null)
+ {
+ bridge.AddJoinMap(Key, joinMap);
+ }
+
+ var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
+
+ if (customJoins != null)
+ {
+ joinMap.SetCustomJoinData(customJoins);
+ }
+
+ Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
+ Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
+
+ // TODO [ ] Implement bridge links as needed
+
+ // links to bridge
+ trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
+
+ trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig);
+ ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]);
+
+ StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]);
+ OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]);
+
+ UpdateFeedbacks();
+
+ trilist.OnlineStatusChange += (o, a) =>
+ {
+ if (!a.DeviceOnLine) return;
+
+ trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
+ UpdateFeedbacks();
+ };
+ }
+
+ private void UpdateFeedbacks()
+ {
+ // TODO [ ] Update as needed for the plugin being developed
+ ConnectFeedback.FireUpdate();
+ OnlineFeedback.FireUpdate();
+ StatusFeedback.FireUpdate();
+ }
+
+ #endregion
+
+ private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args)
+ {
+ if (ConnectFeedback != null)
+ ConnectFeedback.FireUpdate();
+
+ if (StatusFeedback != null)
+ StatusFeedback.FireUpdate();
+ }
+
+ // TODO [ ] If not using an ASCII based API, delete the properties below
+ private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args)
+ {
+ // TODO [ ] Implement method
+ throw new System.NotImplementedException();
+ }
+
+ // TODO [ ] If not using an HEX/byte based API, delete the properties below
+ private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args)
+ {
+ // TODO [ ] Implement method
+ throw new System.NotImplementedException();
+ }
+
+ // TODO [ ] If not using an ACII based API, delete the properties below
+ ///
+ /// Sends text to the device plugin comms
+ ///
+ ///
+ /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
+ ///
+ /// Command to be sent
+ 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
+ ///
+ /// Sends bytes to the device plugin comms
+ ///
+ ///
+ /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
+ ///
+ /// Bytes to be sent
+ public void SendBytes(byte[] bytes)
+ {
+ if (bytes == null) return;
+
+ _comms.SendBytes(bytes);
+ }
+
+ ///
+ /// Polls the device
+ ///
+ ///
+ /// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed
+ ///
+ public void Poll()
+ {
+ // TODO [ ] Update Poll method as needed for the plugin being developed
+ throw new System.NotImplementedException();
+ }
+ }
+}
+
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs
new file mode 100644
index 0000000..76e5baa
--- /dev/null
+++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs
@@ -0,0 +1,92 @@
+using System.Collections.Generic;
+using PepperDash.Core;
+using PepperDash.Essentials.Core;
+
+namespace EssentialsPluginTemplate
+{
+ ///
+ /// Plugin device factory
+ ///
+ ///
+ /// Rename the class to match the device plugin being developed
+ ///
+ ///
+ /// "EssentialsPluginFactoryTemplate" renamed to "SamsungMdcFactory"
+ ///
+ public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory
+ {
+ ///
+ /// Plugin device factory constructor
+ ///
+ ///
+ /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin
+ ///
+ ///
+ ///
+ /// // Set the minimum Essentials Framework Version
+ /// MinimumEssentialsFrameworkVersion = "1.5.5";
+ /// // In the constructor we initialize the list with the typenames that will build an instance of this device
+#pragma warning disable 1570
+ /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" };
+#pragma warning restore 1570
+ ///
+ ///
+ public EssentialsPluginFactoryTemplate()
+ {
+ // 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() { "examplePluginDevice" };
+ }
+
+ ///
+ /// Builds and returns an instance of EssentialsPluginDeviceTemplate
+ ///
+ /// device configuration
+ /// plugin device or null
+ ///
+ /// 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.
+ ///
+ ///
+ 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();
+ if (propertiesConfig == null)
+ {
+ Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name);
+ return null;
+ }
+
+ // TODO [ ] Discuss with Andrew/Neil on recommended best practice
+
+ // Method 1
+ //var username = dc.Properties["control"].Value("tcpSshProperties").Username;
+ //var password = dc.Properties["control"].Value("tcpSshProperties").Password;
+ //var method = dc.Properties["control"].Value("method");
+
+ // Method 2 - Returns a JValue, has to be casted to string
+ var username = (string)dc.Properties["control"]["tcpSshProperties"]["username"];
+ var password = (string)dc.Properties["control"]["tcpSshProperties"]["password"];
+ var method = (string)dc.Properties["control"]["method"];
+
+ // build the plugin device comms & check for null
+ // TODO { ] As of PepperDash Core 1.0.41, HTTP and HTTPS are not valid eControlMethods and will throw an exception.
+ var comms = CommFactory.CreateCommForDevice(dc);
+ if (comms == null)
+ {
+ Debug.Console(0, "[{0}] Factory: failed to create comm for {1}", dc.Key, dc.Name);
+ return null;
+ }
+
+ return new EssentialsPluginDeviceTemplate(dc.Key, dc.Name, propertiesConfig, comms);
+ }
+
+ }
+}
\ No newline at end of file
diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj
index 5a9ae47..6517361 100644
--- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj
+++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj
@@ -46,22 +46,26 @@
off
+
+ False
+ ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll
+
False
- ..\EssentialsBuilds\PepperDashEssentials.dll
+ ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll
False
- ..\EssentialsBuilds\PepperDash_Core.dll
+ ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll
False
- ..\EssentialsBuilds\PepperDash_Essentials_Core.dll
+ ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll
False
- ..\EssentialsBuilds\PepperDash_Essentials_DM.dll
+ ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll
False
@@ -91,9 +95,9 @@
-
-
+
+
diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.suo b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.suo
deleted file mode 100644
index ad4bc10..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.suo and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.projectinfo b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.projectinfo
deleted file mode 100644
index acdbdf8..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.projectinfo and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.DM.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.DM.dll
deleted file mode 100644
index 8a9174a..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.DM.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.DeviceSupport.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.DeviceSupport.dll
deleted file mode 100644
index edc2569..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.DeviceSupport.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.EthernetCommunications.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.EthernetCommunications.dll
deleted file mode 100644
index 107864e..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.EthernetCommunications.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Fusion.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Fusion.dll
deleted file mode 100644
index f81b415..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Fusion.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Gateways.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Gateways.dll
deleted file mode 100644
index 106aad2..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Gateways.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.GeneralIO.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.GeneralIO.dll
deleted file mode 100644
index d8587c9..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.GeneralIO.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Lighting.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Lighting.dll
deleted file mode 100644
index 98252ba..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Lighting.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Shades.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Shades.dll
deleted file mode 100644
index ae4aec6..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.Shades.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.UI.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.UI.dll
deleted file mode 100644
index 21a5bdb..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Crestron.SimplSharpPro.UI.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Essentials Devices Common.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Essentials Devices Common.dll
deleted file mode 100644
index 9682fa5..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/Essentials Devices Common.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.config b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.config
deleted file mode 100644
index be17a6d..0000000
--- a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.config
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
- PDTEssentialsPluginT
- PDT.EssentialsPluginTemplate.EPI
- PDT.EssentialsPluginTemplate.EPI
- 1.009.0029
- SIMPL# Plugin
- 5
- 5
-
-
-
- 2020-02-13 3:58:57 PM
- 1.0.0.28767
-
-
- Crestron.SIMPLSharp, Version=2.0.58.0, Culture=neutral, PublicKeyToken=812d080f93e2de10
- 2.11.030
-
-
\ No newline at end of file
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.cplz b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.cplz
deleted file mode 100644
index 1e8161e..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.cplz and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.dll
deleted file mode 100644
index 23b639a..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.pdb b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.pdb
deleted file mode 100644
index e405a11..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PDT.EssentialsPluginTemplate.EPI.pdb and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDashEssentials.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDashEssentials.dll
deleted file mode 100644
index 3bb3fac..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDashEssentials.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Core.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Core.dll
deleted file mode 100644
index a6af5f8..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Core.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Essentials_Core.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Essentials_Core.dll
deleted file mode 100644
index 945cfb1..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Essentials_Core.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Essentials_DM.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Essentials_DM.dll
deleted file mode 100644
index 1e78aff..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/PepperDash_Essentials_DM.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpData.dat b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpData.dat
deleted file mode 100644
index 30d314c..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpData.dat and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpData.dat.der b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpData.dat.der
deleted file mode 100644
index 808a788..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpData.dat.der and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpNewtonsoft.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpNewtonsoft.dll
deleted file mode 100644
index 7d827e7..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpNewtonsoft.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpReflectionInterface.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpReflectionInterface.dll
deleted file mode 100644
index 4564d5d..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpReflectionInterface.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpSQLHelperInterface.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpSQLHelperInterface.dll
deleted file mode 100644
index f965c75..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpSQLHelperInterface.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpTimerEventInterface.dll b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpTimerEventInterface.dll
deleted file mode 100644
index 50a940d..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/SimplSharpTimerEventInterface.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/manifest.info b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/manifest.info
deleted file mode 100644
index bf684f8..0000000
--- a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/manifest.info
+++ /dev/null
@@ -1,78 +0,0 @@
-MainAssembly=PDT.EssentialsPluginTemplate.EPI.dll:6808b45c8c5d7c4d3852fe284ea334cf
-MainAssemblyMinFirmwareVersion=1.009.0029
-MainAssemblyResource=SimplSharpData.dat:820b61c48c8a2cace82957eed4cc377c
-MainAssemblyResource=SimplSharpData.dat.der:bf862965c00f3e6ec535e4e00e82d30c
-MainAssemblyResource=SimplSharpData.dat:820b61c48c8a2cace82957eed4cc377c
-MainAssemblyResource=SimplSharpData.dat.der:bf862965c00f3e6ec535e4e00e82d30c
-ü
-DependencySource=Crestron.SimplSharpPro.DeviceSupport.dll:caae4b4259aaf619059f0ae34473bfd2
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.DeviceSupport.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.DeviceSupport.dll:caae4b4259aaf619059f0ae34473bfd2
-ü
-DependencySource=Crestron.SimplSharpPro.DM.dll:bdf5acfa80cc3bb87f21deb891128b1d
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.DM.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.DM.dll:bdf5acfa80cc3bb87f21deb891128b1d
-ü
-DependencySource=Crestron.SimplSharpPro.EthernetCommunications.dll:36e663497195140ee6f1b4ebc53f5ea7
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.EthernetCommunications.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.EthernetCommunications.dll:36e663497195140ee6f1b4ebc53f5ea7
-ü
-DependencySource=Crestron.SimplSharpPro.Fusion.dll:2ceb645ad5aa098f78c4b6c963af2df2
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.Fusion.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.Fusion.dll:2ceb645ad5aa098f78c4b6c963af2df2
-ü
-DependencySource=Crestron.SimplSharpPro.Gateways.dll:7242e212aa3843228a5d91eb66829f8a
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.Gateways.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.Gateways.dll:7242e212aa3843228a5d91eb66829f8a
-ü
-DependencySource=Crestron.SimplSharpPro.GeneralIO.dll:8d02fa210764e02ccb11491caf122d53
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.GeneralIO.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.GeneralIO.dll:8d02fa210764e02ccb11491caf122d53
-ü
-DependencySource=Crestron.SimplSharpPro.Lighting.dll:5a4a355db03b075b1e731469c0440a86
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.Lighting.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.Lighting.dll:5a4a355db03b075b1e731469c0440a86
-ü
-DependencySource=Crestron.SimplSharpPro.Shades.dll:7061e8c8e7e8a57e2bc5a156e037f70b
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.Shades.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.Shades.dll:7061e8c8e7e8a57e2bc5a156e037f70b
-ü
-DependencySource=Crestron.SimplSharpPro.UI.dll:089312a0cb0b4537072d4eb234e71e0e
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Crestron.SimplSharpPro.UI.dll
-DependencyMainAssembly=Crestron.SimplSharpPro.UI.dll:089312a0cb0b4537072d4eb234e71e0e
-ü
-DependencySource=Essentials Devices Common.dll:2a3e604271af752bcc3d44a88c413a04
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:Essentials Devices Common.dll
-DependencyMainAssembly=Essentials Devices Common.dll:2a3e604271af752bcc3d44a88c413a04
-ü
-DependencySource=PepperDashEssentials.dll:5f8619a0a04001da41c15402c0865638
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:PepperDashEssentials.dll
-DependencyMainAssembly=PepperDashEssentials.dll:5f8619a0a04001da41c15402c0865638
-ü
-DependencySource=PepperDash_Core.dll:70f5a232b163f80b5d9f30b499a6eb18
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:PepperDash_Core.dll
-DependencyMainAssembly=PepperDash_Core.dll:70f5a232b163f80b5d9f30b499a6eb18
-ü
-DependencySource=PepperDash_Essentials_Core.dll:96e019f9a7bee024e462a74c0594fc6f
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:PepperDash_Essentials_Core.dll
-DependencyMainAssembly=PepperDash_Essentials_Core.dll:96e019f9a7bee024e462a74c0594fc6f
-ü
-DependencySource=PepperDash_Essentials_DM.dll:80c9770b1f20885ea340683270b90501
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:PepperDash_Essentials_DM.dll
-DependencyMainAssembly=PepperDash_Essentials_DM.dll:80c9770b1f20885ea340683270b90501
-ü
-DependencySource=SimplSharpNewtonsoft.dll:9c09c5d30daedddf895c36acbface0d5
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:SimplSharpNewtonsoft.dll
-DependencyMainAssembly=SimplSharpNewtonsoft.dll:9c09c5d30daedddf895c36acbface0d5
-ü
-DependencySource=SimplSharpReflectionInterface.dll:e3ff8edbba84ccd7155b9984e67488b2
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:SimplSharpReflectionInterface.dll
-DependencyMainAssembly=SimplSharpReflectionInterface.dll:e3ff8edbba84ccd7155b9984e67488b2
-ü
-DependencySource=SimplSharpSQLHelperInterface.dll:f0c505ddecd8a783d4b75217501cbb72
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:SimplSharpSQLHelperInterface.dll
-DependencyMainAssembly=SimplSharpSQLHelperInterface.dll:f0c505ddecd8a783d4b75217501cbb72
-ü
-DependencySource=SimplSharpTimerEventInterface.dll:c08c24694aafb0f575a49c66f8491477
-DependencyPath=PDT.EssentialsPluginTemplate.EPI.cplz:SimplSharpTimerEventInterface.dll
-DependencyMainAssembly=SimplSharpTimerEventInterface.dll:c08c24694aafb0f575a49c66f8491477
diff --git a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/manifest.ser b/PDT.EssentialsPluginTemplate.EPI/bin/Debug/manifest.ser
deleted file mode 100644
index 18c605b..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/bin/Debug/manifest.ser and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.csproj.FileListAbsolute.txt b/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.csproj.FileListAbsolute.txt
deleted file mode 100644
index 48cd5e5..0000000
--- a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.csproj.FileListAbsolute.txt
+++ /dev/null
@@ -1,23 +0,0 @@
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\obj\Debug\ResolveAssemblyReference.cache
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.pdb
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\PepperDash_Core.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\PepperDash_Essentials_Core.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\PepperDash_Essentials_DM.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\PepperDashEssentials.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\SimplSharpNewtonsoft.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\SimplSharpReflectionInterface.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.Lighting.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.Gateways.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\SimplSharpSQLHelperInterface.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.Fusion.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.Shades.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.EthernetCommunications.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.DeviceSupport.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.UI.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\SimplSharpTimerEventInterface.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Essentials Devices Common.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.GeneralIO.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\Crestron.SimplSharpPro.DM.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\obj\Debug\NvxUrlRoutingClientEpi.dll
-C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\obj\Debug\NvxUrlRoutingClientEpi.pdb
diff --git a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.dll b/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.dll
deleted file mode 100644
index 4c69d2c..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.pdb b/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.pdb
deleted file mode 100644
index 40bba73..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/NvxUrlRoutingClientEpi.pdb and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.csproj.FileListAbsolute.txt b/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.csproj.FileListAbsolute.txt
deleted file mode 100644
index 05eec82..0000000
--- a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.csproj.FileListAbsolute.txt
+++ /dev/null
@@ -1,46 +0,0 @@
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\obj\Debug\ResolveAssemblyReference.cache
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PDT.EssentialsPluginTemplate.EPI.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PDT.EssentialsPluginTemplate.EPI.pdb
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PepperDash_Core.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PepperDash_Essentials_Core.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PepperDash_Essentials_DM.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PepperDashEssentials.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\SimplSharpNewtonsoft.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\SimplSharpReflectionInterface.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.Lighting.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.Gateways.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\SimplSharpSQLHelperInterface.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.Fusion.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.Shades.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.EthernetCommunications.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.DeviceSupport.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.UI.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\SimplSharpTimerEventInterface.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Essentials Devices Common.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.GeneralIO.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.DM.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\obj\Debug\PDT.EssentialsPluginTemplate.EPI.dll
-C:\Users\JTA\Documents\Stash Folder\Frameworks\PDT.EssentialsPluginTemplate.EPI\PDT.EssentialsPluginTemplate.EPI\obj\Debug\PDT.EssentialsPluginTemplate.EPI.pdb
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\obj\Debug\ResolveAssemblyReference.cache
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\obj\Debug\PDT.EssentialsPluginTemplate.EPI.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\obj\Debug\PDT.EssentialsPluginTemplate.EPI.pdb
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PDT.EssentialsPluginTemplate.EPI.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PDT.EssentialsPluginTemplate.EPI.pdb
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PepperDash_Core.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PepperDash_Essentials_Core.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PepperDash_Essentials_DM.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\PepperDashEssentials.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\SimplSharpNewtonsoft.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\SimplSharpReflectionInterface.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.Lighting.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.Gateways.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\SimplSharpSQLHelperInterface.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.Fusion.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.Shades.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.EthernetCommunications.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.DeviceSupport.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.UI.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\SimplSharpTimerEventInterface.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Essentials Devices Common.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.GeneralIO.dll
-C:\Working Directories\PD\EssentialsPluginTemplate\PDT.EssentialsPluginTemplate.EPI\bin\Debug\Crestron.SimplSharpPro.DM.dll
diff --git a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.dll b/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.dll
deleted file mode 100644
index 23b639a..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.dll and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.pdb b/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.pdb
deleted file mode 100644
index d636ac2..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/PDT.EssentialsPluginTemplate.EPI.pdb and /dev/null differ
diff --git a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/ResolveAssemblyReference.cache b/PDT.EssentialsPluginTemplate.EPI/obj/Debug/ResolveAssemblyReference.cache
deleted file mode 100644
index 61ff231..0000000
Binary files a/PDT.EssentialsPluginTemplate.EPI/obj/Debug/ResolveAssemblyReference.cache and /dev/null differ
diff --git a/README.md b/README.md
index 2e77fe0..9447de4 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,33 @@
-# PDT.EssentialsPluginTemplate.EPI
+# Essentials Plugin Template (c) 2020
+## License
+
+Provided under MIT license
+
+## Overview
+
+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.
+
+## 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.
+
+## Dependencies
+
+The [Essentials](https://github.com/PepperDash/Essentials) libraries are required. They referenced via nuget. You must have nuget.exe installed and in the `PATH` environment variable to use the following command. Nuget.exe is available at [nuget.org](https://dist.nuget.org/win-x86-commandline/latest/nuget.exe).
+
+### Installing Dependencies
+
+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 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
diff --git a/packages.config b/packages.config
new file mode 100644
index 0000000..fa05b32
--- /dev/null
+++ b/packages.config
@@ -0,0 +1,3 @@
+
+
+
\ No newline at end of file