docs: update cleanup section with detailed file structure example

fix: Update README workflow to use main branch and correct author/company names in Directory.Build.props

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

@@ -9,16 +9,7 @@ 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

.github/workflows/essentialsplugins-updatereadme-caller.yml

@@ -0,0 +1,14 @@
+
+name: Generate README
+
+on:
+  push:
+    branches-ignore:
+      - 'robot-docs'
+
+jobs:
+  call-update-readme:
+    uses: PepperDash/workflow-templates/.github/workflows/update-readme.yml@main
+    with:
+      target-branch: ${{ github.ref_name }}
+

Readme-Upgrade-to-4Series.md

@@ -0,0 +1,110 @@
+![PepperDash Essentials Plugin Logo](/images/essentials-plugin-blue.png)
+
+# Upgrading an EPI: Essentials v1.x → v2.x
+
+## Preparation
+
+1. **Clone the Template Repo referred to as TR** to your local machine.
+    - [EssentialsPluginTemplate](https://github.com/PepperDash/EssentialsPluginTemplate) 
+2. **Checkout `main` branch** in the TR.
+
+## Branching
+
+4. In your EPI repo:
+   - Confirm it does **not already support Essentials v2.x**.
+   - Ensure there is **no existing 4-series update branch**.
+   - Create a new branch (e.g., `feature/4-series-updates`) from `main`.
+
+## Upgrade Steps
+
+5. In the new branch:
+   - **Replace** EPI `.github` files/folders with those from TR as needed.
+     - *Note:* Retain any custom workflows if required. Consult with PepperDash Team if unsure.
+   - **Copy** the following from TR to EPI:
+     - `.releaserc.json` (root)
+     - `epi-make-model.4Series.sln` (root)
+     - `src/epi-make-model.4Series.csproj` (create `src` folder if missing)
+     - `images` folder (if your `readme.md` lacks the standard logo)
+   - **Initial Commit:** Commit changes, but do **not** push yet.
+
+6. **If EPI has a `src/*.nuspec` file:**
+   - Record these values from `Nuspec` for later:
+     - `<id>` (Package ID)
+     - `<projectUrl>` (Project URL)
+     - `<title>` (Assembly Title)
+
+7. **Open Solution:**
+   - Open `epi-make-model.4Series.sln` in Visual Studio 2022.
+   - If errors occur, ensure the `.csproj` file is located within `src` folder.
+
+8. **Update Project Properties:**
+   - In `src/epi-make-model.4Series.csproj`, update:
+     - `AssemblyTitle` (from nuspec `<title>`)
+     - `RootNamespace` (from existing EPI, device namespace actual)
+     - `PackageProjectUrl` (from nuspec `<projectUrl>`)
+   - **Rename `make-model` build path references shown below:**  
+
+     ![defineBuildObjectstoRemove](/images/upgrade-to-4Series/removeObsoleteReferences.png)
+   - **Add runtime exclusion:**  
+     Add `<ExcludeAssets>runtime</ExcludeAssets>` to the PepperDash Essentials `PackageReference`. 
+
+     ![addRuntimeExclusion](/images/upgrade-to-4Series/addRuntumeExclusion.png)
+
+9. **Copy Build Files:**
+   - Copy `src/Directory.Build.props` and `src/Directory.Build.targets` from TR.
+   - Update `RepositoryUrl` in `Directory.Build.props` to match nuspec `PackageProjectUrl`.
+   - Remove "template" text from `<Product>` in `Directory.Build.props` as needed.
+
+10. **Clean Up:**
+    - Delete old Visual Studio 2008 files: `.sln`, `.suo`, `.nuspec`, `.csproj`, `.csproj.user`, `.projectinfo`.
+    - Ensure file structure matches below example:
+```
+  ├── src/
+  │   ├── Directory.Build.props
+  │   ├── Directory.Build.tagets
+  │   ├── *.3Series.csproj
+  │   └── *.4Series.csproj
+  ├── .releaserc.json
+  ├── *.3Series.sln
+  ├── *.4Series.sln
+  ├── LICENSE.md
+  └── README.md
+```
+
+11. **Rename Solution/Project** as needed.  
+
+    ![renameEpiSolution](/images/upgrade-to-4Series/renameEpiSolution.png)
+
+12. **Update Project References and Dependencies**
+    - Remove old PepperDash Essentials dependency.
+    - Add PepperDash Essentials v2.x dependency via Visual Studio 2022 > Project > `Manage Nuget Packages`.  
+
+    ![removeExistingReferences](/images/upgrade-to-4Series/removeExistingDependencies.png)
+
+13. **Update Factory Class:**  
+    Set `MinimumEssentialsFrameworkVersion` to match the Essentials version dependency.
+
+14. **Build Solution:**  
+    Ensure solution compiles (warnings about obsolete `Debug.Console` calls are OK).
+
+15. **Update Debug Calls:**  
+    Replace `Debug.Console` with `Debug.Log` methods as appropriate (see table). 
+
+    ![replaceDebugConsoleMethods](/images/upgrade-to-4Series/replaceExistingDebugConsoleMethods.png)
+
+## Completion Checklist
+
+- [ ] EPI compiles with **no warnings**.
+- [ ] **Obsolete methods** updated to modern equivalents.
+- [ ] **Workflows** complete successfully; packages generated via GitHub and NuGet.org.
+- [ ] `readme.md` includes:
+  - Usage/setup instructions
+  - Example SIMPL Windows bridge joinmap
+  - Example device communication structure/properties
+- [ ] EPI tested against full release Essentials version.
+- [ ] EPI tested by another developer.
+- [ ] Full release of EPI.
+
+---
+
+*For questions about workflows or customizations, consult with PepperDash Team.*

epi-make-model.3Series.sln

@@ -0,0 +1,20 @@
+
+Microsoft Visual Studio Solution File, Format Version 10.00
+# Visual Studio 2008
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "epi-make-model.3Series", "src\epi-make-model.3Series.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

epi-make-model.4Series.sln

@@ -3,7 +3,7 @@ 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}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "epi-make-model.4Series", "src\epi-make-model.4Series.csproj", "{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

packages.config

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

src/Directory.Build.props

@@ -2,14 +2,14 @@
   <PropertyGroup>
     <Version>1.0.0-local</Version>
     <InformationalVersion>$(Version)</InformationalVersion>
-    <Authors>PepperDash Technologies</Authors>
+    <Authors>PepperDash Technology</Authors>
-    <Company>PepperDash Technologies</Company>
+    <Company>PepperDash Technology</Company>
     <Product>PepperDash Essentials Plugin Template</Product>
-    <Copyright>Copyright ©  2024</Copyright>
+    <Copyright>Copyright © 2025</Copyright>
     <RepositoryUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageTags>Crestron; 4series</PackageTags>
-    <PackageOutputPath>../output</PackageOutputPath>
+    <PackageOutputPath>..\output</PackageOutputPath>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <PackageLicenseFile>LICENSE.md</PackageLicenseFile>
     <PackageReadmeFile>README.md</PackageReadmeFile>

src/MakeModelBridgeJoinMap.cs

@@ -1,6 +1,6 @@
 using PepperDash.Essentials.Core;
 
-namespace EssentialsPluginTemplate
+namespace PepperDash.Essentials.Plugin
 {
 	/// <summary>
 	/// Plugin device Bridge Join Map

src/MakeModelConfigObject.cs

@@ -2,7 +2,7 @@
 using Newtonsoft.Json;
 using PepperDash.Essentials.Core;
 
-namespace EssentialsPluginTemplate
+namespace PepperDash.Essentials.Plugin
 {
 	/// <summary>
 	/// Plugin device configuration object

src/MakeModelCrestronDevice.cs

@@ -1,13 +1,13 @@
 // For Basic SIMPL# Classes
 // For Basic SIMPL#Pro classes
 
-using Crestron.SimplSharpPro.DeviceSupport;
 using Crestron.SimplSharpPro;
+using Crestron.SimplSharpPro.DeviceSupport;
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Bridges;
 
-namespace EssentialsPluginTemplate
+namespace PepperDash.Essentials.Plugin
 {
 	/// <summary>
 	/// Plugin device

src/MakeModelDevice.cs

@@ -7,8 +7,7 @@ using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Bridges;
 using PepperDash.Essentials.Core.Queues;
 
-
+namespace PepperDash.Essentials.Plugin
-namespace EssentialsPluginTemplate
 {
 	/// <summary>
 	/// Plugin device template for third party devices that use IBasicCommunication

src/MakeModelFactory.cs

@@ -1,9 +1,9 @@
 using System.Collections.Generic;
+using Crestron.SimplSharpPro.UI;
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
-using Crestron.SimplSharpPro.UI;
 
-namespace EssentialsPluginTemplate
+namespace PepperDash.Essentials.Plugin
 {
 	/// <summary>
 	/// Plugin device factory for devices that use IBasicCommunication

src/MakeModelLogicDevice.cs

@@ -3,7 +3,7 @@ using PepperDash.Core;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Bridges;
 
-namespace EssentialsPluginTemplate
+namespace PepperDash.Essentials.Plugin
 {
 	/// <summary>
 	/// Plugin device template for logic devices that don't communicate outside the program

src/PDT.EssentialsPluginTemplate.nuspec

@@ -1,23 +0,0 @@
-<?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/epi-make-model.3Series.csproj

@@ -7,8 +7,8 @@
     <ProjectGuid>{9D249E47-8F95-4437-A6BB-563510287AD1}</ProjectGuid>
     <OutputType>Library</OutputType>
     <AppDesignerFolder>Properties</AppDesignerFolder>
-    <RootNamespace>PDT.EssentialsPluginTemplate.EPI</RootNamespace>
+    <RootNamespace>PepperDash.Essentials.Plugin</RootNamespace>
-    <AssemblyName>PDT.EssentialsPluginTemplate.EPI</AssemblyName>
+    <AssemblyName>MakeModelPlugin</AssemblyName>
     <ProjectTypeGuids>{0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>
     <PlatformFamilyName>WindowsCE</PlatformFamilyName>
     <PlatformID>E2BECB1F-8C8C-41ba-B736-9BE7D946A398</PlatformID>
@@ -48,7 +48,7 @@
   <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>
+      <HintPath>C:\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>
@@ -73,39 +73,39 @@
     </Reference>
     <Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
+      <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
+      <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll</HintPath>
+      <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll</HintPath>
     </Reference>
     <Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
+      <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll</HintPath>
+      <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll</HintPath>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
     <Reference Include="System.Data" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="EssentialsPluginTemplateLogicDevice.cs" />
+    <Compile Include="MakeModelCrestronDevice.cs" />
-    <Compile Include="EssentialsPluginTemplateCrestronDevice.cs" />
+    <Compile Include="MakeModelBridgeJoinMap.cs" />
-    <Compile Include="EssentialsPluginTemplateBridgeJoinMap.cs" />
+    <Compile Include="MakeModelConfigObject.cs" />
-    <Compile Include="EssentialsPluginTemplateConfigObject.cs" />
+    <Compile Include="MakeModelDevice.cs" />
-    <Compile Include="EssentialsPluginTemplateFactory.cs" />
+    <Compile Include="MakeModelFactory.cs" />
+    <Compile Include="MakeModelLogicDevice.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
-    <Compile Include="EssentialsPluginTemplateDevice.cs" />
     <None Include="Properties\ControlSystem.cfg" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CompactFramework.CSharp.targets" />

src/epi-make-model.4Series.csproj

@@ -4,17 +4,17 @@
 	</PropertyGroup>
 	<PropertyGroup>
 		<TargetFramework>net472</TargetFramework>
-		<RootNamespace>PDT.EssentialsPluginTemplate.EPI</RootNamespace>
+		<RootNamespace>PepperDash.Essentials.Plugin</RootNamespace>
 		<Deterministic>false</Deterministic>
-		<AssemblyTitle>PDT.EssentialsPluginTemplate.EPI</AssemblyTitle>
+		<AssemblyTitle>PepperDash.Essentials.Plugin.Make.Model</AssemblyTitle>
-		<Company>PepperDash Technologies</Company>
+		<Company>PepperDash Technology</Company>
 		<Description>This software is a template for a PepperDash Essentials Plugin.</Description>
-		<Copyright>Copyright 2024</Copyright>
+		<Copyright>Copyright 2025</Copyright>
 		<Version>1.0.0-local</Version>
 		<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
 		<InformationalVersion>$(Version)</InformationalVersion>
-		<OutputPath>4Series\bin\$(Configuration)\</OutputPath>
+		<OutputPath>bin\$(Configuration)\</OutputPath>
-		<Authors>PepperDash Technologies</Authors>
+		<Authors>PepperDash Technology</Authors>
 		<PackageId>Pepperdash.Essentials.Plugins.Template</PackageId>
 		<PackageProjectUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</PackageProjectUrl>
 		<PackageTags>crestron 4series essentials plugin template</PackageTags>
@@ -31,10 +31,20 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<None Remove="PDT.EssentialsPluginTemplate.projectinfo" />
+    <None Remove="epi-make-model.projectinfo" />
-	</ItemGroup>
+  </ItemGroup>
 
-	<ItemGroup>
+  <ItemGroup>
-	  <PackageReference Include="PepperDashEssentials" Version="2.0.0-beta-2559" />
+ 	<PackageReference Include="PepperDashEssentials" Version="2.0.0" >
-	</ItemGroup>
+  		<ExcludeAssets>runtime</ExcludeAssets>
+ 	</PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" />
+  </ItemGroup>
 </Project>