diff --git a/.github/workflows/EssentialsPlugins-builds-caller.yml b/.github/workflows/EssentialsPlugins-builds-caller.yml new file mode 100644 index 0000000..606fcb9 --- /dev/null +++ b/.github/workflows/EssentialsPlugins-builds-caller.yml @@ -0,0 +1,22 @@ +name: Build Essentials Plugin + +on: + push: + branches: + - '**' + +jobs: + getVersion: + uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-getversion.yml@main + secrets: inherit + + 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 }} \ No newline at end of file diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml deleted file mode 100644 index f3f4657..0000000 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ /dev/null @@ -1,285 +0,0 @@ -name: Branch Build Using Docker - -on: - push: - branches: - - feature/* - - hotfix/* - - release/* - - dev* - -env: - # 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 master as the release branch. Change as necessary - RELEASE_BRANCH: main -jobs: - Build_Project: - runs-on: windows-2019 - steps: - # First we checkout the source repo - - name: Checkout repo - uses: actions/checkout@v2 - with: - fetch-depth: 0 - # Fetch all tags - - name: Fetch tags - run: git fetch --tags - # Generate the appropriate version number - - name: Set Version Number - shell: powershell - run: | - $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 - } - '^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\/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 - } - } - echo "VERSION=$newVersionString" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - # Use the version number to set the version of the assemblies - - name: Update AssemblyInfo.cs - shell: powershell - run: | - 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($Env:VERSION, "\d+\.\d+\.\d+.*"); - if ($r.Success) { - Write-Output "Updating Assembly Version to $Env:VERSION ..."; - Update-AllAssemblyInfoFiles $Env:VERSION; - } - else { - Write-Output " "; - Write-Output "Error: Input version $Env:VERSION does not match x.y.z format!" - Write-Output " "; - Write-Output "Unable to apply version to AssemblyInfo.cs files"; - } - - name: restore Nuget Packages - run: nuget install .\packages.config -OutputDirectory .\packages -ExcludeVersion - # Set the SOLUTION_PATH - - name: Get SLN Path - shell: powershell - run: | - $solution_path = Get-ChildItem *.sln -recurse - $solution_path = $solution_path.FullName - $solution_path = $solution_path -replace "(?:[^\\]*\\){4}", "" - Write-Output $solution_path - echo "SOLUTION_PATH=$($solution_path)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - # Set the SOLUTION_FILE - - name: Get SLN File - shell: powershell - run: | - $solution_file = Get-ChildItem .\*.sln -recurse -Path "$($Env:GITHUB_WORKSPACE)" - echo "SOLUTION_FILE=$($solution_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - # Login to Docker - - 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)"" -BuildSolutionConfiguration $($ENV:BUILD_TYPE)" - # Zip up the output files as needed - - name: Zip Build Output - shell: powershell - run: | - $destination = "$($Env:GITHUB_HOME)\output" - New-Item -ItemType Directory -Force -Path ($destination) - Get-ChildItem ($destination) - $exclusions = "packages" - # 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", "*.nuspec" | 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 - } - } - 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 - # Write the version to a file to be consumed by the push jobs - - name: Write Version - run: Write-Output "$($Env:VERSION)" | Out-File -FilePath "$($Env:GITHUB_HOME)\output\version.txt" - # Upload output files - - name: Upload Build Output - uses: actions/upload-artifact@v1 - with: - name: Build - path: ./${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip - # Upload the Version file as an artifact - - name: Upload version.txt - uses: actions/upload-artifact@v1 - with: - name: Version - path: ${{env.GITHUB_HOME}}\output\version.txt - # Create the release on the source repo - - name: Create Release - id: create_release - uses: fleskesvor/create-release@feature/support-target-commitish - 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 }} - Push_Nuget_Package: - needs: Build_Project - runs-on: windows-2019 - env: - NUSPECNAME: default - steps: - - name: Get nuget File - shell: powershell - run: | - $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPECNAME=$($nuspec_file.BaseName)" >> $GITHUB_ENV - echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Download Build Version Info - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: actions/download-artifact@v1 - with: - name: Version - - name: Set Version Number - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - shell: powershell - run: | - Get-ChildItem "./Version" - $version = Get-Content -Path ./Version/version.txt - Write-Host "Version: $version" - echo "VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - Remove-Item -Path ./Version/version.txt - Remove-Item -Path ./Version - - name: Download Build output - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: actions/download-artifact@v1 - with: - name: Build - path: ./ - - name: Unzip Build file - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: | - Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ - Remove-Item -Path .\*.zip - - name: Copy Files to root & delete output directory - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: | - Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") - Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ - Remove-Item -Path .\output -Recurse - #Pushes to github nuget store - - name: Add nuget.exe - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: nuget/setup-nuget@v1 - - name: Add Github Packages source - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} - # Pushes to nuget gallery, not needed unless publishing publicly - - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget push **/*.nupkg -source github - - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml deleted file mode 100644 index 869ddf9..0000000 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ /dev/null @@ -1,233 +0,0 @@ -name: Main Build using Docker - -on: - release: - types: - - released - branches: - - main - -env: - # 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 master as the release branch. Change as necessary - RELEASE_BRANCH: main -jobs: - Build_Project: - runs-on: windows-2019 - steps: - # First we checkout the source repo - - name: Checkout repo - uses: actions/checkout@v2 - with: - fetch-depth: 0 - # Fetch all tags - - name: Fetch tags - run: git fetch --tags - # Generate the appropriate version number - - name: Set Version Number - shell: powershell - env: - TAG_NAME: ${{ github.event.release.tag_name }} - run: echo "VERSION=$($Env:TAG_NAME)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - # Use the version number to set the version of the assemblies - - name: Update AssemblyInfo.cs - shell: powershell - run: | - 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($Env:VERSION, "\d+\.\d+\.\d+.*"); - if ($r.Success) { - Write-Output "Updating Assembly Version to $Env:VERSION ..."; - Update-AllAssemblyInfoFiles $Env:VERSION; - } - else { - Write-Output " "; - Write-Output "Error: Input version $Env:VERSION does not match x.y.z format!" - Write-Output " "; - Write-Output "Unable to apply version to AssemblyInfo.cs files"; - } - - name: restore Nuget Packages - run: nuget install .\packages.config -OutputDirectory .\packages -ExcludeVersion - # Set the SOLUTION_PATH - - name: Get SLN Path - shell: powershell - run: | - $solution_path = Get-ChildItem *.sln -recurse - $solution_path = $solution_path.FullName - $solution_path = $solution_path -replace "(?:[^\\]*\\){4}", "" - Write-Output $solution_path - echo "SOLUTION_PATH=$($solution_path)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - # Set the SOLUTION_FILE - - name: Get SLN File - shell: powershell - run: | - $solution_file = Get-ChildItem .\*.sln -recurse -Path "$($Env:GITHUB_WORKSPACE)" - echo "SOLUTION_FILE=$($solution_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - # Login to Docker - - 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)"" -BuildSolutionConfiguration $($ENV:BUILD_TYPE)" - # Zip up the output files as needed - - name: Zip Build Output - shell: powershell - run: | - $destination = "$($Env:GITHUB_HOME)\output" - New-Item -ItemType Directory -Force -Path ($destination) - Get-ChildItem ($destination) - $exclusions = "packages" - # 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", "*.nuspec", "*.md" | 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 - } - } - 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 - # Write the version to a file to be consumed by the push jobs - - name: Write Version - run: Write-Output "$($Env:VERSION)" | Out-File -FilePath "$($Env:GITHUB_HOME)\output\version.txt" - # Upload output files - - name: Upload Build Output - uses: actions/upload-artifact@v1 - with: - name: Build - path: ./${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip - # Upload the Version file as an artifact - - name: Upload version.txt - uses: actions/upload-artifact@v1 - with: - name: Version - path: ${{env.GITHUB_HOME}}\output\version.txt - # Upload the build package to the release - - name: Upload Release Package - id: upload_release - uses: actions/upload-release-asset@v1 - with: - upload_url: ${{ github.event.release.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 }} - Push_Nuget_Package: - needs: Build_Project - runs-on: windows-2019 - env: - NUSPECNAME: default - steps: - - name: Get nuget File - shell: powershell - run: | - $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPECNAME=$($nuspec_file.BaseName)" >> $GITHUB_ENV - echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Download Build Version Info - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: actions/download-artifact@v1 - with: - name: Version - - name: Set Version Number - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - shell: powershell - run: | - Get-ChildItem "./Version" - $version = Get-Content -Path ./Version/version.txt - Write-Host "Version: $version" - echo "VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - Remove-Item -Path ./Version/version.txt - Remove-Item -Path ./Version - - name: Download Build output - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: actions/download-artifact@v1 - with: - name: Build - path: ./ - - name: Unzip Build file - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: | - Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ - Remove-Item -Path .\*.zip - - name: Copy Files to root & delete output directory - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: | - Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") - Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ - Remove-Item -Path .\output -Recurse - #Pushes to github nuget store - - name: Add nuget.exe - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: nuget/setup-nuget@v1 - - name: Add Github Packages source - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} - # Pushes to nuget gallery, not needed unless publishing publicly - - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget push **/*.nupkg -source github - - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/.github/workflows/essentialsplugins-updatereadme-caller.yml b/.github/workflows/essentialsplugins-updatereadme-caller.yml new file mode 100644 index 0000000..8f4bbe3 --- /dev/null +++ b/.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 }} + diff --git a/.releaserc.json b/.releaserc.json new file mode 100644 index 0000000..e6ec36a --- /dev/null +++ b/.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" + } + ] +} diff --git a/README.md b/README.md index 8dfb905..458eca2 100644 --- a/README.md +++ b/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 @@ -29,6 +31,7 @@ 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 @@ -37,7 +40,7 @@ If you need a different version of PepperDash Core, use the command `nuget insta ### 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. +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 @@ -45,10 +48,13 @@ For renaming instructions in particular, see the XML `remarks` tags on class def ## Generating Nuget Package -In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec-TEMPLATE" +In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" -1. Remove the -TEMPLATE so that the extention is .nuspec. -2. Rename the file to match your plugin solution name -3. Edit the file to include your project specifics including +1. Rename the file to match your plugin solution name +2. Edit the file to include your project specifics including 1. PepperDash.Essentials.Plugin.MakeModel Convention is to use the prefix "PepperDash.Essentials.Plugin" and include the MakeModel of the device. - 2. https://github.com/PepperDash/EssentialsPluginTemplate Change to your url to the project repo \ No newline at end of file + 2. https://github.com/PepperDash/EssentialsPluginTemplate 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__ \ No newline at end of file diff --git a/Readme-Upgrade-to-4Series.md b/Readme-Upgrade-to-4Series.md new file mode 100644 index 0000000..d41cc6b --- /dev/null +++ b/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: + - `` (Package ID) + - `` (Project URL) + - `` (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.* \ No newline at end of file diff --git a/src/PDT.EssentialsPluginTemplate.EPI.sln b/epi-make-model.3Series.sln similarity index 81% rename from src/PDT.EssentialsPluginTemplate.EPI.sln rename to epi-make-model.3Series.sln index f453fd6..b106642 100644 --- a/src/PDT.EssentialsPluginTemplate.EPI.sln +++ b/epi-make-model.3Series.sln @@ -1,20 +1,20 @@ - -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 + +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 diff --git a/epi-make-model.4Series.sln b/epi-make-model.4Series.sln new file mode 100644 index 0000000..e073161 --- /dev/null +++ b/epi-make-model.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}") = "epi-make-model.4Series", "src\epi-make-model.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 diff --git a/images/essentials-plugin-blue.png b/images/essentials-plugin-blue.png new file mode 100644 index 0000000..c94b320 Binary files /dev/null and b/images/essentials-plugin-blue.png differ diff --git a/images/essentials-plugin-white.png b/images/essentials-plugin-white.png new file mode 100644 index 0000000..73d6b3f Binary files /dev/null and b/images/essentials-plugin-white.png differ diff --git a/images/upgrade-to-4Series/addRuntumeExclusion.png b/images/upgrade-to-4Series/addRuntumeExclusion.png new file mode 100644 index 0000000..5ab0b9a Binary files /dev/null and b/images/upgrade-to-4Series/addRuntumeExclusion.png differ diff --git a/images/upgrade-to-4Series/removeExistingDependencies.png b/images/upgrade-to-4Series/removeExistingDependencies.png new file mode 100644 index 0000000..7c7fef2 Binary files /dev/null and b/images/upgrade-to-4Series/removeExistingDependencies.png differ diff --git a/images/upgrade-to-4Series/removeObsoleteReferences.png b/images/upgrade-to-4Series/removeObsoleteReferences.png new file mode 100644 index 0000000..9392793 Binary files /dev/null and b/images/upgrade-to-4Series/removeObsoleteReferences.png differ diff --git a/images/upgrade-to-4Series/renameEpiSolution.png b/images/upgrade-to-4Series/renameEpiSolution.png new file mode 100644 index 0000000..1cf19a1 Binary files /dev/null and b/images/upgrade-to-4Series/renameEpiSolution.png differ diff --git a/images/upgrade-to-4Series/replaceExistingDebugConsoleMethods.png b/images/upgrade-to-4Series/replaceExistingDebugConsoleMethods.png new file mode 100644 index 0000000..2b79542 Binary files /dev/null and b/images/upgrade-to-4Series/replaceExistingDebugConsoleMethods.png differ diff --git a/packages.config b/packages.config index 2a12f4c..c0df495 100644 --- a/packages.config +++ b/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> \ No newline at end of file diff --git a/src/Directory.Build.props b/src/Directory.Build.props new file mode 100644 index 0000000..206b6c0 --- /dev/null +++ b/src/Directory.Build.props @@ -0,0 +1,21 @@ +<Project> + <PropertyGroup> + <Version>1.0.0-local</Version> + <InformationalVersion>$(Version)</InformationalVersion> + <Authors>PepperDash Technology</Authors> + <Company>PepperDash Technology</Company> + <Product>PepperDash Essentials Plugin Template</Product> + <Copyright>Copyright © 2025</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> diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets new file mode 100644 index 0000000..3af6067 --- /dev/null +++ b/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> diff --git a/src/EssentialsPluginTemplateBridgeJoinMap.cs b/src/MakeModelBridgeJoinMap.cs similarity index 94% rename from src/EssentialsPluginTemplateBridgeJoinMap.cs rename to src/MakeModelBridgeJoinMap.cs index 140d021..0d20a8f 100644 --- a/src/EssentialsPluginTemplateBridgeJoinMap.cs +++ b/src/MakeModelBridgeJoinMap.cs @@ -1,101 +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)) - { - } - } +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin +{ + /// <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)) + { + } + } } \ No newline at end of file diff --git a/src/EssentialsPluginTemplateConfigObject.cs b/src/MakeModelConfigObject.cs similarity index 99% rename from src/EssentialsPluginTemplateConfigObject.cs rename to src/MakeModelConfigObject.cs index e216796..b247414 100644 --- a/src/EssentialsPluginTemplateConfigObject.cs +++ b/src/MakeModelConfigObject.cs @@ -1,8 +1,8 @@ -using System.Collections.Generic; -using Newtonsoft.Json; -using PepperDash.Essentials.Core; - -namespace EssentialsPluginTemplate +using System.Collections.Generic; +using Newtonsoft.Json; +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin { /// <summary> /// Plugin device configuration object diff --git a/src/EssentialsPluginTemplateCrestronDevice.cs b/src/MakeModelCrestronDevice.cs similarity index 98% rename from src/EssentialsPluginTemplateCrestronDevice.cs rename to src/MakeModelCrestronDevice.cs index 8836cc5..71c91c1 100644 --- a/src/EssentialsPluginTemplateCrestronDevice.cs +++ b/src/MakeModelCrestronDevice.cs @@ -1,13 +1,13 @@ // For Basic SIMPL# Classes -// For Basic SIMPL#Pro classes - -using Crestron.SimplSharpPro.DeviceSupport; -using Crestron.SimplSharpPro; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; - -namespace EssentialsPluginTemplate +// For Basic SIMPL#Pro classes + +using Crestron.SimplSharpPro; +using Crestron.SimplSharpPro.DeviceSupport; +using PepperDash.Core; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; + +namespace PepperDash.Essentials.Plugin { /// <summary> /// Plugin device diff --git a/src/EssentialsPluginTemplateDevice.cs b/src/MakeModelDevice.cs similarity index 96% rename from src/EssentialsPluginTemplateDevice.cs rename to src/MakeModelDevice.cs index b6d2031..da423a2 100644 --- a/src/EssentialsPluginTemplateDevice.cs +++ b/src/MakeModelDevice.cs @@ -1,299 +1,298 @@ -// For Basic SIMPL# Classes -// For Basic SIMPL#Pro classes - -using Crestron.SimplSharpPro.DeviceSupport; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; -using PepperDash.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 - { - /// <summary> - /// It is often desirable to store the config - /// </summary> - 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. - - // TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed - private readonly IBasicCommunication _comms; - private readonly GenericCommunicationMonitor _commsMonitor; - - // _comms gather for ASCII based API's - // TODO [ ] If not using an ASCII based API, delete the properties below - private readonly CommunicationGather _commsGather; - - /// <summary> - /// Set this value to that of the delimiter used by the API (if applicable) - /// </summary> - private const string CommsDelimiter = "\r"; - - // _comms byte buffer for HEX/byte based API's - // TODO [ ] If not using an HEX/byte based API, delete the properties below - private byte[] _commsByteBuffer = { }; - - - - /// <summary> - /// Connects/disconnects the comms of the plugin device - /// </summary> - /// <remarks> - /// triggers the _comms.Connect/Disconnect as well as thee comms monitor start/stop - /// </remarks> - public bool Connect - { - get { return _comms.IsConnected; } - set - { - if (value) - { - _comms.Connect(); - _commsMonitor.Start(); - } - else - { - _comms.Disconnect(); - _commsMonitor.Stop(); - } - } - } - - /// <summary> - /// Reports connect feedback through the bridge - /// </summary> - public BoolFeedback ConnectFeedback { get; private set; } - - /// <summary> - /// Reports online feedback through the bridge - /// </summary> - public BoolFeedback OnlineFeedback { get; private set; } - - /// <summary> - /// Reports socket status feedback through the bridge - /// </summary> - public IntFeedback StatusFeedback { get; private set; } - - /// <summary> - /// Plugin device constructor for devices that need IBasicCommunication - /// </summary> - /// <param name="key"></param> - /// <param name="name"></param> - /// <param name="config"></param> - /// <param name="comms"></param> - public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) - : base(key, name) - { - Debug.Console(0, this, "Constructing new {0} instance", name); - - // TODO [ ] Update the constructor as needed for the plugin device being developed - - _config = config; - - ReceiveQueue = new GenericQueue(key + "-rxqueue"); // If you need to set the thread priority, use one of the available overloaded constructors. - - ConnectFeedback = new BoolFeedback(() => Connect); - OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline); - StatusFeedback = new IntFeedback(() => (int)_commsMonitor.Status); - - _comms = comms; - _commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll); - - var socket = _comms as ISocketStatus; - if (socket != null) - { - // device comms is IP **ELSE** device comms is RS232 - socket.ConnectionChange += socket_ConnectionChange; - Connect = true; - } - - #region Communication data event handlers. Comment out any that don't apply to the API type - - // Only one of the below handlers should be necessary. - - // _comms gather for any API that has a defined delimiter - // TODO [ ] If not using an ASCII based API, remove the line below - _commsGather = new CommunicationGather(_comms, CommsDelimiter); - _commsGather.LineReceived += Handle_LineRecieved; - - // _comms byte buffer for HEX/byte based API's with no delimiter - // TODO [ ] If not using an HEX/byte based API, remove the line below - _comms.BytesReceived += Handle_BytesReceived; - - // _comms byte buffer for HEX/byte based API's with no delimiter - // TODO [ ] If not using an HEX/byte based API, remove the line below - _comms.TextReceived += Handle_TextReceived; - - #endregion - } - - - private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) - { - if (ConnectFeedback != null) - ConnectFeedback.FireUpdate(); - - if (StatusFeedback != null) - StatusFeedback.FireUpdate(); - } - - // TODO [ ] If not using an API with a delimeter, delete the method below - private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args) - { - // TODO [ ] Implement method - - // Enqueues the message to be processed in a dedicated thread, but the specified method - ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage)); - } - - // TODO [ ] If not using an HEX/byte based API with no delimeter, delete the method below - private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args) - { - // TODO [ ] Implement method - throw new System.NotImplementedException(); - } - - // TODO [ ] If not using an ASCII based API with no delimeter, delete the method below - void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e) - { - // TODO [ ] Implement method - throw new System.NotImplementedException(); - } - - /// <summary> - /// This method should perform any necessary parsing of feedback messages from the device - /// </summary> - /// <param name="message"></param> - void ProcessFeedbackMessage(string message) - { - - } - - - // TODO [ ] If not using an ACII based API, delete the properties below - /// <summary> - /// Sends text to the device plugin comms - /// </summary> - /// <remarks> - /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands - /// </remarks> - /// <param name="text">Command to be sent</param> - public void SendText(string text) - { - if (string.IsNullOrEmpty(text)) return; - - _comms.SendText(string.Format("{0}{1}", text, CommsDelimiter)); - } - - // TODO [ ] If not using an HEX/byte based API, delete the properties below - /// <summary> - /// Sends bytes to the device plugin comms - /// </summary> - /// <remarks> - /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands - /// </remarks> - /// <param name="bytes">Bytes to be sent</param> - public void SendBytes(byte[] bytes) - { - if (bytes == null) return; - - _comms.SendBytes(bytes); - } - - /// <summary> - /// Polls the device - /// </summary> - /// <remarks> - /// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed - /// </remarks> - public void Poll() - { - // TODO [ ] Update Poll method as needed for the plugin being developed - // Example: SendText("getstatus"); - throw new System.NotImplementedException(); - } - - #endregion - - - #region Overrides of EssentialsBridgeableDevice - - /// <summary> - /// 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); - - // 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 - - } -} - +// For Basic SIMPL# Classes +// For Basic SIMPL#Pro classes + +using Crestron.SimplSharpPro.DeviceSupport; +using PepperDash.Core; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; +using PepperDash.Essentials.Core.Queues; + +namespace PepperDash.Essentials.Plugin +{ + /// <summary> + /// Plugin device template for third party devices that use IBasicCommunication + /// </summary> + /// <remarks> + /// Rename the class to match the device plugin being developed. + /// </remarks> + /// <example> + /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" + /// </example> + public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice + { + /// <summary> + /// It is often desirable to store the config + /// </summary> + 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. + + // TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed + private readonly IBasicCommunication _comms; + private readonly GenericCommunicationMonitor _commsMonitor; + + // _comms gather for ASCII based API's + // TODO [ ] If not using an ASCII based API, delete the properties below + private readonly CommunicationGather _commsGather; + + /// <summary> + /// Set this value to that of the delimiter used by the API (if applicable) + /// </summary> + private const string CommsDelimiter = "\r"; + + // _comms byte buffer for HEX/byte based API's + // TODO [ ] If not using an HEX/byte based API, delete the properties below + private byte[] _commsByteBuffer = { }; + + + + /// <summary> + /// Connects/disconnects the comms of the plugin device + /// </summary> + /// <remarks> + /// triggers the _comms.Connect/Disconnect as well as thee comms monitor start/stop + /// </remarks> + public bool Connect + { + get { return _comms.IsConnected; } + set + { + if (value) + { + _comms.Connect(); + _commsMonitor.Start(); + } + else + { + _comms.Disconnect(); + _commsMonitor.Stop(); + } + } + } + + /// <summary> + /// Reports connect feedback through the bridge + /// </summary> + public BoolFeedback ConnectFeedback { get; private set; } + + /// <summary> + /// Reports online feedback through the bridge + /// </summary> + public BoolFeedback OnlineFeedback { get; private set; } + + /// <summary> + /// Reports socket status feedback through the bridge + /// </summary> + public IntFeedback StatusFeedback { get; private set; } + + /// <summary> + /// Plugin device constructor for devices that need IBasicCommunication + /// </summary> + /// <param name="key"></param> + /// <param name="name"></param> + /// <param name="config"></param> + /// <param name="comms"></param> + public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) + : base(key, name) + { + Debug.Console(0, this, "Constructing new {0} instance", name); + + // TODO [ ] Update the constructor as needed for the plugin device being developed + + _config = config; + + ReceiveQueue = new GenericQueue(key + "-rxqueue"); // If you need to set the thread priority, use one of the available overloaded constructors. + + ConnectFeedback = new BoolFeedback(() => Connect); + OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline); + StatusFeedback = new IntFeedback(() => (int)_commsMonitor.Status); + + _comms = comms; + _commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll); + + var socket = _comms as ISocketStatus; + if (socket != null) + { + // device comms is IP **ELSE** device comms is RS232 + socket.ConnectionChange += socket_ConnectionChange; + Connect = true; + } + + #region Communication data event handlers. Comment out any that don't apply to the API type + + // Only one of the below handlers should be necessary. + + // _comms gather for any API that has a defined delimiter + // TODO [ ] If not using an ASCII based API, remove the line below + _commsGather = new CommunicationGather(_comms, CommsDelimiter); + _commsGather.LineReceived += Handle_LineRecieved; + + // _comms byte buffer for HEX/byte based API's with no delimiter + // TODO [ ] If not using an HEX/byte based API, remove the line below + _comms.BytesReceived += Handle_BytesReceived; + + // _comms byte buffer for HEX/byte based API's with no delimiter + // TODO [ ] If not using an HEX/byte based API, remove the line below + _comms.TextReceived += Handle_TextReceived; + + #endregion + } + + + private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) + { + if (ConnectFeedback != null) + ConnectFeedback.FireUpdate(); + + if (StatusFeedback != null) + StatusFeedback.FireUpdate(); + } + + // TODO [ ] If not using an API with a delimeter, delete the method below + private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args) + { + // TODO [ ] Implement method + + // Enqueues the message to be processed in a dedicated thread, but the specified method + ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage)); + } + + // TODO [ ] If not using an HEX/byte based API with no delimeter, delete the method below + private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args) + { + // TODO [ ] Implement method + throw new System.NotImplementedException(); + } + + // TODO [ ] If not using an ASCII based API with no delimeter, delete the method below + void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e) + { + // TODO [ ] Implement method + throw new System.NotImplementedException(); + } + + /// <summary> + /// This method should perform any necessary parsing of feedback messages from the device + /// </summary> + /// <param name="message"></param> + void ProcessFeedbackMessage(string message) + { + + } + + + // TODO [ ] If not using an ACII based API, delete the properties below + /// <summary> + /// Sends text to the device plugin comms + /// </summary> + /// <remarks> + /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands + /// </remarks> + /// <param name="text">Command to be sent</param> + public void SendText(string text) + { + if (string.IsNullOrEmpty(text)) return; + + _comms.SendText(string.Format("{0}{1}", text, CommsDelimiter)); + } + + // TODO [ ] If not using an HEX/byte based API, delete the properties below + /// <summary> + /// Sends bytes to the device plugin comms + /// </summary> + /// <remarks> + /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands + /// </remarks> + /// <param name="bytes">Bytes to be sent</param> + public void SendBytes(byte[] bytes) + { + if (bytes == null) return; + + _comms.SendBytes(bytes); + } + + /// <summary> + /// Polls the device + /// </summary> + /// <remarks> + /// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed + /// </remarks> + public void Poll() + { + // TODO [ ] Update Poll method as needed for the plugin being developed + // Example: SendText("getstatus"); + throw new System.NotImplementedException(); + } + + #endregion + + + #region Overrides of EssentialsBridgeableDevice + + /// <summary> + /// 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); + + // 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 + + } +} + diff --git a/src/EssentialsPluginTemplateFactory.cs b/src/MakeModelFactory.cs similarity index 99% rename from src/EssentialsPluginTemplateFactory.cs rename to src/MakeModelFactory.cs index 0b58f52..e94994a 100644 --- a/src/EssentialsPluginTemplateFactory.cs +++ b/src/MakeModelFactory.cs @@ -1,9 +1,9 @@ -using System.Collections.Generic; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using Crestron.SimplSharpPro.UI; - -namespace EssentialsPluginTemplate +using System.Collections.Generic; +using Crestron.SimplSharpPro.UI; +using PepperDash.Core; +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin { /// <summary> /// Plugin device factory for devices that use IBasicCommunication diff --git a/src/EssentialsPluginTemplateLogicDevice.cs b/src/MakeModelLogicDevice.cs similarity index 98% rename from src/EssentialsPluginTemplateLogicDevice.cs rename to src/MakeModelLogicDevice.cs index 0685a43..44aeeec 100644 --- a/src/EssentialsPluginTemplateLogicDevice.cs +++ b/src/MakeModelLogicDevice.cs @@ -1,9 +1,9 @@ -using Crestron.SimplSharpPro.DeviceSupport; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; - -namespace EssentialsPluginTemplate +using Crestron.SimplSharpPro.DeviceSupport; +using PepperDash.Core; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; + +namespace PepperDash.Essentials.Plugin { /// <summary> /// Plugin device template for logic devices that don't communicate outside the program diff --git a/src/PDT.EssentialsPluginTemplate.nuspec b/src/PDT.EssentialsPluginTemplate.nuspec deleted file mode 100644 index e72f807..0000000 --- a/src/PDT.EssentialsPluginTemplate.nuspec +++ /dev/null @@ -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 - PepperDash Technologies - pepperdash - false - MIT - https://github.com/PepperDash/EssentialsPluginTemplate - Copyright 2022 - This software iserves as a template for generating new Essentials-Compliant plugins - crestron 3series 4series essentials pepperdash pepperdashessentials epi essentials plugin - - - - - - - - \ No newline at end of file diff --git a/src/PDT.EssentialsPluginTemplate.EPI.csproj b/src/epi-make-model.3Series.csproj similarity index 82% rename from src/PDT.EssentialsPluginTemplate.EPI.csproj rename to src/epi-make-model.3Series.csproj index edda00c..03aa3ce 100644 --- a/src/PDT.EssentialsPluginTemplate.EPI.csproj +++ b/src/epi-make-model.3Series.csproj @@ -1,115 +1,115 @@ - - - Release - AnyCPU - 9.0.30729 - 2.0 - {9D249E47-8F95-4437-A6BB-563510287AD1} - Library - Properties - PDT.EssentialsPluginTemplate.EPI - PDT.EssentialsPluginTemplate.EPI - {0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} - WindowsCE - E2BECB1F-8C8C-41ba-B736-9BE7D946A398 - 5.0 - SmartDeviceProject1 - v3.5 - Windows CE - - - - - .allowedReferenceRelatedFileExtensions - true - full - false - bin\Debug\ - DEBUG;TRACE; - prompt - 4 - 512 - true - true - off - - - .allowedReferenceRelatedFileExtensions - none - true - bin\Release\ - prompt - 4 - 512 - true - true - off - - - - False - ..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll - - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll - - - - - - - - - - - - - - - - - - rem S# Pro preparation will execute after these operations - + + + Release + AnyCPU + 9.0.30729 + 2.0 + {9D249E47-8F95-4437-A6BB-563510287AD1} + Library + Properties + PepperDash.Essentials.Plugin + MakeModelPlugin + {0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} + WindowsCE + E2BECB1F-8C8C-41ba-B736-9BE7D946A398 + 5.0 + SmartDeviceProject1 + v3.5 + Windows CE + + + + + .allowedReferenceRelatedFileExtensions + true + full + false + bin\Debug\ + DEBUG;TRACE; + prompt + 4 + 512 + true + true + off + + + .allowedReferenceRelatedFileExtensions + none + true + bin\Release\ + prompt + 4 + 512 + true + true + off + + + + False + C:\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll + + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll + + + False + C:\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll + False + + + False + C:\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll + False + + + False + C:\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll + + + False + C:\ProgramData\Crestron\SDK\SimplSharpPro.exe + False + + + False + C:\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll + + + + + + + + + + + + + + + + + + rem S# Pro preparation will execute after these operations + \ No newline at end of file diff --git a/src/epi-make-model.4Series.csproj b/src/epi-make-model.4Series.csproj new file mode 100644 index 0000000..7ac4bfa --- /dev/null +++ b/src/epi-make-model.4Series.csproj @@ -0,0 +1,50 @@ + + + ProgramLibrary + + + net472 + PepperDash.Essentials.Plugin + false + PepperDash.Essentials.Plugin.Make.Model + PepperDash Technology + This software is a template for a PepperDash Essentials Plugin. + Copyright 2025 + 1.0.0-local + true + $(Version) + bin\$(Configuration)\ + PepperDash Technology + Pepperdash.Essentials.Plugins.Template + https://github.com/PepperDash/EssentialsPluginTemplate.git + crestron 4series essentials plugin template + + + + $(DefineConstants);SERIES4 + + + + + + + + + + + + + + + runtime + + + + + + + + + + +