diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 3b42815..ad34045 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -153,7 +153,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", "*.md" | ForEach-Object { + Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz", "*.nuspec" | ForEach-Object { $allowed = $true; # Exclude any files in submodules foreach ($exclude in $exclusions) { @@ -253,27 +253,19 @@ jobs: - name: Get nuget File shell: powershell run: | - $nuspec_file = (Get-ChildItem *.nuspec -recurse).BaseName - echo "NUSPEC_FILE=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - # Pulls the nuget builder packages + $nuspec_file = Get-ChildItem *.nuspec -recurse + echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Add nuget.exe - if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" uses: nuget/setup-nuget@v1 - # Creating nuget Packages - name: Add Github Packages source - if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} - - name: Create nuget package - if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" - run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - # Pushes to internal github registry - - name: Publish nuget package to Github registry - if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" - run: nuget push **/*.nupkg -source github - # Pushes to nuget gallery + # Pushes to nuget, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate') run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} + - name: Create nuget package + run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} + - name: Publish nuget package to Github registry + 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' && !contains(env.NUSPEC_FILE, '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 2ae1117..3e169ce 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", "*.md" | ForEach-Object { + Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz", "*.nuspec" | ForEach-Object { $allowed = $true; # Exclude any files in submodules foreach ($exclude in $exclusions) { @@ -201,27 +201,19 @@ jobs: - name: Get nuget File shell: powershell run: | - $nuspec_file = (Get-ChildItem *.nuspec -recurse).BaseName - echo "NUSPEC_FILE=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - # Pulls the nuget builder packages + $nuspec_file = Get-ChildItem *.nuspec -recurse + echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Add nuget.exe - if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" uses: nuget/setup-nuget@v1 - # Creating nuget Packages - name: Add Github Packages source - if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} - - name: Create nuget package - if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" - run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - # Pushes to internal github registry - - name: Publish nuget package to Github registry - if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" - run: nuget push **/*.nupkg -source github - # Pushes to nuget gallery + # Pushes to nuget, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate') run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} + - name: Create nuget package + run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} + - name: Publish nuget package to Github registry + 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' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate') run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/GetPackages.BAT b/GetPackages.BAT deleted file mode 100644 index 9b6def3..0000000 --- a/GetPackages.BAT +++ /dev/null @@ -1,2 +0,0 @@ -@Echo ON -nuget install .\packages.config -OutputDirectory .\packages -excludeVersion diff --git a/src/EssentialsPluginTemplateBridgeJoinMap.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs similarity index 91% rename from src/EssentialsPluginTemplateBridgeJoinMap.cs rename to PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs index 140d021..1f1f9d0 100644 --- a/src/EssentialsPluginTemplateBridgeJoinMap.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs @@ -12,7 +12,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap" /// - public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced + public class EssentialsPluginBridgeJoinMapTemplate : JoinMapBaseAdvanced { #region Digital @@ -93,8 +93,8 @@ namespace EssentialsPluginTemplate /// Plugin device BridgeJoinMap constructor /// /// This will be the join it starts on the EISC bridge - public EssentialsPluginTemplateBridgeJoinMap(uint joinStart) - : base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap)) + public EssentialsPluginBridgeJoinMapTemplate(uint joinStart) + : base(joinStart, typeof(EssentialsPluginBridgeJoinMapTemplate)) { } } diff --git a/src/EssentialsPluginTemplateConfigObject.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs similarity index 90% rename from src/EssentialsPluginTemplateConfigObject.cs rename to PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs index e216796..027cefe 100644 --- a/src/EssentialsPluginTemplateConfigObject.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs @@ -1,195 +1,195 @@ -using System.Collections.Generic; -using Newtonsoft.Json; -using PepperDash.Essentials.Core; - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device configuration object - /// - /// - /// Rename the class to match the device plugin being created - /// - /// - /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" - /// - [ConfigSnippet("\"properties\":{\"control\":{}")] - public class EssentialsPluginTemplateConfigObject - { - /// - /// JSON control object - /// - /// - /// Typically this object is not required, but in some instances it may be needed. For example, when building a - /// plugin that is using Telnet (TCP/IP) communications and requires login, the device will need to handle the login. - /// In order to do so, you will need the username and password in the "tcpSshProperties" object. - /// - /// - /// - /// "control": { - /// "method": "tcpIp", - /// "controlPortDevKey": "processor", - /// "controlPortNumber": 1, - /// "comParams": { - /// "baudRate": 9600, - /// "dataBits": 8, - /// "stopBits": 1, - /// "parity": "None", - /// "protocol": "RS232", - /// "hardwareHandshake": "None", - /// "softwareHandshake": "None" - /// }, - /// "tcpSshProperties": { - /// "address": "172.22.0.101", - /// "port": 23, - /// "username": "admin", - /// "password": "password", - /// "autoReconnect": true, - /// "autoReconnectIntervalMs": 10000 - /// } - /// } - /// - /// - [JsonProperty("control")] - public EssentialsControlPropertiesConfig Control { get; set; } - - /// - /// Serializes the poll time value - /// - /// - /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. - /// - /// - /// PollTimeMs property gets/sets the value as a long - /// - /// - /// - /// "properties": { - /// "polltimeMs": 30000 - /// } - /// - /// - [JsonProperty("pollTimeMs")] - public long PollTimeMs { get; set; } - - /// - /// Serializes the warning timeout value - /// - /// - /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. - /// - /// - /// WarningTimeoutMs property gets/sets the value as a long - /// - /// - /// - /// "properties": { - /// "warningTimeoutMs": 180000 - /// } - /// - /// - [JsonProperty("warningTimeoutMs")] - public long WarningTimeoutMs { get; set; } - - /// - /// Serializes the error timeout value - /// - /// /// - /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. - /// - /// - /// ErrorTimeoutMs property gets/sets the value as a long - /// - /// - /// - /// "properties": { - /// "errorTimeoutMs": 300000 - /// } - /// - /// - [JsonProperty("errorTimeoutMs")] - public long ErrorTimeoutMs { get; set; } - - /// - /// Example dictionary of objects - /// - /// - /// This is an example collection configuration object. This should be modified or deleted as needed for the plugin being built. - /// - /// - /// - /// "properties": { - /// "presets": { - /// "preset1": { - /// "enabled": true, - /// "name": "Preset 1" - /// } - /// } - /// } - /// - /// - /// - /// - /// "properties": { - /// "inputNames": { - /// "input1": "Input 1", - /// "input2": "Input 2" - /// } - /// } - /// - /// - [JsonProperty("DeviceDictionary")] - public Dictionary DeviceDictionary { get; set; } - - /// - /// Constuctor - /// - /// - /// If using a collection you must instantiate the collection in the constructor - /// to avoid exceptions when reading the configuration file - /// - public EssentialsPluginTemplateConfigObject() - { - DeviceDictionary = new Dictionary(); - } - } - - /// - /// Example plugin configuration dictionary object - /// - /// - /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. - /// - /// - /// - /// "properties": { - /// "dictionary": { - /// "item1": { - /// "name": "Item 1 Name", - /// "value": "Item 1 Value" - /// } - /// } - /// } - /// - /// - public class EssentialsPluginTemplateConfigObjectDictionary - { - /// - /// Serializes collection name property - /// - /// - /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. - /// - [JsonProperty("name")] - public string Name { get; set; } - - /// - /// Serializes collection value property - /// - /// - /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. - /// - [JsonProperty("value")] - public uint Value { get; set; } - } +using System.Collections.Generic; +using Newtonsoft.Json; +using PepperDash.Essentials.Core; + +namespace EssentialsPluginTemplate +{ + /// + /// Plugin device configuration object + /// + /// + /// Rename the class to match the device plugin being created + /// + /// + /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" + /// + [ConfigSnippet("\"properties\":{\"control\":{}")] + public class EssentialsPluginConfigObjectTemplate + { + /// + /// JSON control object + /// + /// + /// Typically this object is not required, but in some instances it may be needed. For example, when building a + /// plugin that is using Telnet (TCP/IP) communications and requires login, the device will need to handle the login. + /// In order to do so, you will need the username and password in the "tcpSshProperties" object. + /// + /// + /// + /// "control": { + /// "method": "tcpIp", + /// "controlPortDevKey": "processor", + /// "controlPortNumber": 1, + /// "comParams": { + /// "baudRate": 9600, + /// "dataBits": 8, + /// "stopBits": 1, + /// "parity": "None", + /// "protocol": "RS232", + /// "hardwareHandshake": "None", + /// "softwareHandshake": "None" + /// }, + /// "tcpSshProperties": { + /// "address": "172.22.0.101", + /// "port": 23, + /// "username": "admin", + /// "password": "password", + /// "autoReconnect": true, + /// "autoReconnectIntervalMs": 10000 + /// } + /// } + /// + /// + [JsonProperty("control")] + public EssentialsControlPropertiesConfig Control { get; set; } + + /// + /// Serializes the poll time value + /// + /// + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// + /// + /// PollTimeMs property gets/sets the value as a long + /// + /// + /// + /// "properties": { + /// "polltimeMs": 30000 + /// } + /// + /// + [JsonProperty("pollTimeMs")] + public long PollTimeMs { get; set; } + + /// + /// Serializes the warning timeout value + /// + /// + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// + /// + /// WarningTimeoutMs property gets/sets the value as a long + /// + /// + /// + /// "properties": { + /// "warningTimeoutMs": 180000 + /// } + /// + /// + [JsonProperty("warningTimeoutMs")] + public long WarningTimeoutMs { get; set; } + + /// + /// Serializes the error timeout value + /// + /// /// + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// + /// + /// ErrorTimeoutMs property gets/sets the value as a long + /// + /// + /// + /// "properties": { + /// "errorTimeoutMs": 300000 + /// } + /// + /// + [JsonProperty("errorTimeoutMs")] + public long ErrorTimeoutMs { get; set; } + + /// + /// Example dictionary of objects + /// + /// + /// This is an example collection configuration object. This should be modified or deleted as needed for the plugin being built. + /// + /// + /// + /// "properties": { + /// "presets": { + /// "preset1": { + /// "enabled": true, + /// "name": "Preset 1" + /// } + /// } + /// } + /// + /// + /// + /// + /// "properties": { + /// "inputNames": { + /// "input1": "Input 1", + /// "input2": "Input 2" + /// } + /// } + /// + /// + [JsonProperty("DeviceDictionary")] + public Dictionary DeviceDictionary { get; set; } + + /// + /// Constuctor + /// + /// + /// If using a collection you must instantiate the collection in the constructor + /// to avoid exceptions when reading the configuration file + /// + public EssentialsPluginConfigObjectTemplate() + { + DeviceDictionary = new Dictionary(); + } + } + + /// + /// Example plugin configuration dictionary object + /// + /// + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// + /// + /// + /// "properties": { + /// "dictionary": { + /// "item1": { + /// "name": "Item 1 Name", + /// "value": "Item 1 Value" + /// } + /// } + /// } + /// + /// + public class EssentialsPluginConfigObjectDictionaryTemplate + { + /// + /// Serializes collection name property + /// + /// + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// + [JsonProperty("name")] + public string Name { get; set; } + + /// + /// Serializes collection value property + /// + /// + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// + [JsonProperty("value")] + public uint Value { get; set; } + } } \ No newline at end of file diff --git a/src/EssentialsPluginTemplateCrestronDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs similarity index 93% rename from src/EssentialsPluginTemplateCrestronDevice.cs rename to PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs index 8836cc5..2377387 100644 --- a/src/EssentialsPluginTemplateCrestronDevice.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs @@ -23,7 +23,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginTemplateConfigObject _config; + private EssentialsPluginConfigObjectTemplate _config; #region Constructor for Devices without IBasicCommunication. Remove if not needed @@ -34,7 +34,7 @@ namespace EssentialsPluginTemplate /// /// /// - public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginTemplateConfigObject config, GenericBase hardware) + public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, GenericBase hardware) : base(key, name, hardware) { Debug.Console(0, this, "Constructing new {0} instance", name); @@ -60,7 +60,7 @@ namespace EssentialsPluginTemplate /// public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) { - var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); + var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); // This adds the join map to the collection on the bridge if (bridge != null) diff --git a/src/EssentialsPluginTemplateDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs similarity index 96% rename from src/EssentialsPluginTemplateDevice.cs rename to PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs index b6d2031..20c99da 100644 --- a/src/EssentialsPluginTemplateDevice.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs @@ -5,7 +5,7 @@ using Crestron.SimplSharpPro.DeviceSupport; using PepperDash.Core; using PepperDash.Essentials.Core; using PepperDash.Essentials.Core.Bridges; -using PepperDash.Essentials.Core.Queues; +using PepperDash_Essentials_Core.Queues; namespace EssentialsPluginTemplate @@ -24,7 +24,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginTemplateConfigObject _config; + private EssentialsPluginConfigObjectTemplate _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, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) + public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginConfigObjectTemplate 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 EssentialsPluginTemplateBridgeJoinMap(joinStart); + var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); // This adds the join map to the collection on the bridge if (bridge != null) diff --git a/src/EssentialsPluginTemplateFactory.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs similarity index 95% rename from src/EssentialsPluginTemplateFactory.cs rename to PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs index 0b58f52..1798d19 100644 --- a/src/EssentialsPluginTemplateFactory.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs @@ -14,7 +14,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory" /// - public class EssentialsPluginTemplateFactory : EssentialsPluginDeviceFactory + public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -32,7 +32,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginTemplateFactory() + public EssentialsPluginFactoryTemplate() { // 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 EssentialsPluginTemplateFactoryLogicDevice : EssentialsPluginDeviceFactory + public class EssentialsPluginFactoryLogicDeviceTemplate : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -109,7 +109,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginTemplateFactoryLogicDevice() + public EssentialsPluginFactoryLogicDeviceTemplate() { // 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 EssentialsPluginTemplateFactoryCrestronDevice : EssentialsPluginDeviceFactory + public class EssentialsPluginFactoryCrestronDeviceTemplate : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -184,7 +184,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginTemplateFactoryCrestronDevice() + public EssentialsPluginFactoryCrestronDeviceTemplate() { // Set the minimum Essentials Framework Version // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against @@ -211,7 +211,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); diff --git a/src/EssentialsPluginTemplateLogicDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs similarity index 92% rename from src/EssentialsPluginTemplateLogicDevice.cs rename to PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs index 0685a43..eda5ad0 100644 --- a/src/EssentialsPluginTemplateLogicDevice.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs @@ -19,7 +19,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginTemplateConfigObject _config; + private EssentialsPluginConfigObjectTemplate _config; /// /// Plugin device constructor @@ -27,7 +27,7 @@ namespace EssentialsPluginTemplate /// /// /// - public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginTemplateConfigObject config) + public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginConfigObjectTemplate 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 EssentialsPluginTemplateBridgeJoinMap(joinStart); + var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); // This adds the join map to the collection on the bridge if (bridge != null) diff --git a/PDT.EssentialsPluginTemplate.EPI/NvxUrlRoutingClientEpi.projectinfo b/PDT.EssentialsPluginTemplate.EPI/NvxUrlRoutingClientEpi.projectinfo new file mode 100644 index 0000000..96ee187 Binary files /dev/null and b/PDT.EssentialsPluginTemplate.EPI/NvxUrlRoutingClientEpi.projectinfo differ diff --git a/src/PDT.EssentialsPluginTemplate.EPI.csproj b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj similarity index 98% rename from src/PDT.EssentialsPluginTemplate.EPI.csproj rename to PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj index edda00c..6dd00f2 100644 --- a/src/PDT.EssentialsPluginTemplate.EPI.csproj +++ b/PDT.EssentialsPluginTemplate.EPI/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.csproj.user b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user new file mode 100644 index 0000000..9c6c209 --- /dev/null +++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user @@ -0,0 +1,5 @@ + + + E282E6BE-C7C3-4ece-916A-88FB1CF8AF3C + + \ No newline at end of file diff --git a/src/PDT.EssentialsPluginTemplate.EPI.sln b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln similarity index 97% rename from src/PDT.EssentialsPluginTemplate.EPI.sln rename to PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln index f453fd6..08ca093 100644 --- a/src/PDT.EssentialsPluginTemplate.EPI.sln +++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln @@ -1,20 +1,20 @@ - -Microsoft Visual Studio Solution File, Format Version 10.00 -# Visual Studio 2008 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PDT.EssentialsPluginTemplate.EPI", "PDT.EssentialsPluginTemplate.EPI.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal + +Microsoft Visual Studio Solution File, Format Version 10.00 +# Visual Studio 2008 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PDT.EssentialsPluginTemplate.EPI", "PDT.EssentialsPluginTemplate.EPI.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/src/PDT.EssentialsPluginTemplate.nuspec b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec similarity index 81% rename from src/PDT.EssentialsPluginTemplate.nuspec rename to PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec index e72f807..7b99bed 100644 --- a/src/PDT.EssentialsPluginTemplate.nuspec +++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec @@ -2,7 +2,6 @@ PDT.EssentialsPluginTemplate - docs\README.md 2.0.2 Essentials Plugin Template PepperDash Technologies @@ -12,12 +11,11 @@ https://github.com/PepperDash/EssentialsPluginTemplate Copyright 2022 This software iserves as a template for generating new Essentials-Compliant plugins - crestron 3series 4series essentials pepperdash pepperdashessentials epi essentials plugin + crestron 3series 4series samsung - \ No newline at end of file diff --git a/src/Properties/AssemblyInfo.cs b/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs similarity index 97% rename from src/Properties/AssemblyInfo.cs rename to PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs index 275e917..e8f1480 100644 --- a/src/Properties/AssemblyInfo.cs +++ b/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs @@ -1,8 +1,8 @@ -using System.Reflection; - -[assembly: AssemblyTitle("EssentialsPluginTemplateEpi")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("EssentialsPluginTemplateEpi")] -[assembly: AssemblyCopyright("Copyright © 2022")] -[assembly: AssemblyVersion("1.0.0.*")] - +using System.Reflection; + +[assembly: AssemblyTitle("EssentialsPluginTemplateEpi")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("EssentialsPluginTemplateEpi")] +[assembly: AssemblyCopyright("Copyright © 2022")] +[assembly: AssemblyVersion("1.0.0.*")] + diff --git a/src/Properties/ControlSystem.cfg b/PDT.EssentialsPluginTemplate.EPI/Properties/ControlSystem.cfg similarity index 100% rename from src/Properties/ControlSystem.cfg rename to PDT.EssentialsPluginTemplate.EPI/Properties/ControlSystem.cfg diff --git a/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log b/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log new file mode 100644 index 0000000..b86200d --- /dev/null +++ b/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log @@ -0,0 +1,63 @@ +8/30/2019 3:01:01 PM, Info: Initializing SIMPLSharp Services... +8/30/2019 3:01:01 PM, Info: ProjectInfo successfully initialized. +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:01:02 PM, Info: Saving project information... +8/30/2019 3:04:48 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDashEssentials.dll... +8/30/2019 3:05:10 PM, Info: Saving project information... +8/30/2019 3:05:10 PM, Info: Saving project information... +8/30/2019 3:05:10 PM, Info: Saving project information... +8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Core.dll... +8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll... +8/30/2019 3:05:40 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_DM.dll... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:24 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:06:36 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:08:54 PM, Info: Saving project information... +8/30/2019 3:09:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll... +8/30/2019 3:10:10 PM, Info: Saving project information... +8/30/2019 3:10:10 PM, Info: Saving project information... +8/30/2019 3:10:10 PM, Info: Saving project information... +8/30/2019 3:15:10 PM, Info: Saving project information... +8/30/2019 3:15:10 PM, Info: Saving project information... +8/30/2019 3:15:10 PM, Info: Saving project information... +8/30/2019 3:20:10 PM, Info: Saving project information... +8/30/2019 3:20:10 PM, Info: Saving project information... +8/30/2019 3:20:10 PM, Info: Saving project information... +8/30/2019 3:25:10 PM, Info: Saving project information... +8/30/2019 3:25:10 PM, Info: Saving project information... +8/30/2019 3:25:10 PM, Info: Saving project information... +8/30/2019 3:30:10 PM, Info: Saving project information... +8/30/2019 3:30:10 PM, Info: Saving project information... +8/30/2019 3:30:10 PM, Info: Saving project information... +8/30/2019 3:35:10 PM, Info: Saving project information... +8/30/2019 3:35:10 PM, Info: Saving project information... +8/30/2019 3:35:10 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:35:38 PM, Info: Saving project information... +8/30/2019 3:36:52 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll... +8/30/2019 3:36:52 PM, Info: Verifying assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll +8/30/2019 3:36:52 PM, Info: Creating Archive C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.cplz... +8/30/2019 3:36:53 PM, Info: Saving project information... +9/2/2019 8:34:46 AM, Info: Terminating SIMPLSharp Services diff --git a/README.md b/README.md index 458eca2..67a4614 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -![PepperDash Essentials Pluign Logo](/images/essentials-plugin-blue.png) - -# Essentials Plugin Template (c) 2023 +# Essentials Plugin Template (c) 2020 ## License @@ -31,7 +29,6 @@ The [Essentials](https://github.com/PepperDash/Essentials) libraries are require To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository: `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion`. -Alternatively, you can simply run the `GetPackages.bat` file. To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it. ### Installing Different versions of PepperDash Core @@ -40,21 +37,6 @@ If you need a different version of PepperDash Core, use the command `nuget insta ### Instructions for Renaming Solution and Files -See the Task List in Visual Studio for a guide on how to start using the template. There is extensive inline documentation and examples as well. +See the Task List in Visual Studio for a guide on how to start using the templage. There is extensive inline documentation and examples as well. For renaming instructions in particular, see the XML `remarks` tags on class definitions - -## Build Instructions (PepperDash Internal) - -## Generating Nuget Package - -In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" - -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/images/essentials-plugin-blue.png b/images/essentials-plugin-blue.png deleted file mode 100644 index c94b320..0000000 Binary files a/images/essentials-plugin-blue.png and /dev/null differ diff --git a/images/essentials-plugin-white.png b/images/essentials-plugin-white.png deleted file mode 100644 index 73d6b3f..0000000 Binary files a/images/essentials-plugin-white.png and /dev/null differ