diff --git a/.github/ISSUE_TEMPLATE/essentials-plugin-request.md b/.github/ISSUE_TEMPLATE/essentials-plugin-request.md deleted file mode 100644 index 0bee158..0000000 --- a/.github/ISSUE_TEMPLATE/essentials-plugin-request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Essentials Plugin Request -about: Request an Essentials Plugin -title: "[REQUEST] - " -labels: plugin request -assignees: '' - ---- - -** Describe the Plugin ** -What do you want the plugin to do? Is it for a specific device? If it's for a specific device, include the manufacturer and model, along with links to API documentation if available. - -** Does it need to be available in SIMPL Windows? ** -If it does, describe the functionality that should be exposed to SIMPL Windows via EISC. This may include an example join map, or other way of documenting the layout of the EISC. - -** Additional Features or functionality ** -Describe additional features or functionality that this plugin should have. diff --git a/.github/scripts/GenerateVersionNumber.ps1 b/.github/scripts/GenerateVersionNumber.ps1 index 5d5a3ec..052d48a 100644 --- a/.github/scripts/GenerateVersionNumber.ps1 +++ b/.github/scripts/GenerateVersionNumber.ps1 @@ -7,8 +7,7 @@ Foreach ($version in $latestVersions) { $latestVersion = $version Write-Host "Setting latest version to: $latestVersion" } - } - catch { + } catch { Write-Host "Unable to convert $($version). Skipping" continue; } @@ -19,27 +18,21 @@ $phase = "" $newVersionString = "" switch -regex ($Env:GITHUB_REF) { '^refs\/heads\/main*.' { - $newVersionString = "{0}.{1}.{2}" -f $newVersion.Major, $newVersion.Minor, $newVersion.Build + $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\/*.' { - $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*.' { + '^refs\/heads\/development*.' { $phase = 'beta' - $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER } '^refs\/heads\/hotfix\/*.' { $phase = 'hotfix' - $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER } } - +$newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER Write-Output $newVersionString diff --git a/.github/scripts/ZipBuildOutput.ps1 b/.github/scripts/ZipBuildOutput.ps1 index ca4a9a7..3f1998b 100644 --- a/.github/scripts/ZipBuildOutput.ps1 +++ b/.github/scripts/ZipBuildOutput.ps1 @@ -10,7 +10,7 @@ Get-ChildItem ($destination) $exclusions = @(git submodule foreach --quiet 'echo $name') # Trying to get any .json schema files (not currently working) # Gets any files with the listed extensions. -Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.cplz" | ForEach-Object { +Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz" | ForEach-Object { $allowed = $true; # Exclude any files in submodules foreach ($exclude in $exclusions) { @@ -36,7 +36,6 @@ Get-ChildItem -Path $destination | Where-Object {($_.Extension -eq ".clz") -or ( Get-ChildItem -Recurse -Path "$($Env:GITHUB_WORKSPACE)" -include $filenames | Copy-Item -Destination ($destination) -Force } } -Get-ChildItem -Path $destination\*.cplz | Rename-Item -NewName { "$($_.BaseName)-$($Env:VERSION)$($_.Extension)" } Compress-Archive -Path $destination -DestinationPath "$($Env:GITHUB_WORKSPACE)\$($Env:SOLUTION_FILE)-$($Env:VERSION).zip" -Force Write-Host "Output Contents post Zip" Get-ChildItem -Path $destination \ 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/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml deleted file mode 100644 index 4dcf064..0000000 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ /dev/null @@ -1,286 +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 = Get-ChildItem *.nuspec -recurse - $NUSPECNAME = nuspec.BaseName - echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - - name: Download Build Version Info - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - uses: actions/download-artifact@v1 - with: - name: Version - - name: Set Version Number - if: ${{env.NUSPECNAME != 'PDT.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: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - uses: actions/download-artifact@v1 - with: - name: Build - path: ./ - - name: Unzip Build file - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - run: | - Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ - Remove-Item -Path .\*.zip - - name: Copy Files to root & delete output directory - if: ${{env.NUSPECNAME != 'PDT.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: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - uses: nuget/setup-nuget@v1 - - name: Add Github Packages source - if: ${{env.NUSPECNAME != 'PDT.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' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.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' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - run: nuget push **/*.nupkg -source github - - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.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 c5bd360..0000000 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ /dev/null @@ -1,234 +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 = Get-ChildItem *.nuspec -recurse - $NUSPECNAME = nuspec.BaseName - echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - - name: Download Build Version Info - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - uses: actions/download-artifact@v1 - with: - name: Version - - name: Set Version Number - if: ${{env.NUSPECNAME != 'PDT.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: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - uses: actions/download-artifact@v1 - with: - name: Build - path: ./ - - name: Unzip Build file - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - run: | - Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ - Remove-Item -Path .\*.zip - - name: Copy Files to root & delete output directory - if: ${{env.NUSPECNAME != 'PDT.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: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - uses: nuget/setup-nuget@v1 - - name: Add Github Packages source - if: ${{env.NUSPECNAME != 'PDT.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' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.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' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - run: nuget push **/*.nupkg -source github - - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} - run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/GetPackages.BAT b/GetPackages.BAT deleted file mode 100644 index 9b6def3..0000000 --- a/GetPackages.BAT +++ /dev/null @@ -1,2 +0,0 @@ -@Echo ON -nuget install .\packages.config -OutputDirectory .\packages -excludeVersion diff --git a/src/EssentialsPluginTemplateBridgeJoinMap.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs similarity index 91% rename from src/EssentialsPluginTemplateBridgeJoinMap.cs rename to PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs index 140d021..1f1f9d0 100644 --- a/src/EssentialsPluginTemplateBridgeJoinMap.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs @@ -12,7 +12,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap" /// - public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced + public class EssentialsPluginBridgeJoinMapTemplate : JoinMapBaseAdvanced { #region Digital @@ -93,8 +93,8 @@ namespace EssentialsPluginTemplate /// Plugin device BridgeJoinMap constructor /// /// This will be the join it starts on the EISC bridge - public EssentialsPluginTemplateBridgeJoinMap(uint joinStart) - : base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap)) + public EssentialsPluginBridgeJoinMapTemplate(uint joinStart) + : base(joinStart, typeof(EssentialsPluginBridgeJoinMapTemplate)) { } } diff --git a/src/EssentialsPluginTemplateConfigObject.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs similarity index 90% rename from src/EssentialsPluginTemplateConfigObject.cs rename to PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs index e216796..027cefe 100644 --- a/src/EssentialsPluginTemplateConfigObject.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs @@ -1,195 +1,195 @@ -using System.Collections.Generic; -using Newtonsoft.Json; -using PepperDash.Essentials.Core; - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device configuration object - /// - /// - /// Rename the class to match the device plugin being created - /// - /// - /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" - /// - [ConfigSnippet("\"properties\":{\"control\":{}")] - public class EssentialsPluginTemplateConfigObject - { - /// - /// 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; } - - /// - /// 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; } - - /// - /// 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 EssentialsPluginTemplateConfigObject() - { - 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 EssentialsPluginTemplateConfigObjectDictionary - { - /// - /// 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; } - } +using System.Collections.Generic; +using Newtonsoft.Json; +using PepperDash.Essentials.Core; + +namespace EssentialsPluginTemplate +{ + /// + /// Plugin device configuration object + /// + /// + /// Rename the class to match the device plugin being created + /// + /// + /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" + /// + [ConfigSnippet("\"properties\":{\"control\":{}")] + public class EssentialsPluginConfigObjectTemplate + { + /// + /// 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; } + + /// + /// 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; } + + /// + /// 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 new file mode 100644 index 0000000..649c7e6 --- /dev/null +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs @@ -0,0 +1,246 @@ +// 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; + +namespace EssentialsPluginTemplate +{ + /// + /// 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"; + + // _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 = { }; + + + 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/NvxUrlRoutingClientEpi.projectinfo b/PDT.EssentialsPluginTemplate.EPI/NvxUrlRoutingClientEpi.projectinfo new file mode 100644 index 0000000..96ee187 Binary files /dev/null and b/PDT.EssentialsPluginTemplate.EPI/NvxUrlRoutingClientEpi.projectinfo differ diff --git a/src/PDT.EssentialsPluginTemplate.EPI.csproj b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj similarity index 93% rename from src/PDT.EssentialsPluginTemplate.EPI.csproj rename to PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj index edda00c..6517361 100644 --- a/src/PDT.EssentialsPluginTemplate.EPI.csproj +++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj @@ -1,115 +1,109 @@ - - - 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 + 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 + ..\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 + \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user new file mode 100644 index 0000000..9c6c209 --- /dev/null +++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user @@ -0,0 +1,5 @@ + + + E282E6BE-C7C3-4ece-916A-88FB1CF8AF3C + + \ No newline at end of file diff --git a/src/PDT.EssentialsPluginTemplate.EPI.sln b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln similarity index 97% rename from src/PDT.EssentialsPluginTemplate.EPI.sln rename to PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln index f453fd6..08ca093 100644 --- a/src/PDT.EssentialsPluginTemplate.EPI.sln +++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.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}") = "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 diff --git a/src/Properties/AssemblyInfo.cs b/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs similarity index 78% rename from src/Properties/AssemblyInfo.cs rename to PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs index 275e917..b31431b 100644 --- a/src/Properties/AssemblyInfo.cs +++ b/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs @@ -1,8 +1,8 @@ -using System.Reflection; - -[assembly: AssemblyTitle("EssentialsPluginTemplateEpi")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("EssentialsPluginTemplateEpi")] -[assembly: AssemblyCopyright("Copyright © 2022")] -[assembly: AssemblyVersion("1.0.0.*")] - +using System.Reflection; + +[assembly: AssemblyTitle("EssentialsPluginTemplateEpi")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("EssentialsPluginTemplateEpi")] +[assembly: AssemblyCopyright("Copyright © 2019")] +[assembly: AssemblyVersion("1.0.0.*")] + diff --git a/src/Properties/ControlSystem.cfg b/PDT.EssentialsPluginTemplate.EPI/Properties/ControlSystem.cfg similarity index 100% rename from src/Properties/ControlSystem.cfg rename to PDT.EssentialsPluginTemplate.EPI/Properties/ControlSystem.cfg diff --git a/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log b/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log new file mode 100644 index 0000000..b86200d --- /dev/null +++ b/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log @@ -0,0 +1,63 @@ +8/30/2019 3:01:01 PM, Info: Initializing SIMPLSharp Services... +8/30/2019 3:01:01 PM, Info: ProjectInfo successfully initialized. +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:04:48 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDashEssentials.dll... +8/30/2019 3:05:10 PM, Info: Saving project information... +8/30/2019 3:05:10 PM, Info: Saving project information... +8/30/2019 3:05:10 PM, Info: Saving project information... +8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Core.dll... +8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll... +8/30/2019 3:05:40 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_DM.dll... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:09:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll... +8/30/2019 3:10:10 PM, Info: Saving project information... +8/30/2019 3:10:10 PM, Info: Saving project information... +8/30/2019 3:10:10 PM, Info: Saving project information... +8/30/2019 3:15:10 PM, Info: Saving project information... +8/30/2019 3:15:10 PM, Info: Saving project information... +8/30/2019 3:15:10 PM, Info: Saving project information... +8/30/2019 3:20:10 PM, Info: Saving project information... +8/30/2019 3:20:10 PM, Info: Saving project information... +8/30/2019 3:20:10 PM, Info: Saving project information... +8/30/2019 3:25:10 PM, Info: Saving project information... +8/30/2019 3:25:10 PM, Info: Saving project information... +8/30/2019 3:25:10 PM, Info: Saving project information... +8/30/2019 3:30:10 PM, Info: Saving project information... +8/30/2019 3:30:10 PM, Info: Saving project information... +8/30/2019 3:30:10 PM, Info: Saving project information... +8/30/2019 3:35:10 PM, Info: Saving project information... +8/30/2019 3:35:10 PM, Info: Saving project information... +8/30/2019 3:35:10 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:36:52 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll... +8/30/2019 3:36:52 PM, Info: Verifying assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll +8/30/2019 3:36:52 PM, Info: Creating Archive C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.cplz... +8/30/2019 3:36:53 PM, Info: Saving project information... +9/2/2019 8:34:46 AM, Info: Terminating SIMPLSharp Services diff --git a/README.md b/README.md index 8dfb905..9447de4 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,6 @@ Provided under MIT license Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://github.com/PepperDash/Essentials/wiki/Plugins) article. -This repo contains example classes for the three main categories of devices: -* `EssentialsPluginTemplateDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc -* `EssentialsPluginTemplateLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program -* `EssentialsPluginTemplateCrestronDevice`: Used for devices that represent a piece of Crestron hardware - -There are matching factory classes for each of the three categories of devices. The `EssentialsPluginTemplateConfigObject` should be used as a template and modified for any of the categories of device. Same goes for the `EssentialsPluginTemplateBridgeJoinMap`. - -This also illustrates how a plugin can contain multiple devices. - ## Cloning Instructions After forking this repository into your own GitHub space, you can create a new repository using this one as the template. Then you must install the necessary dependencies as indicated below. @@ -40,15 +31,3 @@ If you need a different version of PepperDash Core, use the command `nuget insta 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 - -## Build Instructions (PepperDash Internal) - -## Generating Nuget Package - -In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec-TEMPLATE" - -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. 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 diff --git a/packages.config b/packages.config index 2a12f4c..fa05b32 100644 --- a/packages.config +++ b/packages.config @@ -1,3 +1,3 @@ - + \ No newline at end of file diff --git a/src/EssentialsPluginTemplateCrestronDevice.cs b/src/EssentialsPluginTemplateCrestronDevice.cs deleted file mode 100644 index 8836cc5..0000000 --- a/src/EssentialsPluginTemplateCrestronDevice.cs +++ /dev/null @@ -1,99 +0,0 @@ -// 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 -{ - /// - /// Plugin device - /// - /// - /// Rename the class to match the device plugin being developed. - /// - /// - /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" - /// - public class EssentialsPluginTemplateCrestronDevice : CrestronGenericBridgeableBaseDevice - { - /// - /// It is often desirable to store the config - /// - private EssentialsPluginTemplateConfigObject _config; - - - #region Constructor for Devices without IBasicCommunication. Remove if not needed - /// - /// Plugin device constructor for Crestron devices - /// - /// - /// - /// - /// - public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginTemplateConfigObject config, GenericBase hardware) - : base(key, name, hardware) - { - Debug.Console(0, this, "Constructing new {0} instance", name); - - // The base class takes care of registering the hardware device for you - - // TODO [ ] Update the constructor as needed for the plugin device being developed - - _config = config; - } - - #endregion - - - #region Overrides of EssentialsBridgeableDevice - - /// - /// Links the plugin device to the EISC bridge - /// - /// - /// - /// - /// - 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.OnlineStatusChange += (o, a) => - { - if (!a.DeviceOnLine) return; - - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - }; - } - - - #endregion - - } -} - diff --git a/src/EssentialsPluginTemplateDevice.cs b/src/EssentialsPluginTemplateDevice.cs deleted file mode 100644 index b6d2031..0000000 --- a/src/EssentialsPluginTemplateDevice.cs +++ /dev/null @@ -1,299 +0,0 @@ -// 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 -{ - /// - /// Plugin device template for third party devices that use IBasicCommunication - /// - /// - /// Rename the class to match the device plugin being developed. - /// - /// - /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" - /// - public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice - { - /// - /// It is often desirable to store the config - /// - private EssentialsPluginTemplateConfigObject _config; - - /// - /// Provides a queue and dedicated worker thread for processing feedback messages from a device. - /// - 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; - - /// - /// Set this value to that of the delimiter used by the API (if applicable) - /// - 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 = { }; - - - - /// - /// 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 for devices that need IBasicCommunication - /// - /// - /// - /// - /// - 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(); - } - - /// - /// This method should perform any necessary parsing of feedback messages from the device - /// - /// - void ProcessFeedbackMessage(string message) - { - - } - - - // 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 - // Example: SendText("getstatus"); - throw new System.NotImplementedException(); - } - - #endregion - - - #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 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/EssentialsPluginTemplateFactory.cs deleted file mode 100644 index 0b58f52..0000000 --- a/src/EssentialsPluginTemplateFactory.cs +++ /dev/null @@ -1,239 +0,0 @@ -using System.Collections.Generic; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using Crestron.SimplSharpPro.UI; - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device factory for devices that use IBasicCommunication - /// - /// - /// Rename the class to match the device plugin being developed - /// - /// - /// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory" - /// - public class EssentialsPluginTemplateFactory : EssentialsPluginDeviceFactory - { - /// - /// Plugin device factory constructor - /// - /// - /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin - /// - /// - /// Set the minimum Essentials Framework Version - /// - /// MinimumEssentialsFrameworkVersion = "1.6.4; - /// - /// In the constructor we initialize the list with the typenames that will build an instance of this device - /// - /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; - /// - /// - public EssentialsPluginTemplateFactory() - { - // Set the minimum Essentials Framework Version - // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against - MinimumEssentialsFrameworkVersion = "1.6.4"; - - // In the constructor we initialize the list with the typenames that will build an instance of this device - // TODO [ ] Update the TypeNames for the plugin being developed - TypeNames = new List() { "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; - } - - // attempt build the plugin device comms device & check for null - // TODO { ] As of PepperDash Core 1.0.41, HTTP and HTTPS are not valid eControlMethods and will throw an exception. - var comms = CommFactory.CreateCommForDevice(dc); - if (comms == null) - { - Debug.Console(1, "[{0}] Factory Notice: No control object present for device {1}", dc.Key, dc.Name); - return null; - } - else - { - return new EssentialsPluginTemplateDevice(dc.Key, dc.Name, propertiesConfig, comms); - } - - } - - } - - /// - /// Plugin device factory for logic devices that don't communicate - /// - /// - /// Rename the class to match the device plugin being developed - /// - /// - /// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory" - /// - public class EssentialsPluginTemplateFactoryLogicDevice : EssentialsPluginDeviceFactory - { - /// - /// Plugin device factory constructor - /// - /// - /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin - /// - /// - /// Set the minimum Essentials Framework Version - /// - /// MinimumEssentialsFrameworkVersion = "1.6.4; - /// - /// In the constructor we initialize the list with the typenames that will build an instance of this device - /// - /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; - /// - /// - public EssentialsPluginTemplateFactoryLogicDevice() - { - // Set the minimum Essentials Framework Version - // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against - MinimumEssentialsFrameworkVersion = "1.6.4"; - - // In the constructor we initialize the list with the typenames that will build an instance of this device - // TODO [ ] Update the TypeNames for the plugin being developed - TypeNames = new List() { "examplePluginLogicDevice" }; - } - - /// - /// Builds and returns an instance of EssentialsPluginTemplateLogicDevice - /// - /// 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; - } - - var controlConfig = CommFactory.GetControlPropertiesConfig(dc); - - if (controlConfig == null) - { - return new EssentialsPluginTemplateLogicDevice(dc.Key, dc.Name, propertiesConfig); - } - else - { - Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name); - return null; - } - } - } - - /// - /// Plugin device factory for Crestron wrapper devices - /// - /// - /// Rename the class to match the device plugin being developed - /// - /// - /// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory" - /// - public class EssentialsPluginTemplateFactoryCrestronDevice : EssentialsPluginDeviceFactory - { - /// - /// Plugin device factory constructor - /// - /// - /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin - /// - /// - /// Set the minimum Essentials Framework Version - /// - /// MinimumEssentialsFrameworkVersion = "1.6.4; - /// - /// In the constructor we initialize the list with the typenames that will build an instance of this device - /// - /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; - /// - /// - public EssentialsPluginTemplateFactoryCrestronDevice() - { - // Set the minimum Essentials Framework Version - // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against - MinimumEssentialsFrameworkVersion = "1.7.5"; - - // In the constructor we initialize the list with the typenames that will build an instance of this device - // TODO [ ] Update the TypeNames for the plugin being developed - TypeNames = new List() { "examplePluginCrestronDevice" }; - } - - /// - /// Builds and returns an instance of EssentialsPluginTemplateCrestronDevice - /// - /// 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; - } - - var controlConfig = CommFactory.GetControlPropertiesConfig(dc); - - if (controlConfig == null) - { - var myTouchpanel = new Tsw760(controlConfig.IpIdInt, Global.ControlSystem); - - return new EssentialsPluginTemplateCrestronDevice(dc.Key, dc.Name, propertiesConfig, myTouchpanel); - } - else - { - Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name); - return null; - } - } - } - -} - - \ No newline at end of file diff --git a/src/EssentialsPluginTemplateLogicDevice.cs b/src/EssentialsPluginTemplateLogicDevice.cs deleted file mode 100644 index 0685a43..0000000 --- a/src/EssentialsPluginTemplateLogicDevice.cs +++ /dev/null @@ -1,86 +0,0 @@ -using Crestron.SimplSharpPro.DeviceSupport; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device template for logic devices that don't communicate outside the program - /// - /// - /// Rename the class to match the device plugin being developed. - /// - /// - /// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice" - /// - public class EssentialsPluginTemplateLogicDevice : EssentialsBridgeableDevice - { - /// - /// It is often desirable to store the config - /// - private EssentialsPluginTemplateConfigObject _config; - - /// - /// Plugin device constructor - /// - /// - /// - /// - public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginTemplateConfigObject config) - : base(key, name) - { - Debug.Console(0, this, "Constructing new {0} instance", name); - - // TODO [ ] Update the constructor as needed for the plugin device being developed - - _config = config; - } - - #region Overrides of EssentialsBridgeableDevice - - /// - /// Links the plugin device to the EISC bridge - /// - /// - /// - /// - /// - 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.OnlineStatusChange += (o, a) => - { - if (!a.DeviceOnLine) return; - - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - }; - } - - #endregion - - } -} - 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 @@ - - - - PDT.EssentialsPluginTemplate - docs\README.md - 2.0.2 - 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