diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index ad34045..8fcbbf8 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -222,6 +222,7 @@ jobs: Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 + env: NUSPECNAME steps: - name: Download Build Version Info uses: actions/download-artifact@v1 @@ -250,22 +251,27 @@ jobs: 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: Get nuget File shell: powershell run: | - $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + $NUSPECNAME = Get-ChildItem *.nuspec -recurse + echo "NUSPEC_FILE=$($NUSPECNAME.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Add nuget.exe uses: nuget/setup-nuget@v1 - name: Add Github Packages source + if: $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, not needed unless publishing publicly + # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $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' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget push **/*.nupkg -source github - # Pushes to nuget, not needed unless publishing publicly >> this pushes package to nuget.org - name: Publish nuget package to nuget.org + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $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 index 3e169ce..ff951dd 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -111,7 +111,7 @@ jobs: $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 { + 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) { @@ -170,6 +170,7 @@ jobs: Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 + env: NUSPECNAME steps: - name: Download Build Version Info uses: actions/download-artifact@v1 @@ -195,25 +196,31 @@ jobs: Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory run: | - Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") + Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz","*.md") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse + # Pushes to github nuget store - name: Get nuget File shell: powershell run: | - $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + $NUSPECNAME = Get-ChildItem *.nuspec -recurse + echo "NUSPEC_FILE=$($NUSPECNAME.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Add nuget.exe uses: nuget/setup-nuget@v1 - name: Add Github Packages source + if: $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, not needed unless publishing publicly + # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $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' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget push **/*.nupkg -source github - # Pushes to nuget, not needed unless publishing publicly >> this pushes package to nuget.org - name: Publish nuget package to nuget.org + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json + \ No newline at end of file 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/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/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs b/src/EssentialsPluginTemplateBridgeJoinMap.cs similarity index 91% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs rename to src/EssentialsPluginTemplateBridgeJoinMap.cs index 1f1f9d0..140d021 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs +++ b/src/EssentialsPluginTemplateBridgeJoinMap.cs @@ -12,7 +12,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap" /// - public class EssentialsPluginBridgeJoinMapTemplate : JoinMapBaseAdvanced + public class EssentialsPluginTemplateBridgeJoinMap : 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 EssentialsPluginBridgeJoinMapTemplate(uint joinStart) - : base(joinStart, typeof(EssentialsPluginBridgeJoinMapTemplate)) + public EssentialsPluginTemplateBridgeJoinMap(uint joinStart) + : base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap)) { } } diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs b/src/EssentialsPluginTemplateConfigObject.cs similarity index 94% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs rename to src/EssentialsPluginTemplateConfigObject.cs index 027cefe..5894d67 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs +++ b/src/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 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; } - } +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 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 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; } + } } \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs b/src/EssentialsPluginTemplateCrestronDevice.cs similarity index 98% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs rename to src/EssentialsPluginTemplateCrestronDevice.cs index 2377387..7da4ddf 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs +++ b/src/EssentialsPluginTemplateCrestronDevice.cs @@ -23,7 +23,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginConfigObjectTemplate _config; + private EssentialsPluginTemplateConfigObject _config; #region Constructor for Devices without IBasicCommunication. Remove if not needed diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs b/src/EssentialsPluginTemplateDevice.cs similarity index 97% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs rename to src/EssentialsPluginTemplateDevice.cs index 20c99da..d08418c 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs +++ b/src/EssentialsPluginTemplateDevice.cs @@ -24,7 +24,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginConfigObjectTemplate _config; + private EssentialsPluginTemplateConfigObject _config; /// /// Provides a queue and dedicated worker thread for processing feedback messages from a device. @@ -98,7 +98,7 @@ namespace EssentialsPluginTemplate /// /// /// - public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, IBasicCommunication comms) + public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) : base(key, name) { Debug.Console(0, this, "Constructing new {0} instance", name); @@ -244,7 +244,7 @@ namespace EssentialsPluginTemplate /// public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) { - var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); + var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); // This adds the join map to the collection on the bridge if (bridge != null) diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs b/src/EssentialsPluginTemplateFactory.cs similarity index 95% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs rename to src/EssentialsPluginTemplateFactory.cs index 1798d19..d2eddce 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs +++ b/src/EssentialsPluginTemplateFactory.cs @@ -14,7 +14,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory" /// - public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory + public class EssentialsPluginTemplateFactory : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -32,7 +32,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginFactoryTemplate() + public EssentialsPluginTemplateFactory() { // Set the minimum Essentials Framework Version // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against @@ -58,7 +58,7 @@ namespace EssentialsPluginTemplate 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(); + var propertiesConfig = dc.Properties.ToObject(); if (propertiesConfig == null) { Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); @@ -91,7 +91,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory" /// - public class EssentialsPluginFactoryLogicDeviceTemplate : EssentialsPluginDeviceFactory + public class EssentialsPluginTemplateFactoryLogicDevice : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -109,7 +109,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginFactoryLogicDeviceTemplate() + public EssentialsPluginTemplateFactoryLogicDevice() { // Set the minimum Essentials Framework Version // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against @@ -136,7 +136,7 @@ namespace EssentialsPluginTemplate 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(); + var propertiesConfig = dc.Properties.ToObject(); if (propertiesConfig == null) { Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); @@ -166,7 +166,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory" /// - public class EssentialsPluginFactoryCrestronDeviceTemplate : EssentialsPluginDeviceFactory + public class EssentialsPluginTemplateFactoryCrestronDevice : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -184,7 +184,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginFactoryCrestronDeviceTemplate() + public EssentialsPluginTemplateFactoryCrestronDevice() { // Set the minimum Essentials Framework Version // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs b/src/EssentialsPluginTemplateLogicDevice.cs similarity index 92% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs rename to src/EssentialsPluginTemplateLogicDevice.cs index eda5ad0..0685a43 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs +++ b/src/EssentialsPluginTemplateLogicDevice.cs @@ -19,7 +19,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginConfigObjectTemplate _config; + private EssentialsPluginTemplateConfigObject _config; /// /// Plugin device constructor @@ -27,7 +27,7 @@ namespace EssentialsPluginTemplate /// /// /// - public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginConfigObjectTemplate config) + public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginTemplateConfigObject config) : base(key, name) { Debug.Console(0, this, "Constructing new {0} instance", name); @@ -48,7 +48,7 @@ namespace EssentialsPluginTemplate /// public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) { - var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); + var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); // This adds the join map to the collection on the bridge if (bridge != null) diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj b/src/PDT.EssentialsPluginTemplate.EPI.csproj similarity index 98% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj rename to src/PDT.EssentialsPluginTemplate.EPI.csproj index 6dd00f2..edda00c 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj +++ b/src/PDT.EssentialsPluginTemplate.EPI.csproj @@ -1,115 +1,115 @@ - - - Release - AnyCPU - 9.0.30729 - 2.0 - {9D249E47-8F95-4437-A6BB-563510287AD1} - Library - Properties - PDT.EssentialsPluginTemplate.EPI - PDT.EssentialsPluginTemplate.EPI - {0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} - WindowsCE - E2BECB1F-8C8C-41ba-B736-9BE7D946A398 - 5.0 - SmartDeviceProject1 - v3.5 - Windows CE - - - - - .allowedReferenceRelatedFileExtensions - true - full - false - bin\Debug\ - DEBUG;TRACE; - prompt - 4 - 512 - true - true - off - - - .allowedReferenceRelatedFileExtensions - none - true - bin\Release\ - prompt - 4 - 512 - true - true - off - - - - False - ..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll - - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll - - - - - - - - - - - - - - - - - - rem S# Pro preparation will execute after these operations - + + + Release + AnyCPU + 9.0.30729 + 2.0 + {9D249E47-8F95-4437-A6BB-563510287AD1} + Library + Properties + 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 + \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln b/src/PDT.EssentialsPluginTemplate.EPI.sln similarity index 97% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln rename to src/PDT.EssentialsPluginTemplate.EPI.sln index 08ca093..f453fd6 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln +++ b/src/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/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE b/src/PDT.EssentialsPluginTemplate.nuspec similarity index 81% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE rename to src/PDT.EssentialsPluginTemplate.nuspec index 7b99bed..e72f807 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE +++ b/src/PDT.EssentialsPluginTemplate.nuspec @@ -2,6 +2,7 @@ PDT.EssentialsPluginTemplate + docs\README.md 2.0.2 Essentials Plugin Template PepperDash Technologies @@ -11,11 +12,12 @@ https://github.com/PepperDash/EssentialsPluginTemplate Copyright 2022 This software iserves as a template for generating new Essentials-Compliant plugins - crestron 3series 4series samsung + crestron 3series 4series essentials pepperdash pepperdashessentials epi essentials plugin + \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs b/src/Properties/AssemblyInfo.cs similarity index 97% rename from PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs rename to src/Properties/AssemblyInfo.cs index e8f1480..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 © 2022")] -[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