diff --git a/.github/ISSUE_TEMPLATE/essentials-plugin-request.md b/.github/ISSUE_TEMPLATE/essentials-plugin-request.md new file mode 100644 index 0000000..0bee158 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/essentials-plugin-request.md @@ -0,0 +1,17 @@ +--- +name: Essentials Plugin Request +about: Request an Essentials Plugin +title: "[REQUEST] - " +labels: plugin request +assignees: '' + +--- + +** Describe the Plugin ** +What do you want the plugin to do? Is it for a specific device? If it's for a specific device, include the manufacturer and model, along with links to API documentation if available. + +** Does it need to be available in SIMPL Windows? ** +If it does, describe the functionality that should be exposed to SIMPL Windows via EISC. This may include an example join map, or other way of documenting the layout of the EISC. + +** Additional Features or functionality ** +Describe additional features or functionality that this plugin should have. diff --git a/.github/scripts/GenerateVersionNumber.ps1 b/.github/scripts/GenerateVersionNumber.ps1 index 052d48a..5d5a3ec 100644 --- a/.github/scripts/GenerateVersionNumber.ps1 +++ b/.github/scripts/GenerateVersionNumber.ps1 @@ -7,7 +7,8 @@ Foreach ($version in $latestVersions) { $latestVersion = $version Write-Host "Setting latest version to: $latestVersion" } - } catch { + } + catch { Write-Host "Unable to convert $($version). Skipping" continue; } @@ -18,21 +19,27 @@ $phase = "" $newVersionString = "" switch -regex ($Env:GITHUB_REF) { '^refs\/heads\/main*.' { - $newVersionString = "{0}.{1}.{2}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1) + $newVersionString = "{0}.{1}.{2}" -f $newVersion.Major, $newVersion.Minor, $newVersion.Build } '^refs\/heads\/feature\/*.' { $phase = 'alpha' + $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER } '^refs\/heads\/release\/*.' { + $splitRef = $Env:GITHUB_REF -split "/" + $version = [version]($splitRef[-1] -replace "v", "") $phase = 'rc' + $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $version.Major, $version.Minor, $version.Build, $phase, $Env:GITHUB_RUN_NUMBER } - '^refs\/heads\/development*.' { + '^refs\/heads\/dev*.' { $phase = 'beta' + $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER } '^refs\/heads\/hotfix\/*.' { $phase = 'hotfix' + $newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER } } -$newVersionString = "{0}.{1}.{2}-{3}-{4}" -f $newVersion.Major, $newVersion.Minor, ($newVersion.Build + 1), $phase, $Env:GITHUB_RUN_NUMBER + Write-Output $newVersionString diff --git a/.github/scripts/ZipBuildOutput.ps1 b/.github/scripts/ZipBuildOutput.ps1 index 3f1998b..ca4a9a7 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 "*.clz", "*.cpz", "*.cplz" | ForEach-Object { +Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.cplz" | ForEach-Object { $allowed = $true; # Exclude any files in submodules foreach ($exclude in $exclusions) { @@ -36,6 +36,7 @@ Get-ChildItem -Path $destination | Where-Object {($_.Extension -eq ".clz") -or ( Get-ChildItem -Recurse -Path "$($Env:GITHUB_WORKSPACE)" -include $filenames | Copy-Item -Destination ($destination) -Force } } +Get-ChildItem -Path $destination\*.cplz | Rename-Item -NewName { "$($_.BaseName)-$($Env:VERSION)$($_.Extension)" } Compress-Archive -Path $destination -DestinationPath "$($Env:GITHUB_WORKSPACE)\$($Env:SOLUTION_FILE)-$($Env:VERSION).zip" -Force Write-Host "Output Contents post Zip" Get-ChildItem -Path $destination \ No newline at end of file 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/docker.yml b/.github/workflows/docker.yml deleted file mode 100644 index 0ccab74..0000000 --- a/.github/workflows/docker.yml +++ /dev/null @@ -1,103 +0,0 @@ -name: Branch Build Using Docker - -on: - push: - branches: - - feature/* - - hotfix/* - - release/* - - main - - development - -env: - # solution path doesn't need slashes unless there it is multiple folders deep - # solution name does not include extension. .sln is assumed - SOLUTION_PATH: PDT.EssentialsPluginTemplate.EPI - SOLUTION_FILE: PDT.EssentialsPluginTemplate.EPI - # Do not edit this, we're just creating it here - VERSION: 0.0.0-buildtype-buildnumber - # Defaults to debug for build type - BUILD_TYPE: Debug - # Defaults to main as the release branch. Change as necessary - RELEASE_BRANCH: main -jobs: - Build_Project: - runs-on: windows-latest - steps: - # First we checkout the source repo - - name: Checkout repo - uses: actions/checkout@v2 - with: - fetch-depth: 0 - # And any submodules - - name: Checkout submodules - shell: bash - run: | - git config --global url."https://github.com/".insteadOf "git@github.com:" - auth_header="$(git config --local --get http.https://github.com/.extraheader)" - git submodule sync --recursive - git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1 - # Set the BUILD_TYPE environment variable - - name: Set Build to Release if triggered from main - run: | - if("$($Env:GITHUB_REF)".contains("$($Env:RELEASE_BRANCH)")) { - Write-Host "Setting build type to Release" - Write-Output "::set-env name=BUILD_TYPE::Release" - } - # Fetch all tags - - name: Fetch tags - run: git fetch --tags - # Generate the appropriate version number - - name: Set Version Number - shell: powershell - run: | - $version = ./.github/scripts/GenerateVersionNumber.ps1 - Write-Output "::set-env name=VERSION::$version" - # Use the version number to set the version of the assemblies - - name: Update AssemblyInfo.cs - shell: powershell - run: | - Write-Output ${{ env.VERSION }} - ./.github/scripts/UpdateAssemblyVersion.ps1 ${{ env.VERSION }} - - name: restore Nuget Packages - run: nuget install .\packages.config -OutputDirectory .\packages -ExcludeVersion - - name: Login to Docker - uses: azure/docker-login@v1 - with: - username: ${{ secrets.DOCKERHUB_USER }} - password: ${{ secrets.DOCKERHUB_PASSWORD }} - # Build the solutions in the docker image - - name: Build Solution - shell: powershell - run: | - Invoke-Expression "docker run --rm --mount type=bind,source=""$($Env:GITHUB_WORKSPACE)"",target=""c:/project"" pepperdash/sspbuilder c:\cihelpers\vsidebuild.exe -Solution ""c:\project\$($Env:SOLUTION_PATH)\$($Env:SOLUTION_FILE).sln"" -BuildSolutionConfiguration $($ENV:BUILD_TYPE)" - # Zip up the output files as needed - - name: Zip Build Output - shell: powershell - run: ./.github/scripts/ZipBuildOutput.ps1 - - name: Upload Build Output - uses: actions/upload-artifact@v1 - with: - name: Build - path: ./${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip - # Create the release on the source repo - - name: Create Release - id: create_release - uses: actions/create-release@v1 - with: - tag_name: ${{ env.VERSION }} - release_name: ${{ env.VERSION }} - prerelease: ${{contains('debug', env.BUILD_TYPE)}} - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - # Upload the build package to the release - - name: Upload Release Package - id: upload_release - uses: actions/upload-release-asset@v1 - with: - upload_url: ${{ steps.create_release.outputs.upload_url }} - asset_path: ./${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip - asset_name: ${{ env.SOLUTION_FILE}}-${{ env.VERSION}}.zip - asset_content_type: application/zip - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 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/GetPackages.BAT b/GetPackages.BAT new file mode 100644 index 0000000..9b6def3 --- /dev/null +++ b/GetPackages.BAT @@ -0,0 +1,2 @@ +@Echo ON +nuget install .\packages.config -OutputDirectory .\packages -excludeVersion diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs deleted file mode 100644 index 5a76b22..0000000 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs +++ /dev/null @@ -1,37 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using Crestron.SimplSharp; - -using PepperDash.Core; - -using Newtonsoft.Json; - -namespace EssentialsPluginTemplateEPI -{ - /// - /// Example of a config class that represents the structure of the Properties object of a DeviceConfig. - /// The BuildDevice method will attempt to deserialize the Properties object into this class. - /// Populate with any necssary properties for your device - /// - public class EssentialsPluginTemplatePropertiesConfig - { - // Below are some example properties - - - /// - /// Control properties if needed to communicate with device. - /// The JsonProperty attribute has been added to specify the name - /// of the object and that it is required - /// - [JsonProperty("control", Required = Required.Always)] - ControlPropertiesConfig Control { get; set; } - - /// - /// Add custom properties here - /// - [JsonProperty("myDeviceProperty")] - string MyDeviceProperty { get; set; } - } -} \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs deleted file mode 100644 index dda96b2..0000000 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs +++ /dev/null @@ -1,67 +0,0 @@ -using Crestron.SimplSharpPro.DeviceSupport; -using Newtonsoft.Json; -using PDT.EssentialsPluginTemplate.EPI; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; -using PepperDash.Core; - -namespace EssentialsPluginTemplateEPI -{ - /// - /// Example of a plugin device - /// - public class EssentialsPluginTemplateDevice : EssentialsDevice, IBridgeAdvanced - { - /// - /// Device Constructor. Called by BuildDevice - /// - /// - /// - /// - public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplatePropertiesConfig config) - : base(key, name) - { - - } - - /// - /// Add items to be executed during the Activaction phase - /// - /// - public override bool CustomActivate() - { - - return base.CustomActivate(); - } - - /// - /// This method gets called by the EiscApi bridge and calls your bridge extension method - /// - /// - /// - /// - public void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) - { - // Construct the default join map - var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); - - // Attempt to get a custom join map if specified in config - var joinMapSerialized = JoinMapHelper.GetJoinMapForDevice(joinMapKey); - - // If we find a custom join map, deserialize it - if (!string.IsNullOrEmpty(joinMapSerialized)) - joinMap = JsonConvert.DeserializeObject(joinMapSerialized); - - //Checking if the bridge is null allows for backwards compatability with configurations that use EiscApi instead of EiscApiAdvanced - if (bridge != null) - { - bridge.AddJoinMap(Key, joinMap); - } - - // Set all your join actions here - - - // Link all your feedbacks to joins here - } - } -} \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs deleted file mode 100644 index 79cfcf9..0000000 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs +++ /dev/null @@ -1,43 +0,0 @@ -using System; -using System.Collections.Generic; -using Crestron.SimplSharp; // For Basic SIMPL# Classes -using Crestron.SimplSharpPro; // For Basic SIMPL#Pro classes - -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; - -using PepperDash.Essentials; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Config; -using PepperDash.Core; - -namespace EssentialsPluginTemplateEPI -{ - /// - /// This class contains the necessary properties and methods required to function as an Essentials Plugin - /// - public class EssentialsPluginFactory:EssentialsPluginDeviceFactory - { - public EssentialsPluginFactory() - { - // This string is used to define the minimum version of the - // Essentials Framework required for this plugin - MinimumEssentialsFrameworkVersion = "1.6.1"; - - //The strings defined in this list will be used in the configuration file to build the device in this plugin. - TypeNames = new List {"essentialsPluginTemplateDevice"}; - } - - #region Overrides of EssentialsDeviceFactory - - public override EssentialsDevice BuildDevice(DeviceConfig dc) - { - var config = dc.Properties.ToObject(); - var newDevice = new EssentialsPluginTemplateDevice(dc.Key, dc.Name, config); - return newDevice; - } - - #endregion - } -} - diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateJoinMap.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateJoinMap.cs deleted file mode 100644 index 4272a97..0000000 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateJoinMap.cs +++ /dev/null @@ -1,27 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using Crestron.SimplSharp; -using PepperDash.Essentials.Core; - -namespace PDT.EssentialsPluginTemplate.EPI -{ - public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced - { - [JoinName("IsOnline")] - public JoinDataComplete IsOnline = new JoinDataComplete(new JoinData {JoinNumber = 1, JoinSpan = 1}, - new JoinMetadata - { - Description = "Device is Online", - JoinType = eJoinType.Digital, - JoinCapabilities = eJoinCapabilities.ToSIMPL - }); - - - public EssentialsPluginTemplateBridgeJoinMap(uint joinStart):base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap)) - { - - } - } -} \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/NvxUrlRoutingClientEpi.projectinfo b/PDT.EssentialsPluginTemplate.EPI/NvxUrlRoutingClientEpi.projectinfo deleted file mode 100644 index 96ee187..0000000 Binary files a/PDT.EssentialsPluginTemplate.EPI/NvxUrlRoutingClientEpi.projectinfo and /dev/null differ diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user deleted file mode 100644 index 9c6c209..0000000 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user +++ /dev/null @@ -1,5 +0,0 @@ - - - E282E6BE-C7C3-4ece-916A-88FB1CF8AF3C - - \ No newline at end of file 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 deleted file mode 100644 index b86200d..0000000 --- a/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log +++ /dev/null @@ -1,63 +0,0 @@ -8/30/2019 3:01:01 PM, Info: Initializing SIMPLSharp Services... -8/30/2019 3:01:01 PM, Info: ProjectInfo successfully initialized. -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:04:48 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDashEssentials.dll... -8/30/2019 3:05:10 PM, Info: Saving project information... -8/30/2019 3:05:10 PM, Info: Saving project information... -8/30/2019 3:05:10 PM, Info: Saving project information... -8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Core.dll... -8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll... -8/30/2019 3:05:40 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_DM.dll... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:09:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll... -8/30/2019 3:10:10 PM, Info: Saving project information... -8/30/2019 3:10:10 PM, Info: Saving project information... -8/30/2019 3:10:10 PM, Info: Saving project information... -8/30/2019 3:15:10 PM, Info: Saving project information... -8/30/2019 3:15:10 PM, Info: Saving project information... -8/30/2019 3:15:10 PM, Info: Saving project information... -8/30/2019 3:20:10 PM, Info: Saving project information... -8/30/2019 3:20:10 PM, Info: Saving project information... -8/30/2019 3:20:10 PM, Info: Saving project information... -8/30/2019 3:25:10 PM, Info: Saving project information... -8/30/2019 3:25:10 PM, Info: Saving project information... -8/30/2019 3:25:10 PM, Info: Saving project information... -8/30/2019 3:30:10 PM, Info: Saving project information... -8/30/2019 3:30:10 PM, Info: Saving project information... -8/30/2019 3:30:10 PM, Info: Saving project information... -8/30/2019 3:35:10 PM, Info: Saving project information... -8/30/2019 3:35:10 PM, Info: Saving project information... -8/30/2019 3:35:10 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:36:52 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll... -8/30/2019 3:36:52 PM, Info: Verifying assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll -8/30/2019 3:36:52 PM, Info: Creating Archive C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.cplz... -8/30/2019 3:36:53 PM, Info: Saving project information... -9/2/2019 8:34:46 AM, Info: Terminating SIMPLSharp Services diff --git a/README.md b/README.md index c3bd856..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 @@ -8,6 +10,15 @@ Provided under MIT license Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://github.com/PepperDash/Essentials/wiki/Plugins) article. +This repo contains example classes for the three main categories of devices: +* `EssentialsPluginTemplateDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc +* `EssentialsPluginTemplateLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program +* `EssentialsPluginTemplateCrestronDevice`: Used for devices that represent a piece of Crestron hardware + +There are matching factory classes for each of the three categories of devices. The `EssentialsPluginTemplateConfigObject` should be used as a template and modified for any of the categories of device. Same goes for the `EssentialsPluginTemplateBridgeJoinMap`. + +This also illustrates how a plugin can contain multiple devices. + ## Cloning Instructions After forking this repository into your own GitHub space, you can create a new repository using this one as the template. Then you must install the necessary dependencies as indicated below. @@ -20,8 +31,30 @@ The [Essentials](https://github.com/PepperDash/Essentials) libraries are require To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository: `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion`. -To verify that the packages installed correctly, open Essentials and make sure that all references are found, then try and build it. +Alternatively, you can simply run the `GetPackages.bat` file. +To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it. ### Installing Different versions of PepperDash Core If you need a different version of PepperDash Core, use the command `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion -Version {versionToGet}`. Omitting the `-Version` option will pull the version indicated in the packages.config file. + +### Instructions for Renaming Solution and Files + +See the Task List in Visual Studio for a guide on how to start using the template. There is extensive inline documentation and examples as well. + +For renaming instructions in particular, see the XML `remarks` tags on class definitions + +## Build Instructions (PepperDash Internal) + +## Generating Nuget Package + +In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" + +1. Rename the file to match your plugin solution name +2. Edit the file to include your project specifics including + 1. 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 + +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/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln b/epi-make-model.3Series.sln similarity index 79% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln rename to epi-make-model.3Series.sln index 08ca093..b106642 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln +++ b/epi-make-model.3Series.sln @@ -1,7 +1,7 @@  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}" +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 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 4ed0ac7..c0df495 100644 --- a/packages.config +++ b/packages.config @@ -1,3 +1,3 @@ <packages> - <package id="PepperDashEssentials" version="1.6.2" targetFramework="net35" allowedVersions="[1.0,2.0)"/> + <package id="PepperDashEssentials" version="1.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/MakeModelBridgeJoinMap.cs b/src/MakeModelBridgeJoinMap.cs new file mode 100644 index 0000000..0d20a8f --- /dev/null +++ b/src/MakeModelBridgeJoinMap.cs @@ -0,0 +1,101 @@ +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/MakeModelConfigObject.cs b/src/MakeModelConfigObject.cs new file mode 100644 index 0000000..b247414 --- /dev/null +++ b/src/MakeModelConfigObject.cs @@ -0,0 +1,195 @@ +using System.Collections.Generic; +using Newtonsoft.Json; +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin +{ + /// <summary> + /// Plugin device configuration object + /// </summary> + /// <remarks> + /// Rename the class to match the device plugin being created + /// </remarks> + /// <example> + /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" + /// </example> + [ConfigSnippet("\"properties\":{\"control\":{}")] + public class EssentialsPluginTemplateConfigObject + { + /// <summary> + /// JSON control object + /// </summary> + /// <remarks> + /// Typically this object is not required, but in some instances it may be needed. For example, when building a + /// plugin that is using Telnet (TCP/IP) communications and requires login, the device will need to handle the login. + /// In order to do so, you will need the username and password in the "tcpSshProperties" object. + /// </remarks> + /// <example> + /// <code> + /// "control": { + /// "method": "tcpIp", + /// "controlPortDevKey": "processor", + /// "controlPortNumber": 1, + /// "comParams": { + /// "baudRate": 9600, + /// "dataBits": 8, + /// "stopBits": 1, + /// "parity": "None", + /// "protocol": "RS232", + /// "hardwareHandshake": "None", + /// "softwareHandshake": "None" + /// }, + /// "tcpSshProperties": { + /// "address": "172.22.0.101", + /// "port": 23, + /// "username": "admin", + /// "password": "password", + /// "autoReconnect": true, + /// "autoReconnectIntervalMs": 10000 + /// } + /// } + /// </code> + /// </example> + [JsonProperty("control")] + public EssentialsControlPropertiesConfig Control { get; set; } + + /// <summary> + /// Serializes the poll time value + /// </summary> + /// <remarks> + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// </remarks> + /// <value> + /// PollTimeMs property gets/sets the value as a long + /// </value> + /// <example> + /// <code> + /// "properties": { + /// "polltimeMs": 30000 + /// } + /// </code> + /// </example> + [JsonProperty("pollTimeMs")] + public long PollTimeMs { get; set; } + + /// <summary> + /// Serializes the warning timeout value + /// </summary> + /// <remarks> + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// </remarks> + /// <value> + /// WarningTimeoutMs property gets/sets the value as a long + /// </value> + /// <example> + /// <code> + /// "properties": { + /// "warningTimeoutMs": 180000 + /// } + /// </code> + /// </example> + [JsonProperty("warningTimeoutMs")] + public long WarningTimeoutMs { get; set; } + + /// <summary> + /// Serializes the error timeout value + /// </summary> + /// /// <remarks> + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// </remarks> + /// <value> + /// ErrorTimeoutMs property gets/sets the value as a long + /// </value> + /// <example> + /// <code> + /// "properties": { + /// "errorTimeoutMs": 300000 + /// } + /// </code> + /// </example> + [JsonProperty("errorTimeoutMs")] + public long ErrorTimeoutMs { get; set; } + + /// <summary> + /// Example dictionary of objects + /// </summary> + /// <remarks> + /// This is an example collection configuration object. This should be modified or deleted as needed for the plugin being built. + /// </remarks> + /// <example> + /// <code> + /// "properties": { + /// "presets": { + /// "preset1": { + /// "enabled": true, + /// "name": "Preset 1" + /// } + /// } + /// } + /// </code> + /// </example> + /// <example> + /// <code> + /// "properties": { + /// "inputNames": { + /// "input1": "Input 1", + /// "input2": "Input 2" + /// } + /// } + /// </code> + /// </example> + [JsonProperty("DeviceDictionary")] + public Dictionary<string, EssentialsPluginTemplateConfigObjectDictionary> DeviceDictionary { get; set; } + + /// <summary> + /// Constuctor + /// </summary> + /// <remarks> + /// If using a collection you must instantiate the collection in the constructor + /// to avoid exceptions when reading the configuration file + /// </remarks> + public EssentialsPluginTemplateConfigObject() + { + DeviceDictionary = new Dictionary<string, EssentialsPluginTemplateConfigObjectDictionary>(); + } + } + + /// <summary> + /// Example plugin configuration dictionary object + /// </summary> + /// <remarks> + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// </remarks> + /// <example> + /// <code> + /// "properties": { + /// "dictionary": { + /// "item1": { + /// "name": "Item 1 Name", + /// "value": "Item 1 Value" + /// } + /// } + /// } + /// </code> + /// </example> + public class EssentialsPluginTemplateConfigObjectDictionary + { + /// <summary> + /// Serializes collection name property + /// </summary> + /// <remarks> + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// </remarks> + [JsonProperty("name")] + public string Name { get; set; } + + /// <summary> + /// Serializes collection value property + /// </summary> + /// <remarks> + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// </remarks> + [JsonProperty("value")] + public uint Value { get; set; } + } +} \ No newline at end of file diff --git a/src/MakeModelCrestronDevice.cs b/src/MakeModelCrestronDevice.cs new file mode 100644 index 0000000..71c91c1 --- /dev/null +++ b/src/MakeModelCrestronDevice.cs @@ -0,0 +1,99 @@ +// For Basic SIMPL# Classes +// 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 + /// </summary> + /// <remarks> + /// Rename the class to match the device plugin being developed. + /// </remarks> + /// <example> + /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" + /// </example> + public class EssentialsPluginTemplateCrestronDevice : CrestronGenericBridgeableBaseDevice + { + /// <summary> + /// It is often desirable to store the config + /// </summary> + private EssentialsPluginTemplateConfigObject _config; + + + #region Constructor for Devices without IBasicCommunication. Remove if not needed + /// <summary> + /// Plugin device constructor for Crestron devices + /// </summary> + /// <param name="key"></param> + /// <param name="name"></param> + /// <param name="config"></param> + /// <param name="hardware"></param> + 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 + + /// <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.OnlineStatusChange += (o, a) => + { + if (!a.DeviceOnLine) return; + + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + }; + } + + + #endregion + + } +} + diff --git a/src/MakeModelDevice.cs b/src/MakeModelDevice.cs new file mode 100644 index 0000000..da423a2 --- /dev/null +++ b/src/MakeModelDevice.cs @@ -0,0 +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 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/MakeModelFactory.cs b/src/MakeModelFactory.cs new file mode 100644 index 0000000..e94994a --- /dev/null +++ b/src/MakeModelFactory.cs @@ -0,0 +1,239 @@ +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 + /// </summary> + /// <remarks> + /// Rename the class to match the device plugin being developed + /// </remarks> + /// <example> + /// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory" + /// </example> + public class EssentialsPluginTemplateFactory : EssentialsPluginDeviceFactory<EssentialsPluginTemplateDevice> + { + /// <summary> + /// Plugin device factory constructor + /// </summary> + /// <remarks> + /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin + /// </remarks> + /// <example> + /// Set the minimum Essentials Framework Version + /// <code> + /// MinimumEssentialsFrameworkVersion = "1.6.4; + /// </code> + /// In the constructor we initialize the list with the typenames that will build an instance of this device + /// <code> + /// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" }; + /// </code> + /// </example> + public EssentialsPluginTemplateFactory() + { + // Set the minimum Essentials Framework Version + // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against + MinimumEssentialsFrameworkVersion = "1.6.4"; + + // In the constructor we initialize the list with the typenames that will build an instance of this device + // TODO [ ] Update the TypeNames for the plugin being developed + TypeNames = new List<string>() { "examplePluginDevice" }; + } + + /// <summary> + /// Builds and returns an instance of EssentialsPluginDeviceTemplate + /// </summary> + /// <param name="dc">device configuration</param> + /// <returns>plugin device or null</returns> + /// <remarks> + /// The example provided below takes the device key, name, properties config and the comms device created. + /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. + /// </remarks> + /// <seealso cref="PepperDash.Core.eControlMethod"/> + public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) + { + Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); + + // get the plugin device properties configuration object & check for null + var propertiesConfig = dc.Properties.ToObject<EssentialsPluginTemplateConfigObject>(); + if (propertiesConfig == null) + { + Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); + return null; + } + + // attempt build the plugin device comms device & check for null + // TODO { ] As of PepperDash Core 1.0.41, HTTP and HTTPS are not valid eControlMethods and will throw an exception. + var comms = CommFactory.CreateCommForDevice(dc); + if (comms == null) + { + Debug.Console(1, "[{0}] Factory Notice: No control object present for device {1}", dc.Key, dc.Name); + return null; + } + else + { + return new EssentialsPluginTemplateDevice(dc.Key, dc.Name, propertiesConfig, comms); + } + + } + + } + + /// <summary> + /// Plugin device factory for logic devices that don't communicate + /// </summary> + /// <remarks> + /// Rename the class to match the device plugin being developed + /// </remarks> + /// <example> + /// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory" + /// </example> + public class EssentialsPluginTemplateFactoryLogicDevice : EssentialsPluginDeviceFactory<EssentialsPluginTemplateLogicDevice> + { + /// <summary> + /// Plugin device factory constructor + /// </summary> + /// <remarks> + /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin + /// </remarks> + /// <example> + /// Set the minimum Essentials Framework Version + /// <code> + /// MinimumEssentialsFrameworkVersion = "1.6.4; + /// </code> + /// In the constructor we initialize the list with the typenames that will build an instance of this device + /// <code> + /// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" }; + /// </code> + /// </example> + public EssentialsPluginTemplateFactoryLogicDevice() + { + // Set the minimum Essentials Framework Version + // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against + MinimumEssentialsFrameworkVersion = "1.6.4"; + + // In the constructor we initialize the list with the typenames that will build an instance of this device + // TODO [ ] Update the TypeNames for the plugin being developed + TypeNames = new List<string>() { "examplePluginLogicDevice" }; + } + + /// <summary> + /// Builds and returns an instance of EssentialsPluginTemplateLogicDevice + /// </summary> + /// <param name="dc">device configuration</param> + /// <returns>plugin device or null</returns> + /// <remarks> + /// The example provided below takes the device key, name, properties config and the comms device created. + /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. + /// </remarks> + /// <seealso cref="PepperDash.Core.eControlMethod"/> + public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) + { + + Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); + + // get the plugin device properties configuration object & check for null + var propertiesConfig = dc.Properties.ToObject<EssentialsPluginTemplateConfigObject>(); + if (propertiesConfig == null) + { + Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); + return null; + } + + var controlConfig = CommFactory.GetControlPropertiesConfig(dc); + + if (controlConfig == null) + { + return new EssentialsPluginTemplateLogicDevice(dc.Key, dc.Name, propertiesConfig); + } + else + { + Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name); + return null; + } + } + } + + /// <summary> + /// Plugin device factory for Crestron wrapper devices + /// </summary> + /// <remarks> + /// Rename the class to match the device plugin being developed + /// </remarks> + /// <example> + /// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory" + /// </example> + public class EssentialsPluginTemplateFactoryCrestronDevice : EssentialsPluginDeviceFactory<EssentialsPluginTemplateCrestronDevice> + { + /// <summary> + /// Plugin device factory constructor + /// </summary> + /// <remarks> + /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin + /// </remarks> + /// <example> + /// Set the minimum Essentials Framework Version + /// <code> + /// MinimumEssentialsFrameworkVersion = "1.6.4; + /// </code> + /// In the constructor we initialize the list with the typenames that will build an instance of this device + /// <code> + /// TypeNames = new List<string>() { "SamsungMdc", "SamsungMdcDisplay" }; + /// </code> + /// </example> + public EssentialsPluginTemplateFactoryCrestronDevice() + { + // Set the minimum Essentials Framework Version + // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against + MinimumEssentialsFrameworkVersion = "1.7.5"; + + // In the constructor we initialize the list with the typenames that will build an instance of this device + // TODO [ ] Update the TypeNames for the plugin being developed + TypeNames = new List<string>() { "examplePluginCrestronDevice" }; + } + + /// <summary> + /// Builds and returns an instance of EssentialsPluginTemplateCrestronDevice + /// </summary> + /// <param name="dc">device configuration</param> + /// <returns>plugin device or null</returns> + /// <remarks> + /// The example provided below takes the device key, name, properties config and the comms device created. + /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. + /// </remarks> + /// <seealso cref="PepperDash.Core.eControlMethod"/> + public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) + { + + Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); + + // get the plugin device properties configuration object & check for null + var propertiesConfig = dc.Properties.ToObject<EssentialsPluginTemplateConfigObject>(); + if (propertiesConfig == null) + { + Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); + return null; + } + + var controlConfig = CommFactory.GetControlPropertiesConfig(dc); + + if (controlConfig == null) + { + var myTouchpanel = new Tsw760(controlConfig.IpIdInt, Global.ControlSystem); + + return new EssentialsPluginTemplateCrestronDevice(dc.Key, dc.Name, propertiesConfig, myTouchpanel); + } + else + { + Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name); + return null; + } + } + } + +} + + \ No newline at end of file diff --git a/src/MakeModelLogicDevice.cs b/src/MakeModelLogicDevice.cs new file mode 100644 index 0000000..44aeeec --- /dev/null +++ b/src/MakeModelLogicDevice.cs @@ -0,0 +1,86 @@ +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 + /// </summary> + /// <remarks> + /// Rename the class to match the device plugin being developed. + /// </remarks> + /// <example> + /// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice" + /// </example> + public class EssentialsPluginTemplateLogicDevice : EssentialsBridgeableDevice + { + /// <summary> + /// It is often desirable to store the config + /// </summary> + private EssentialsPluginTemplateConfigObject _config; + + /// <summary> + /// Plugin device constructor + /// </summary> + /// <param name="key"></param> + /// <param name="name"></param> + /// <param name="config"></param> + 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 + + /// <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.OnlineStatusChange += (o, a) => + { + if (!a.DeviceOnLine) return; + + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + }; + } + + #endregion + + } +} + diff --git a/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs b/src/Properties/AssemblyInfo.cs similarity index 78% rename from PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs rename to src/Properties/AssemblyInfo.cs index b31431b..275e917 100644 --- a/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs +++ b/src/Properties/AssemblyInfo.cs @@ -1,8 +1,8 @@ -using System.Reflection; - -[assembly: AssemblyTitle("EssentialsPluginTemplateEpi")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("EssentialsPluginTemplateEpi")] -[assembly: AssemblyCopyright("Copyright © 2019")] -[assembly: AssemblyVersion("1.0.0.*")] - +using System.Reflection; + +[assembly: AssemblyTitle("EssentialsPluginTemplateEpi")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("EssentialsPluginTemplateEpi")] +[assembly: AssemblyCopyright("Copyright © 2022")] +[assembly: AssemblyVersion("1.0.0.*")] + diff --git a/PDT.EssentialsPluginTemplate.EPI/Properties/ControlSystem.cfg b/src/Properties/ControlSystem.cfg similarity index 100% rename from PDT.EssentialsPluginTemplate.EPI/Properties/ControlSystem.cfg rename to src/Properties/ControlSystem.cfg diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj b/src/epi-make-model.3Series.csproj similarity index 81% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj rename to src/epi-make-model.3Series.csproj index dda70b0..03aa3ce 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj +++ b/src/epi-make-model.3Series.csproj @@ -7,8 +7,8 @@ <ProjectGuid>{9D249E47-8F95-4437-A6BB-563510287AD1}</ProjectGuid> <OutputType>Library</OutputType> <AppDesignerFolder>Properties</AppDesignerFolder> - <RootNamespace>PDT.EssentialsPluginTemplate.EPI</RootNamespace> - <AssemblyName>PDT.EssentialsPluginTemplate.EPI</AssemblyName> + <RootNamespace>PepperDash.Essentials.Plugin</RootNamespace> + <AssemblyName>MakeModelPlugin</AssemblyName> <ProjectTypeGuids>{0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids> <PlatformFamilyName>WindowsCE</PlatformFamilyName> <PlatformID>E2BECB1F-8C8C-41ba-B736-9BE7D946A398</PlatformID> @@ -46,6 +46,10 @@ <GenerateSerializationAssemblies>off</GenerateSerializationAssemblies> </PropertyGroup> <ItemGroup> + <Reference Include="Crestron.SimplSharpPro.UI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>C:\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll</HintPath> + </Reference> <Reference Include="Essentials Devices Common, Version=1.6.2.33892, Culture=neutral, processorArchitecture=MSIL"> <SpecificVersion>False</SpecificVersion> <HintPath>..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll</HintPath> @@ -69,37 +73,39 @@ </Reference> <Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <SpecificVersion>False</SpecificVersion> - <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath> + <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath> <Private>False</Private> </Reference> <Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <SpecificVersion>False</SpecificVersion> - <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath> + <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath> <Private>False</Private> </Reference> <Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <SpecificVersion>False</SpecificVersion> - <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll</HintPath> + <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll</HintPath> </Reference> <Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <SpecificVersion>False</SpecificVersion> - <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath> + <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath> <Private>False</Private> </Reference> <Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <SpecificVersion>False</SpecificVersion> - <HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll</HintPath> + <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll</HintPath> </Reference> <Reference Include="System" /> <Reference Include="System.Core" /> <Reference Include="System.Data" /> </ItemGroup> <ItemGroup> - <Compile Include="EssentialsPluginTemplateConfigObject.cs" /> - <Compile Include="EssentialsPluginTemplateFactory.cs" /> - <Compile Include="EssentialsPluginTemplateJoinMap.cs" /> + <Compile Include="MakeModelCrestronDevice.cs" /> + <Compile Include="MakeModelBridgeJoinMap.cs" /> + <Compile Include="MakeModelConfigObject.cs" /> + <Compile Include="MakeModelDevice.cs" /> + <Compile Include="MakeModelFactory.cs" /> + <Compile Include="MakeModelLogicDevice.cs" /> <Compile Include="Properties\AssemblyInfo.cs" /> - <Compile Include="EssentialsPluginTemplateDevice.cs" /> <None Include="Properties\ControlSystem.cfg" /> </ItemGroup> <Import Project="$(MSBuildBinPath)\Microsoft.CompactFramework.CSharp.targets" /> 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 @@ +<Project Sdk="Microsoft.NET.Sdk"> + <PropertyGroup> + <ProjectType>ProgramLibrary</ProjectType> + </PropertyGroup> + <PropertyGroup> + <TargetFramework>net472</TargetFramework> + <RootNamespace>PepperDash.Essentials.Plugin</RootNamespace> + <Deterministic>false</Deterministic> + <AssemblyTitle>PepperDash.Essentials.Plugin.Make.Model</AssemblyTitle> + <Company>PepperDash Technology</Company> + <Description>This software is a template for a PepperDash Essentials Plugin.</Description> + <Copyright>Copyright 2025</Copyright> + <Version>1.0.0-local</Version> + <GenerateAssemblyInfo>true</GenerateAssemblyInfo> + <InformationalVersion>$(Version)</InformationalVersion> + <OutputPath>bin\$(Configuration)\</OutputPath> + <Authors>PepperDash Technology</Authors> + <PackageId>Pepperdash.Essentials.Plugins.Template</PackageId> + <PackageProjectUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</PackageProjectUrl> + <PackageTags>crestron 4series essentials plugin template</PackageTags> + </PropertyGroup> + + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'"> + <DefineConstants>$(DefineConstants);SERIES4</DefineConstants> + </PropertyGroup> + + <ItemGroup> + <Compile Remove="Properties\**" /> + <EmbeddedResource Remove="Properties\**" /> + <None Remove="Properties\**" /> + </ItemGroup> + + <ItemGroup> + <None Remove="epi-make-model.projectinfo" /> + </ItemGroup> + + <ItemGroup> + <PackageReference Include="PepperDashEssentials" Version="2.0.0" > + <ExcludeAssets>runtime</ExcludeAssets> + </PackageReference> + </ItemGroup> + + <ItemGroup> + <None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" /> + </ItemGroup> + + <ItemGroup> + <None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" /> + </ItemGroup> +</Project>