From 46ba57bac597a06e7d7d99eb812d3838f28f6b45 Mon Sep 17 00:00:00 2001 From: Aviv Cohn Date: Thu, 10 Oct 2024 15:51:24 -0400 Subject: [PATCH 01/14] docs: Update Readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 458eca2..3e95e58 100644 --- a/README.md +++ b/README.md @@ -57,4 +57,4 @@ In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" 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 +__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 From 4fd9dd739efb1f5621011234f9df93310b8fff9c Mon Sep 17 00:00:00 2001 From: Aviv Cohn Date: Thu, 10 Oct 2024 16:33:06 -0400 Subject: [PATCH 02/14] chore: remove additional device types --- src/EssentialsPluginTemplateCrestronDevice.cs | 99 ------------------- src/EssentialsPluginTemplateLogicDevice.cs | 86 ---------------- 2 files changed, 185 deletions(-) delete mode 100644 src/EssentialsPluginTemplateCrestronDevice.cs delete mode 100644 src/EssentialsPluginTemplateLogicDevice.cs diff --git a/src/EssentialsPluginTemplateCrestronDevice.cs b/src/EssentialsPluginTemplateCrestronDevice.cs deleted file mode 100644 index 8836cc5..0000000 --- a/src/EssentialsPluginTemplateCrestronDevice.cs +++ /dev/null @@ -1,99 +0,0 @@ -// For Basic SIMPL# Classes -// For Basic SIMPL#Pro classes - -using Crestron.SimplSharpPro.DeviceSupport; -using Crestron.SimplSharpPro; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device - /// - /// - /// Rename the class to match the device plugin being developed. - /// - /// - /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" - /// - public class EssentialsPluginTemplateCrestronDevice : CrestronGenericBridgeableBaseDevice - { - /// - /// It is often desirable to store the config - /// - private EssentialsPluginTemplateConfigObject _config; - - - #region Constructor for Devices without IBasicCommunication. Remove if not needed - /// - /// Plugin device constructor for Crestron devices - /// - /// - /// - /// - /// - public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginTemplateConfigObject config, GenericBase hardware) - : base(key, name, hardware) - { - Debug.Console(0, this, "Constructing new {0} instance", name); - - // The base class takes care of registering the hardware device for you - - // TODO [ ] Update the constructor as needed for the plugin device being developed - - _config = config; - } - - #endregion - - - #region Overrides of EssentialsBridgeableDevice - - /// - /// Links the plugin device to the EISC bridge - /// - /// - /// - /// - /// - public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) - { - var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); - - // This adds the join map to the collection on the bridge - if (bridge != null) - { - bridge.AddJoinMap(Key, joinMap); - } - - var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); - - if (customJoins != null) - { - joinMap.SetCustomJoinData(customJoins); - } - - Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); - Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); - - // TODO [ ] Implement bridge links as needed - - // links to bridge - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - - trilist.OnlineStatusChange += (o, a) => - { - if (!a.DeviceOnLine) return; - - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - }; - } - - - #endregion - - } -} - diff --git a/src/EssentialsPluginTemplateLogicDevice.cs b/src/EssentialsPluginTemplateLogicDevice.cs deleted file mode 100644 index 0685a43..0000000 --- a/src/EssentialsPluginTemplateLogicDevice.cs +++ /dev/null @@ -1,86 +0,0 @@ -using Crestron.SimplSharpPro.DeviceSupport; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device template for logic devices that don't communicate outside the program - /// - /// - /// Rename the class to match the device plugin being developed. - /// - /// - /// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice" - /// - public class EssentialsPluginTemplateLogicDevice : EssentialsBridgeableDevice - { - /// - /// It is often desirable to store the config - /// - private EssentialsPluginTemplateConfigObject _config; - - /// - /// Plugin device constructor - /// - /// - /// - /// - public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginTemplateConfigObject config) - : base(key, name) - { - Debug.Console(0, this, "Constructing new {0} instance", name); - - // TODO [ ] Update the constructor as needed for the plugin device being developed - - _config = config; - } - - #region Overrides of EssentialsBridgeableDevice - - /// - /// Links the plugin device to the EISC bridge - /// - /// - /// - /// - /// - public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) - { - var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); - - // This adds the join map to the collection on the bridge - if (bridge != null) - { - bridge.AddJoinMap(Key, joinMap); - } - - var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); - - if (customJoins != null) - { - joinMap.SetCustomJoinData(customJoins); - } - - Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); - Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); - - // TODO [ ] Implement bridge links as needed - - // links to bridge - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - - trilist.OnlineStatusChange += (o, a) => - { - if (!a.DeviceOnLine) return; - - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - }; - } - - #endregion - - } -} - From 45f5bfb8efcd37aad57fb808a89509375fd891d7 Mon Sep 17 00:00:00 2001 From: Aviv Cohn Date: Thu, 10 Oct 2024 16:34:13 -0400 Subject: [PATCH 03/14] feat: use updated string format method --- src/EssentialsPluginTemplateDevice.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/EssentialsPluginTemplateDevice.cs b/src/EssentialsPluginTemplateDevice.cs index b6d2031..940a4ac 100644 --- a/src/EssentialsPluginTemplateDevice.cs +++ b/src/EssentialsPluginTemplateDevice.cs @@ -199,7 +199,7 @@ namespace EssentialsPluginTemplate { if (string.IsNullOrEmpty(text)) return; - _comms.SendText(string.Format("{0}{1}", text, CommsDelimiter)); + _comms.SendText($"{text}{CommsDelimiter}"); } // TODO [ ] If not using an HEX/byte based API, delete the properties below From 788bbd2c6def69612283f364e0370021cc75a2f2 Mon Sep 17 00:00:00 2001 From: Aviv Cohn Date: Thu, 10 Oct 2024 16:55:13 -0400 Subject: [PATCH 04/14] feat: remove non-xml commentary for readability --- src/EssentialsPluginTemplateDevice.cs | 65 +++++---------------------- 1 file changed, 11 insertions(+), 54 deletions(-) diff --git a/src/EssentialsPluginTemplateDevice.cs b/src/EssentialsPluginTemplateDevice.cs index 940a4ac..8ccafee 100644 --- a/src/EssentialsPluginTemplateDevice.cs +++ b/src/EssentialsPluginTemplateDevice.cs @@ -1,7 +1,4 @@ -// For Basic SIMPL# Classes -// For Basic SIMPL#Pro classes - -using Crestron.SimplSharpPro.DeviceSupport; +using Crestron.SimplSharpPro.DeviceSupport; using PepperDash.Core; using PepperDash.Essentials.Core; using PepperDash.Essentials.Core.Bridges; @@ -21,9 +18,6 @@ namespace EssentialsPluginTemplate /// public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice { - /// - /// It is often desirable to store the config - /// private EssentialsPluginTemplateConfigObject _config; /// @@ -33,21 +27,14 @@ namespace EssentialsPluginTemplate #region IBasicCommunication Properties and Constructor. Remove if not needed. - // TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed private readonly IBasicCommunication _comms; private readonly GenericCommunicationMonitor _commsMonitor; - - // _comms gather for ASCII based API's - // TODO [ ] If not using an ASCII based API, delete the properties below private readonly CommunicationGather _commsGather; /// /// Set this value to that of the delimiter used by the API (if applicable) /// private const string CommsDelimiter = "\r"; - - // _comms byte buffer for HEX/byte based API's - // TODO [ ] If not using an HEX/byte based API, delete the properties below private byte[] _commsByteBuffer = { }; @@ -103,11 +90,9 @@ namespace EssentialsPluginTemplate { 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. + ReceiveQueue = new GenericQueue(key + "-rxqueue"); ConnectFeedback = new BoolFeedback(() => Connect); OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline); @@ -119,26 +104,15 @@ namespace EssentialsPluginTemplate 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 @@ -154,26 +128,18 @@ namespace EssentialsPluginTemplate 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(); } @@ -183,26 +149,23 @@ namespace EssentialsPluginTemplate /// void ProcessFeedbackMessage(string message) { - + throw new System.NotImplementedException(); } - - // TODO [ ] If not using an ACII based API, delete the properties below - /// - /// Sends text to the device plugin comms - /// - /// - /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands - /// - /// Command to be sent - public void SendText(string text) + /// + /// Sends text to the device plugin comms + /// + /// + /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands + /// + /// Command to be sent + public void SendText(string text) { if (string.IsNullOrEmpty(text)) return; _comms.SendText($"{text}{CommsDelimiter}"); } - // TODO [ ] If not using an HEX/byte based API, delete the properties below /// /// Sends bytes to the device plugin comms /// @@ -225,8 +188,6 @@ namespace EssentialsPluginTemplate /// public void Poll() { - // TODO [ ] Update Poll method as needed for the plugin being developed - // Example: SendText("getstatus"); throw new System.NotImplementedException(); } @@ -246,7 +207,6 @@ namespace EssentialsPluginTemplate { var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); - // This adds the join map to the collection on the bridge if (bridge != null) { bridge.AddJoinMap(Key, joinMap); @@ -262,9 +222,7 @@ namespace EssentialsPluginTemplate 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); @@ -286,7 +244,6 @@ namespace EssentialsPluginTemplate private void UpdateFeedbacks() { - // TODO [ ] Update as needed for the plugin being developed ConnectFeedback.FireUpdate(); OnlineFeedback.FireUpdate(); StatusFeedback.FireUpdate(); From 85d2e4e1dc461c038d60113e4fc5ffe63c957b00 Mon Sep 17 00:00:00 2001 From: jdevito Date: Thu, 30 Jan 2025 16:39:56 -0600 Subject: [PATCH 05/14] fix: update template repo 1. update workflow files 2. Add 3-series SLN and csproj files - Remove from project when using the template if not needed 3. Update 4-series SLN and csproj files 4. Moved SLN's to root of project 5. Rename *.cs files to identify naming convention of 'MakeModel' 6. Upate packages.config to reference latest Essentials v1 release --- .../EssentialsPlugins-builds-caller.yml | 2 + epi-make-model.3Series.sln | 20 + ....4Series.sln => epi-make-model.4Series.sln | 2 +- packages.config | 2 +- src/Directory.Build.props | 2 +- ...geJoinMap.cs => MakeModelBridgeJoinMap.cs} | 200 +++--- ...nfigObject.cs => MakeModelConfigObject.cs} | 10 +- ...onDevice.cs => MakeModelCrestronDevice.cs} | 18 +- ...inTemplateDevice.cs => MakeModelDevice.cs} | 597 +++++++++--------- ...TemplateFactory.cs => MakeModelFactory.cs} | 12 +- ...LogicDevice.cs => MakeModelLogicDevice.cs} | 12 +- src/PDT.EssentialsPluginTemplate.nuspec | 23 - ...I.csproj => epi-make-model.3Series.csproj} | 228 +++---- .....csproj => epi-make-model.4Series.csproj} | 24 +- 14 files changed, 579 insertions(+), 573 deletions(-) create mode 100644 epi-make-model.3Series.sln rename PDT.EssentialsPluginTemplate.EPI.4Series.sln => epi-make-model.4Series.sln (83%) rename src/{EssentialsPluginTemplateBridgeJoinMap.cs => MakeModelBridgeJoinMap.cs} (94%) rename src/{EssentialsPluginTemplateConfigObject.cs => MakeModelConfigObject.cs} (99%) rename src/{EssentialsPluginTemplateCrestronDevice.cs => MakeModelCrestronDevice.cs} (98%) rename src/{EssentialsPluginTemplateDevice.cs => MakeModelDevice.cs} (96%) rename src/{EssentialsPluginTemplateFactory.cs => MakeModelFactory.cs} (99%) rename src/{EssentialsPluginTemplateLogicDevice.cs => MakeModelLogicDevice.cs} (98%) delete mode 100644 src/PDT.EssentialsPluginTemplate.nuspec rename src/{PDT.EssentialsPluginTemplate.EPI.csproj => epi-make-model.3Series.csproj} (82%) rename src/{PDT.EssentialsPluginTemplate.EPI.4Series..csproj => epi-make-model.4Series.csproj} (67%) diff --git a/.github/workflows/EssentialsPlugins-builds-caller.yml b/.github/workflows/EssentialsPlugins-builds-caller.yml index 6d9f244..63a2fcd 100644 --- a/.github/workflows/EssentialsPlugins-builds-caller.yml +++ b/.github/workflows/EssentialsPlugins-builds-caller.yml @@ -9,6 +9,7 @@ jobs: getVersion: uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-getversion.yml@main secrets: inherit + build-3Series: uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-3Series-builds.yml@main secrets: inherit @@ -19,6 +20,7 @@ jobs: version: ${{ needs.getVersion.outputs.version }} tag: ${{ needs.getVersion.outputs.tag }} channel: ${{ needs.getVersion.outputs.channel }} + build-4Series: uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-4Series-builds.yml@main secrets: inherit diff --git a/epi-make-model.3Series.sln b/epi-make-model.3Series.sln new file mode 100644 index 0000000..b106642 --- /dev/null +++ b/epi-make-model.3Series.sln @@ -0,0 +1,20 @@ + +Microsoft Visual Studio Solution File, Format Version 10.00 +# Visual Studio 2008 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "epi-make-model.3Series", "src\epi-make-model.3Series.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/PDT.EssentialsPluginTemplate.EPI.4Series.sln b/epi-make-model.4Series.sln similarity index 83% rename from PDT.EssentialsPluginTemplate.EPI.4Series.sln rename to epi-make-model.4Series.sln index af0013f..e073161 100644 --- a/PDT.EssentialsPluginTemplate.EPI.4Series.sln +++ b/epi-make-model.4Series.sln @@ -3,7 +3,7 @@ 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}") = "PDT.EssentialsPluginTemplate.EPI.4Series.", "src\PDT.EssentialsPluginTemplate.EPI.4Series..csproj", "{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}" +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 diff --git a/packages.config b/packages.config index 2a12f4c..c0df495 100644 --- a/packages.config +++ b/packages.config @@ -1,3 +1,3 @@ - + \ No newline at end of file diff --git a/src/Directory.Build.props b/src/Directory.Build.props index ef365ad..db59da5 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -5,7 +5,7 @@ PepperDash Technologies PepperDash Technologies PepperDash Essentials Plugin Template - Copyright © 2024 + Copyright © 2025 https://github.com/PepperDash/EssentialsPluginTemplate.git git Crestron; 4series diff --git a/src/EssentialsPluginTemplateBridgeJoinMap.cs b/src/MakeModelBridgeJoinMap.cs similarity index 94% rename from src/EssentialsPluginTemplateBridgeJoinMap.cs rename to src/MakeModelBridgeJoinMap.cs index 140d021..0d20a8f 100644 --- a/src/EssentialsPluginTemplateBridgeJoinMap.cs +++ b/src/MakeModelBridgeJoinMap.cs @@ -1,101 +1,101 @@ -using PepperDash.Essentials.Core; - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device Bridge Join Map - /// - /// - /// Rename the class to match the device plugin being developed. Reference Essentials JoinMaps, if one exists for the device plugin being developed - /// - /// - /// - /// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap" - /// - 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 - - /// - /// Plugin device BridgeJoinMap constructor - /// - /// This will be the join it starts on the EISC bridge - public EssentialsPluginTemplateBridgeJoinMap(uint joinStart) - : base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap)) - { - } - } +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin +{ + /// + /// Plugin device Bridge Join Map + /// + /// + /// Rename the class to match the device plugin being developed. Reference Essentials JoinMaps, if one exists for the device plugin being developed + /// + /// + /// + /// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap" + /// + 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 + + /// + /// Plugin device BridgeJoinMap constructor + /// + /// This will be the join it starts on the EISC bridge + public EssentialsPluginTemplateBridgeJoinMap(uint joinStart) + : base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap)) + { + } + } } \ No newline at end of file diff --git a/src/EssentialsPluginTemplateConfigObject.cs b/src/MakeModelConfigObject.cs similarity index 99% rename from src/EssentialsPluginTemplateConfigObject.cs rename to src/MakeModelConfigObject.cs index e216796..b247414 100644 --- a/src/EssentialsPluginTemplateConfigObject.cs +++ b/src/MakeModelConfigObject.cs @@ -1,8 +1,8 @@ -using System.Collections.Generic; -using Newtonsoft.Json; -using PepperDash.Essentials.Core; - -namespace EssentialsPluginTemplate +using System.Collections.Generic; +using Newtonsoft.Json; +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin { /// /// Plugin device configuration object diff --git a/src/EssentialsPluginTemplateCrestronDevice.cs b/src/MakeModelCrestronDevice.cs similarity index 98% rename from src/EssentialsPluginTemplateCrestronDevice.cs rename to src/MakeModelCrestronDevice.cs index 8836cc5..71c91c1 100644 --- a/src/EssentialsPluginTemplateCrestronDevice.cs +++ b/src/MakeModelCrestronDevice.cs @@ -1,13 +1,13 @@ // For Basic SIMPL# Classes -// For Basic SIMPL#Pro classes - -using Crestron.SimplSharpPro.DeviceSupport; -using Crestron.SimplSharpPro; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; - -namespace EssentialsPluginTemplate +// For Basic SIMPL#Pro classes + +using Crestron.SimplSharpPro; +using Crestron.SimplSharpPro.DeviceSupport; +using PepperDash.Core; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; + +namespace PepperDash.Essentials.Plugin { /// /// Plugin device diff --git a/src/EssentialsPluginTemplateDevice.cs b/src/MakeModelDevice.cs similarity index 96% rename from src/EssentialsPluginTemplateDevice.cs rename to src/MakeModelDevice.cs index b6d2031..da423a2 100644 --- a/src/EssentialsPluginTemplateDevice.cs +++ b/src/MakeModelDevice.cs @@ -1,299 +1,298 @@ -// For Basic SIMPL# Classes -// For Basic SIMPL#Pro classes - -using Crestron.SimplSharpPro.DeviceSupport; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; -using PepperDash.Essentials.Core.Queues; - - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device template for third party devices that use IBasicCommunication - /// - /// - /// Rename the class to match the device plugin being developed. - /// - /// - /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" - /// - public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice - { - /// - /// It is often desirable to store the config - /// - private EssentialsPluginTemplateConfigObject _config; - - /// - /// Provides a queue and dedicated worker thread for processing feedback messages from a device. - /// - private GenericQueue ReceiveQueue; - - #region IBasicCommunication Properties and Constructor. Remove if not needed. - - // TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed - private readonly IBasicCommunication _comms; - private readonly GenericCommunicationMonitor _commsMonitor; - - // _comms gather for ASCII based API's - // TODO [ ] If not using an ASCII based API, delete the properties below - private readonly CommunicationGather _commsGather; - - /// - /// Set this value to that of the delimiter used by the API (if applicable) - /// - private const string CommsDelimiter = "\r"; - - // _comms byte buffer for HEX/byte based API's - // TODO [ ] If not using an HEX/byte based API, delete the properties below - private byte[] _commsByteBuffer = { }; - - - - /// - /// Connects/disconnects the comms of the plugin device - /// - /// - /// triggers the _comms.Connect/Disconnect as well as thee comms monitor start/stop - /// - public bool Connect - { - get { return _comms.IsConnected; } - set - { - if (value) - { - _comms.Connect(); - _commsMonitor.Start(); - } - else - { - _comms.Disconnect(); - _commsMonitor.Stop(); - } - } - } - - /// - /// Reports connect feedback through the bridge - /// - public BoolFeedback ConnectFeedback { get; private set; } - - /// - /// Reports online feedback through the bridge - /// - public BoolFeedback OnlineFeedback { get; private set; } - - /// - /// Reports socket status feedback through the bridge - /// - public IntFeedback StatusFeedback { get; private set; } - - /// - /// Plugin device constructor for devices that need IBasicCommunication - /// - /// - /// - /// - /// - public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) - : base(key, name) - { - Debug.Console(0, this, "Constructing new {0} instance", name); - - // TODO [ ] Update the constructor as needed for the plugin device being developed - - _config = config; - - ReceiveQueue = new GenericQueue(key + "-rxqueue"); // If you need to set the thread priority, use one of the available overloaded constructors. - - ConnectFeedback = new BoolFeedback(() => Connect); - OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline); - StatusFeedback = new IntFeedback(() => (int)_commsMonitor.Status); - - _comms = comms; - _commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll); - - var socket = _comms as ISocketStatus; - if (socket != null) - { - // device comms is IP **ELSE** device comms is RS232 - socket.ConnectionChange += socket_ConnectionChange; - Connect = true; - } - - #region Communication data event handlers. Comment out any that don't apply to the API type - - // Only one of the below handlers should be necessary. - - // _comms gather for any API that has a defined delimiter - // TODO [ ] If not using an ASCII based API, remove the line below - _commsGather = new CommunicationGather(_comms, CommsDelimiter); - _commsGather.LineReceived += Handle_LineRecieved; - - // _comms byte buffer for HEX/byte based API's with no delimiter - // TODO [ ] If not using an HEX/byte based API, remove the line below - _comms.BytesReceived += Handle_BytesReceived; - - // _comms byte buffer for HEX/byte based API's with no delimiter - // TODO [ ] If not using an HEX/byte based API, remove the line below - _comms.TextReceived += Handle_TextReceived; - - #endregion - } - - - private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) - { - if (ConnectFeedback != null) - ConnectFeedback.FireUpdate(); - - if (StatusFeedback != null) - StatusFeedback.FireUpdate(); - } - - // TODO [ ] If not using an API with a delimeter, delete the method below - private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args) - { - // TODO [ ] Implement method - - // Enqueues the message to be processed in a dedicated thread, but the specified method - ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage)); - } - - // TODO [ ] If not using an HEX/byte based API with no delimeter, delete the method below - private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args) - { - // TODO [ ] Implement method - throw new System.NotImplementedException(); - } - - // TODO [ ] If not using an ASCII based API with no delimeter, delete the method below - void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e) - { - // TODO [ ] Implement method - throw new System.NotImplementedException(); - } - - /// - /// This method should perform any necessary parsing of feedback messages from the device - /// - /// - void ProcessFeedbackMessage(string message) - { - - } - - - // TODO [ ] If not using an ACII based API, delete the properties below - /// - /// Sends text to the device plugin comms - /// - /// - /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands - /// - /// Command to be sent - public void SendText(string text) - { - if (string.IsNullOrEmpty(text)) return; - - _comms.SendText(string.Format("{0}{1}", text, CommsDelimiter)); - } - - // TODO [ ] If not using an HEX/byte based API, delete the properties below - /// - /// Sends bytes to the device plugin comms - /// - /// - /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands - /// - /// Bytes to be sent - public void SendBytes(byte[] bytes) - { - if (bytes == null) return; - - _comms.SendBytes(bytes); - } - - /// - /// Polls the device - /// - /// - /// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed - /// - public void Poll() - { - // TODO [ ] Update Poll method as needed for the plugin being developed - // Example: SendText("getstatus"); - throw new System.NotImplementedException(); - } - - #endregion - - - #region Overrides of EssentialsBridgeableDevice - - /// - /// Links the plugin device to the EISC bridge - /// - /// - /// - /// - /// - public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) - { - var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); - - // This adds the join map to the collection on the bridge - if (bridge != null) - { - bridge.AddJoinMap(Key, joinMap); - } - - var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); - - if (customJoins != null) - { - joinMap.SetCustomJoinData(customJoins); - } - - Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); - Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); - - // TODO [ ] Implement bridge links as needed - - // links to bridge - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - - trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig); - ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]); - - StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]); - OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]); - - UpdateFeedbacks(); - - trilist.OnlineStatusChange += (o, a) => - { - if (!a.DeviceOnLine) return; - - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - UpdateFeedbacks(); - }; - } - - private void UpdateFeedbacks() - { - // TODO [ ] Update as needed for the plugin being developed - ConnectFeedback.FireUpdate(); - OnlineFeedback.FireUpdate(); - StatusFeedback.FireUpdate(); - } - - #endregion - - } -} - +// 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 +{ + /// + /// Plugin device template for third party devices that use IBasicCommunication + /// + /// + /// Rename the class to match the device plugin being developed. + /// + /// + /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" + /// + public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice + { + /// + /// It is often desirable to store the config + /// + private EssentialsPluginTemplateConfigObject _config; + + /// + /// Provides a queue and dedicated worker thread for processing feedback messages from a device. + /// + private GenericQueue ReceiveQueue; + + #region IBasicCommunication Properties and Constructor. Remove if not needed. + + // TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed + private readonly IBasicCommunication _comms; + private readonly GenericCommunicationMonitor _commsMonitor; + + // _comms gather for ASCII based API's + // TODO [ ] If not using an ASCII based API, delete the properties below + private readonly CommunicationGather _commsGather; + + /// + /// Set this value to that of the delimiter used by the API (if applicable) + /// + private const string CommsDelimiter = "\r"; + + // _comms byte buffer for HEX/byte based API's + // TODO [ ] If not using an HEX/byte based API, delete the properties below + private byte[] _commsByteBuffer = { }; + + + + /// + /// Connects/disconnects the comms of the plugin device + /// + /// + /// triggers the _comms.Connect/Disconnect as well as thee comms monitor start/stop + /// + public bool Connect + { + get { return _comms.IsConnected; } + set + { + if (value) + { + _comms.Connect(); + _commsMonitor.Start(); + } + else + { + _comms.Disconnect(); + _commsMonitor.Stop(); + } + } + } + + /// + /// Reports connect feedback through the bridge + /// + public BoolFeedback ConnectFeedback { get; private set; } + + /// + /// Reports online feedback through the bridge + /// + public BoolFeedback OnlineFeedback { get; private set; } + + /// + /// Reports socket status feedback through the bridge + /// + public IntFeedback StatusFeedback { get; private set; } + + /// + /// Plugin device constructor for devices that need IBasicCommunication + /// + /// + /// + /// + /// + public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) + : base(key, name) + { + Debug.Console(0, this, "Constructing new {0} instance", name); + + // TODO [ ] Update the constructor as needed for the plugin device being developed + + _config = config; + + ReceiveQueue = new GenericQueue(key + "-rxqueue"); // If you need to set the thread priority, use one of the available overloaded constructors. + + ConnectFeedback = new BoolFeedback(() => Connect); + OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline); + StatusFeedback = new IntFeedback(() => (int)_commsMonitor.Status); + + _comms = comms; + _commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll); + + var socket = _comms as ISocketStatus; + if (socket != null) + { + // device comms is IP **ELSE** device comms is RS232 + socket.ConnectionChange += socket_ConnectionChange; + Connect = true; + } + + #region Communication data event handlers. Comment out any that don't apply to the API type + + // Only one of the below handlers should be necessary. + + // _comms gather for any API that has a defined delimiter + // TODO [ ] If not using an ASCII based API, remove the line below + _commsGather = new CommunicationGather(_comms, CommsDelimiter); + _commsGather.LineReceived += Handle_LineRecieved; + + // _comms byte buffer for HEX/byte based API's with no delimiter + // TODO [ ] If not using an HEX/byte based API, remove the line below + _comms.BytesReceived += Handle_BytesReceived; + + // _comms byte buffer for HEX/byte based API's with no delimiter + // TODO [ ] If not using an HEX/byte based API, remove the line below + _comms.TextReceived += Handle_TextReceived; + + #endregion + } + + + private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) + { + if (ConnectFeedback != null) + ConnectFeedback.FireUpdate(); + + if (StatusFeedback != null) + StatusFeedback.FireUpdate(); + } + + // TODO [ ] If not using an API with a delimeter, delete the method below + private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args) + { + // TODO [ ] Implement method + + // Enqueues the message to be processed in a dedicated thread, but the specified method + ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage)); + } + + // TODO [ ] If not using an HEX/byte based API with no delimeter, delete the method below + private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args) + { + // TODO [ ] Implement method + throw new System.NotImplementedException(); + } + + // TODO [ ] If not using an ASCII based API with no delimeter, delete the method below + void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e) + { + // TODO [ ] Implement method + throw new System.NotImplementedException(); + } + + /// + /// This method should perform any necessary parsing of feedback messages from the device + /// + /// + void ProcessFeedbackMessage(string message) + { + + } + + + // TODO [ ] If not using an ACII based API, delete the properties below + /// + /// Sends text to the device plugin comms + /// + /// + /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands + /// + /// Command to be sent + public void SendText(string text) + { + if (string.IsNullOrEmpty(text)) return; + + _comms.SendText(string.Format("{0}{1}", text, CommsDelimiter)); + } + + // TODO [ ] If not using an HEX/byte based API, delete the properties below + /// + /// Sends bytes to the device plugin comms + /// + /// + /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands + /// + /// Bytes to be sent + public void SendBytes(byte[] bytes) + { + if (bytes == null) return; + + _comms.SendBytes(bytes); + } + + /// + /// Polls the device + /// + /// + /// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed + /// + public void Poll() + { + // TODO [ ] Update Poll method as needed for the plugin being developed + // Example: SendText("getstatus"); + throw new System.NotImplementedException(); + } + + #endregion + + + #region Overrides of EssentialsBridgeableDevice + + /// + /// Links the plugin device to the EISC bridge + /// + /// + /// + /// + /// + public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) + { + var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); + + // This adds the join map to the collection on the bridge + if (bridge != null) + { + bridge.AddJoinMap(Key, joinMap); + } + + var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); + + if (customJoins != null) + { + joinMap.SetCustomJoinData(customJoins); + } + + Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); + Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); + + // TODO [ ] Implement bridge links as needed + + // links to bridge + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + + trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig); + ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]); + + StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]); + OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]); + + UpdateFeedbacks(); + + trilist.OnlineStatusChange += (o, a) => + { + if (!a.DeviceOnLine) return; + + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + UpdateFeedbacks(); + }; + } + + private void UpdateFeedbacks() + { + // TODO [ ] Update as needed for the plugin being developed + ConnectFeedback.FireUpdate(); + OnlineFeedback.FireUpdate(); + StatusFeedback.FireUpdate(); + } + + #endregion + + } +} + diff --git a/src/EssentialsPluginTemplateFactory.cs b/src/MakeModelFactory.cs similarity index 99% rename from src/EssentialsPluginTemplateFactory.cs rename to src/MakeModelFactory.cs index 0b58f52..e94994a 100644 --- a/src/EssentialsPluginTemplateFactory.cs +++ b/src/MakeModelFactory.cs @@ -1,9 +1,9 @@ -using System.Collections.Generic; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using Crestron.SimplSharpPro.UI; - -namespace EssentialsPluginTemplate +using System.Collections.Generic; +using Crestron.SimplSharpPro.UI; +using PepperDash.Core; +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin { /// /// Plugin device factory for devices that use IBasicCommunication diff --git a/src/EssentialsPluginTemplateLogicDevice.cs b/src/MakeModelLogicDevice.cs similarity index 98% rename from src/EssentialsPluginTemplateLogicDevice.cs rename to src/MakeModelLogicDevice.cs index 0685a43..44aeeec 100644 --- a/src/EssentialsPluginTemplateLogicDevice.cs +++ b/src/MakeModelLogicDevice.cs @@ -1,9 +1,9 @@ -using Crestron.SimplSharpPro.DeviceSupport; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; - -namespace EssentialsPluginTemplate +using Crestron.SimplSharpPro.DeviceSupport; +using PepperDash.Core; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; + +namespace PepperDash.Essentials.Plugin { /// /// Plugin device template for logic devices that don't communicate outside the program diff --git a/src/PDT.EssentialsPluginTemplate.nuspec b/src/PDT.EssentialsPluginTemplate.nuspec deleted file mode 100644 index e72f807..0000000 --- a/src/PDT.EssentialsPluginTemplate.nuspec +++ /dev/null @@ -1,23 +0,0 @@ - - - - PDT.EssentialsPluginTemplate - docs\README.md - 2.0.2 - Essentials Plugin Template - PepperDash Technologies - pepperdash - false - MIT - https://github.com/PepperDash/EssentialsPluginTemplate - Copyright 2022 - This software iserves as a template for generating new Essentials-Compliant plugins - crestron 3series 4series essentials pepperdash pepperdashessentials epi essentials plugin - - - - - - - - \ No newline at end of file diff --git a/src/PDT.EssentialsPluginTemplate.EPI.csproj b/src/epi-make-model.3Series.csproj similarity index 82% rename from src/PDT.EssentialsPluginTemplate.EPI.csproj rename to src/epi-make-model.3Series.csproj index edda00c..03aa3ce 100644 --- a/src/PDT.EssentialsPluginTemplate.EPI.csproj +++ b/src/epi-make-model.3Series.csproj @@ -1,115 +1,115 @@ - - - Release - AnyCPU - 9.0.30729 - 2.0 - {9D249E47-8F95-4437-A6BB-563510287AD1} - Library - Properties - PDT.EssentialsPluginTemplate.EPI - PDT.EssentialsPluginTemplate.EPI - {0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} - WindowsCE - E2BECB1F-8C8C-41ba-B736-9BE7D946A398 - 5.0 - SmartDeviceProject1 - v3.5 - Windows CE - - - - - .allowedReferenceRelatedFileExtensions - true - full - false - bin\Debug\ - DEBUG;TRACE; - prompt - 4 - 512 - true - true - off - - - .allowedReferenceRelatedFileExtensions - none - true - bin\Release\ - prompt - 4 - 512 - true - true - off - - - - False - ..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll - - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll - - - - - - - - - - - - - - - - - - rem S# Pro preparation will execute after these operations - + + + Release + AnyCPU + 9.0.30729 + 2.0 + {9D249E47-8F95-4437-A6BB-563510287AD1} + Library + Properties + PepperDash.Essentials.Plugin + MakeModelPlugin + {0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} + WindowsCE + E2BECB1F-8C8C-41ba-B736-9BE7D946A398 + 5.0 + SmartDeviceProject1 + v3.5 + Windows CE + + + + + .allowedReferenceRelatedFileExtensions + true + full + false + bin\Debug\ + DEBUG;TRACE; + prompt + 4 + 512 + true + true + off + + + .allowedReferenceRelatedFileExtensions + none + true + bin\Release\ + prompt + 4 + 512 + true + true + off + + + + False + C:\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll + + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll + + + False + C:\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll + False + + + False + C:\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll + False + + + False + C:\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll + + + False + C:\ProgramData\Crestron\SDK\SimplSharpPro.exe + False + + + False + C:\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll + + + + + + + + + + + + + + + + + + rem S# Pro preparation will execute after these operations + \ No newline at end of file diff --git a/src/PDT.EssentialsPluginTemplate.EPI.4Series..csproj b/src/epi-make-model.4Series.csproj similarity index 67% rename from src/PDT.EssentialsPluginTemplate.EPI.4Series..csproj rename to src/epi-make-model.4Series.csproj index 1f930c1..59740a8 100644 --- a/src/PDT.EssentialsPluginTemplate.EPI.4Series..csproj +++ b/src/epi-make-model.4Series.csproj @@ -4,12 +4,12 @@ net472 - PDT.EssentialsPluginTemplate.EPI + PepperDash.Essentials.Plugin false - PDT.EssentialsPluginTemplate.EPI + PepperDash.Essentials.Plugin.Make.Model PepperDash Technologies This software is a template for a PepperDash Essentials Plugin. - Copyright 2024 + Copyright 2025 1.0.0-local true $(Version) @@ -31,10 +31,18 @@ - - + + - - - + + + + + + + + + + + \ No newline at end of file From eee7822de0d3cada3a0a534cf91cced3fda9b83b Mon Sep 17 00:00:00 2001 From: jdevito Date: Fri, 31 Jan 2025 08:23:32 -0600 Subject: [PATCH 06/14] feat: add updatedoc caller --- .../essentialsplugins-updatereadme-caller.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/workflows/essentialsplugins-updatereadme-caller.yml diff --git a/.github/workflows/essentialsplugins-updatereadme-caller.yml b/.github/workflows/essentialsplugins-updatereadme-caller.yml new file mode 100644 index 0000000..e3680bd --- /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@development + with: + target-branch: ${{ github.ref_name }} + From 61b8c51db2f64f81c00c1b860c910aee58dcc696 Mon Sep 17 00:00:00 2001 From: jdevito Date: Fri, 31 Jan 2025 08:23:54 -0600 Subject: [PATCH 07/14] chore: remove deleted file reference --- .github/workflows/EssentialsPlugins-builds-caller.yml | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/.github/workflows/EssentialsPlugins-builds-caller.yml b/.github/workflows/EssentialsPlugins-builds-caller.yml index 63a2fcd..606fcb9 100644 --- a/.github/workflows/EssentialsPlugins-builds-caller.yml +++ b/.github/workflows/EssentialsPlugins-builds-caller.yml @@ -10,17 +10,6 @@ jobs: uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-getversion.yml@main secrets: inherit - build-3Series: - uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-3Series-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 }} - build-4Series: uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-4Series-builds.yml@main secrets: inherit From 3f2ef8087761778d2372e1a711be640b40053b08 Mon Sep 17 00:00:00 2001 From: Jason DeVito Date: Tue, 25 Mar 2025 10:53:56 -0500 Subject: [PATCH 08/14] Update epi-make-model.4Series.csproj Update 4Series.csproj to exlcude assets and change local bid output path. --- src/epi-make-model.4Series.csproj | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/epi-make-model.4Series.csproj b/src/epi-make-model.4Series.csproj index 59740a8..3f7a307 100644 --- a/src/epi-make-model.4Series.csproj +++ b/src/epi-make-model.4Series.csproj @@ -13,7 +13,7 @@ 1.0.0-local true $(Version) - 4Series\bin\$(Configuration)\ + bin\$(Configuration)\ PepperDash Technologies Pepperdash.Essentials.Plugins.Template https://github.com/PepperDash/EssentialsPluginTemplate.git @@ -35,7 +35,9 @@ - + + runtime + @@ -45,4 +47,4 @@ - \ No newline at end of file + From c225184021e621fd8c3b4cbd5d688f71c18ad256 Mon Sep 17 00:00:00 2001 From: Jason T Alborough Date: Tue, 25 Mar 2025 16:43:00 -0400 Subject: [PATCH 09/14] Rename releaserc.json to .releaserc.json --- releaserc.json => .releaserc.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename releaserc.json => .releaserc.json (99%) diff --git a/releaserc.json b/.releaserc.json similarity index 99% rename from releaserc.json rename to .releaserc.json index c4bd268..e6ec36a 100644 --- a/releaserc.json +++ b/.releaserc.json @@ -31,4 +31,4 @@ "channel": "replace-me-prerelease" } ] -} \ No newline at end of file +} From 952d5b61a4b629b65a44cde876257b6457c09db6 Mon Sep 17 00:00:00 2001 From: Jason DeVito Date: Tue, 25 Mar 2025 15:54:31 -0500 Subject: [PATCH 10/14] Update epi-make-model.4Series.csproj Update PepperDash Essentials version to 2.0.0 --- src/epi-make-model.4Series.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/epi-make-model.4Series.csproj b/src/epi-make-model.4Series.csproj index 3f7a307..929c2aa 100644 --- a/src/epi-make-model.4Series.csproj +++ b/src/epi-make-model.4Series.csproj @@ -35,7 +35,7 @@ - + runtime From 4283fb2abd9d34f26a9b29e035ed3f7a54f459f4 Mon Sep 17 00:00:00 2001 From: Jonathan Arndt Date: Wed, 21 May 2025 09:31:49 -0700 Subject: [PATCH 11/14] fix: Update README workflow to use main branch and correct author/company names in Directory.Build.props --- .github/workflows/essentialsplugins-updatereadme-caller.yml | 2 +- src/Directory.Build.props | 6 +++--- src/epi-make-model.4Series.csproj | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/essentialsplugins-updatereadme-caller.yml b/.github/workflows/essentialsplugins-updatereadme-caller.yml index e3680bd..8f4bbe3 100644 --- a/.github/workflows/essentialsplugins-updatereadme-caller.yml +++ b/.github/workflows/essentialsplugins-updatereadme-caller.yml @@ -8,7 +8,7 @@ on: jobs: call-update-readme: - uses: PepperDash/workflow-templates/.github/workflows/update-readme.yml@development + uses: PepperDash/workflow-templates/.github/workflows/update-readme.yml@main with: target-branch: ${{ github.ref_name }} diff --git a/src/Directory.Build.props b/src/Directory.Build.props index db59da5..206b6c0 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -2,14 +2,14 @@ 1.0.0-local $(Version) - PepperDash Technologies - PepperDash Technologies + PepperDash Technology + PepperDash Technology PepperDash Essentials Plugin Template Copyright © 2025 https://github.com/PepperDash/EssentialsPluginTemplate.git git Crestron; 4series - ../output + ..\output True LICENSE.md README.md diff --git a/src/epi-make-model.4Series.csproj b/src/epi-make-model.4Series.csproj index 929c2aa..7ac4bfa 100644 --- a/src/epi-make-model.4Series.csproj +++ b/src/epi-make-model.4Series.csproj @@ -7,14 +7,14 @@ PepperDash.Essentials.Plugin false PepperDash.Essentials.Plugin.Make.Model - PepperDash Technologies + PepperDash Technology This software is a template for a PepperDash Essentials Plugin. Copyright 2025 1.0.0-local true $(Version) bin\$(Configuration)\ - PepperDash Technologies + PepperDash Technology Pepperdash.Essentials.Plugins.Template https://github.com/PepperDash/EssentialsPluginTemplate.git crestron 4series essentials plugin template From cf3f35a53c1a5a4363e11893eda973688cc81aa1 Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Tue, 29 Jul 2025 13:11:00 -0500 Subject: [PATCH 12/14] feat: update for Essentials 2 & remove deprecation warnings BREAKING CHANGE: Drop 3-series support --- .editorconfig | 20 +++ .vscode/extensions.json | 9 + .vscode/settings.json | 32 ++++ epi-make-model.3Series.sln | 20 --- packages.config | 3 - src/MakeModelConfigObject.cs | 20 +-- src/MakeModelCrestronDevice.cs | 53 +++--- src/MakeModelCrestronDeviceFactory.cs | 87 +++++++++ src/MakeModelDevice.cs | 248 +++++++++++++------------- src/MakeModelDeviceFactory.cs | 85 +++++++++ src/MakeModelFactory.cs | 239 ------------------------- src/MakeModelLogicDevice.cs | 46 +++-- src/MakeModelLogicDeviceFactory.cs | 83 +++++++++ src/epi-make-model.4Series.csproj | 2 +- 14 files changed, 496 insertions(+), 451 deletions(-) create mode 100644 .editorconfig create mode 100644 .vscode/extensions.json create mode 100644 .vscode/settings.json delete mode 100644 epi-make-model.3Series.sln delete mode 100644 packages.config create mode 100644 src/MakeModelCrestronDeviceFactory.cs create mode 100644 src/MakeModelDeviceFactory.cs delete mode 100644 src/MakeModelFactory.cs create mode 100644 src/MakeModelLogicDeviceFactory.cs diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..466990d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,20 @@ +root=true + +[*.cs] +indent_style=space +indent_size=2 + +# .editorconfig + +# Define a naming style for camelCase without an underscore prefix +dotnet_naming_style.private_field_camel_case.capitalization = camel_case +dotnet_naming_style.private_field_camel_case.required_prefix = + +# Define a naming rule for private fields to use the defined style +dotnet_naming_rule.private_field_no_underscore.symbols = private_fields +dotnet_naming_rule.private_field_no_underscore.style = private_field_camel_case +dotnet_naming_rule.private_field_no_underscore.severity = warning + +# Define the symbol kind for private fields +dotnet_naming_symbols.private_fields.applicable_kinds = field +dotnet_naming_symbols.private_fields.applicable_accessibilities = private \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..48c5715 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,9 @@ +{ + "recommendations": [ + "ms-dotnettools.vscode-dotnet-runtime", + "ms-dotnettools.csharp", + "ms-dotnettools.csdevkit", + "vivaxy.vscode-conventional-commits", + "mhutchie.git-graph" + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..1ac4b1c --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,32 @@ +{ + "workbench.colorCustomizations": { + "activityBar.activeBackground": "#8c57e5", + "activityBar.background": "#8c57e5", + "activityBar.foreground": "#e7e7e7", + "activityBar.inactiveForeground": "#e7e7e799", + "activityBarBadge.background": "#6e3411", + "activityBarBadge.foreground": "#e7e7e7", + "commandCenter.border": "#e7e7e799", + "sash.hoverBorder": "#8c57e5", + "statusBar.background": "#6e2bde", + "statusBar.foreground": "#e7e7e7", + "statusBarItem.hoverBackground": "#8c57e5", + "statusBarItem.remoteBackground": "#6e2bde", + "statusBarItem.remoteForeground": "#e7e7e7", + "titleBar.activeBackground": "#6e2bde", + "titleBar.activeForeground": "#e7e7e7", + "titleBar.inactiveBackground": "#6e2bde99", + "titleBar.inactiveForeground": "#e7e7e799" + }, + "peacock.color": "#6e2bde", + "[csharp]": { + "editor.defaultFormatter": "ms-dotnettools.csharp", + "editor.formatOnSave": true, + "editor.formatOnSaveMode": "file" + }, + "csharp.inlayHints.enableInlayHintsForImplicitObjectCreation": true, + "csharp.inlayHints.enableInlayHintsForImplicitVariableTypes": true, + "csharp.inlayHints.enableInlayHintsForLambdaParameterTypes": true, + "csharp.inlayHints.enableInlayHintsForTypes": true, + "dotnet.formatting.organizeImportsOnFormat": true +} \ No newline at end of file diff --git a/epi-make-model.3Series.sln b/epi-make-model.3Series.sln deleted file mode 100644 index b106642..0000000 --- a/epi-make-model.3Series.sln +++ /dev/null @@ -1,20 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 10.00 -# Visual Studio 2008 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "epi-make-model.3Series", "src\epi-make-model.3Series.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal diff --git a/packages.config b/packages.config deleted file mode 100644 index c0df495..0000000 --- a/packages.config +++ /dev/null @@ -1,3 +0,0 @@ - - - \ No newline at end of file diff --git a/src/MakeModelConfigObject.cs b/src/MakeModelConfigObject.cs index b247414..0492f38 100644 --- a/src/MakeModelConfigObject.cs +++ b/src/MakeModelConfigObject.cs @@ -1,7 +1,7 @@ -using System.Collections.Generic; -using Newtonsoft.Json; -using PepperDash.Essentials.Core; - +using System.Collections.Generic; +using Newtonsoft.Json; +using PepperDash.Essentials.Core; + namespace PepperDash.Essentials.Plugin { /// @@ -14,7 +14,7 @@ namespace PepperDash.Essentials.Plugin /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" /// [ConfigSnippet("\"properties\":{\"control\":{}")] - public class EssentialsPluginTemplateConfigObject + public class MakeModelConfig { /// /// JSON control object @@ -27,7 +27,7 @@ namespace PepperDash.Essentials.Plugin /// /// /// "control": { - /// "method": "tcpIp", + /// "method": "tcpIp", /// "controlPortDevKey": "processor", /// "controlPortNumber": 1, /// "comParams": { @@ -139,7 +139,7 @@ namespace PepperDash.Essentials.Plugin /// /// [JsonProperty("DeviceDictionary")] - public Dictionary DeviceDictionary { get; set; } + public Dictionary DeviceDictionary { get; set; } /// /// Constuctor @@ -148,9 +148,9 @@ namespace PepperDash.Essentials.Plugin /// If using a collection you must instantiate the collection in the constructor /// to avoid exceptions when reading the configuration file /// - public EssentialsPluginTemplateConfigObject() + public MakeModelConfig() { - DeviceDictionary = new Dictionary(); + DeviceDictionary = new Dictionary(); } } @@ -172,7 +172,7 @@ namespace PepperDash.Essentials.Plugin /// } /// /// - public class EssentialsPluginTemplateConfigObjectDictionary + public class MakeModelConfigDictionary { /// /// Serializes collection name property diff --git a/src/MakeModelCrestronDevice.cs b/src/MakeModelCrestronDevice.cs index 71c91c1..a60d7cb 100644 --- a/src/MakeModelCrestronDevice.cs +++ b/src/MakeModelCrestronDevice.cs @@ -1,29 +1,29 @@ // 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; - +// For Basic SIMPL#Pro classes + +using Crestron.SimplSharpPro; +using Crestron.SimplSharpPro.DeviceSupport; +using PepperDash.Core.Logging; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; + namespace PepperDash.Essentials.Plugin { - /// - /// Plugin device - /// - /// - /// Rename the class to match the device plugin being developed. - /// - /// - /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" - /// - public class EssentialsPluginTemplateCrestronDevice : CrestronGenericBridgeableBaseDevice + /// + /// Plugin device + /// + /// + /// Rename the class to match the device plugin being developed. + /// + /// + /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" + /// + public class MakeModelCrestronDevice : CrestronGenericBridgeableBaseDevice { /// /// It is often desirable to store the config /// - private EssentialsPluginTemplateConfigObject _config; + private readonly MakeModelConfig config; #region Constructor for Devices without IBasicCommunication. Remove if not needed @@ -34,16 +34,16 @@ namespace PepperDash.Essentials.Plugin /// /// /// - public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginTemplateConfigObject config, GenericBase hardware) + public MakeModelCrestronDevice(string key, string name, MakeModelConfig config, GenericBase hardware) : base(key, name, hardware) { - Debug.Console(0, this, "Constructing new {0} instance", name); + this.LogInformation("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; + this.config = config; } #endregion @@ -63,10 +63,7 @@ namespace PepperDash.Essentials.Plugin var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); // This adds the join map to the collection on the bridge - if (bridge != null) - { - bridge.AddJoinMap(Key, joinMap); - } + bridge?.AddJoinMap(Key, joinMap); var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); @@ -75,8 +72,8 @@ namespace PepperDash.Essentials.Plugin joinMap.SetCustomJoinData(customJoins); } - Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); - Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); + this.LogDebug("Linking to Trilist {id}", trilist.ID.ToString("X")); + this.LogInformation("Linking to Bridge Type {type}", GetType().Name); // TODO [ ] Implement bridge links as needed diff --git a/src/MakeModelCrestronDeviceFactory.cs b/src/MakeModelCrestronDeviceFactory.cs new file mode 100644 index 0000000..8e3a994 --- /dev/null +++ b/src/MakeModelCrestronDeviceFactory.cs @@ -0,0 +1,87 @@ +using System.Collections.Generic; +using Crestron.SimplSharpPro.UI; +using PepperDash.Core; +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin +{ + + /// + /// Plugin device factory for Crestron wrapper devices + /// + /// + /// Rename the class to match the device plugin being developed + /// + /// + /// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory" + /// + public class MakeModelCrestronDeviceFactory : EssentialsPluginDeviceFactory + { + /// + /// Plugin device factory constructor + /// + /// + /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin + /// + /// + /// Set the minimum Essentials Framework Version + /// + /// MinimumEssentialsFrameworkVersion = "1.6.4; + /// + /// In the constructor we initialize the list with the typenames that will build an instance of this device + /// + /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; + /// + /// + public MakeModelCrestronDeviceFactory() + { + // Set the minimum Essentials Framework Version + // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against + MinimumEssentialsFrameworkVersion = "2.12.1"; + + // In the constructor we initialize the list with the typenames that will build an instance of this device + // TODO [ ] Update the TypeNames for the plugin being developed + TypeNames = new List() { "examplePluginCrestronDevice" }; + } + + /// + /// Builds and returns an instance of EssentialsPluginTemplateCrestronDevice + /// + /// device configuration + /// plugin device or null + /// + /// The example provided below takes the device key, name, properties config and the comms device created. + /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. + /// + /// + public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) + { + + Debug.LogDebug("[{key}] Factory Attempting to create new device from type: {type}", dc.Key, dc.Type); + + // get the plugin device properties configuration object & check for null + var propertiesConfig = dc.Properties.ToObject(); + if (propertiesConfig == null) + { + Debug.LogWarning("[{key}] Factory: failed to read properties config for {name}", dc.Key, dc.Name); + return null; + } + + var controlConfig = CommFactory.GetControlPropertiesConfig(dc); + + if (controlConfig == null) + { + var myTouchpanel = new Tsw760(controlConfig.IpIdInt, Global.ControlSystem); + + return new MakeModelCrestronDevice(dc.Key, dc.Name, propertiesConfig, myTouchpanel); + } + else + { + Debug.LogWarning("[{key}] Factory: Unable to get control properties from device config for {name}", dc.Key, dc.Name); + return null; + } + } + } + +} + diff --git a/src/MakeModelDevice.cs b/src/MakeModelDevice.cs index da423a2..ad89717 100644 --- a/src/MakeModelDevice.cs +++ b/src/MakeModelDevice.cs @@ -3,6 +3,7 @@ using Crestron.SimplSharpPro.DeviceSupport; using PepperDash.Core; +using PepperDash.Core.Logging; using PepperDash.Essentials.Core; using PepperDash.Essentials.Core.Bridges; using PepperDash.Essentials.Core.Queues; @@ -18,36 +19,36 @@ namespace PepperDash.Essentials.Plugin /// /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" /// - public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice - { - /// - /// It is often desirable to store the config - /// - private EssentialsPluginTemplateConfigObject _config; + public class MakeModelDevice : EssentialsBridgeableDevice + { + /// + /// It is often desirable to store the config + /// + private readonly MakeModelConfig config; - /// - /// Provides a queue and dedicated worker thread for processing feedback messages from a device. - /// - private GenericQueue ReceiveQueue; + /// + /// Provides a queue and dedicated worker thread for processing feedback messages from a device. + /// + private readonly GenericQueue receiveQueue; - #region IBasicCommunication Properties and Constructor. Remove if not needed. + #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; + // 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 + // comms gather for ASCII based API's // TODO [ ] If not using an ASCII based API, delete the properties below - private readonly CommunicationGather _commsGather; + private readonly CommunicationGather commsGather; - /// - /// Set this value to that of the delimiter used by the API (if applicable) - /// - private const string CommsDelimiter = "\r"; + /// + /// Set this value to that of the delimiter used by the API (if applicable) + /// + private const string commsDelimiter = "\r"; - // _comms byte buffer for HEX/byte based API's + // comms byte buffer for HEX/byte based API's // TODO [ ] If not using an HEX/byte based API, delete the properties below - private byte[] _commsByteBuffer = { }; + private readonly byte[] commsByteBuffer = { }; @@ -55,22 +56,22 @@ namespace PepperDash.Essentials.Plugin /// Connects/disconnects the comms of the plugin device /// /// - /// triggers the _comms.Connect/Disconnect as well as thee comms monitor start/stop + /// triggers the comms.Connect/Disconnect as well as thee comms monitor start/stop /// public bool Connect { - get { return _comms.IsConnected; } + get { return comms.IsConnected; } set { if (value) { - _comms.Connect(); - _commsMonitor.Start(); + comms.Connect(); + commsMonitor.Start(); } else { - _comms.Disconnect(); - _commsMonitor.Stop(); + comms.Disconnect(); + commsMonitor.Stop(); } } } @@ -97,93 +98,91 @@ namespace PepperDash.Essentials.Plugin /// /// /// - public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) - : base(key, name) + public MakeModelDevice(string key, string name, MakeModelConfig config, IBasicCommunication comms) + : base(key, name) { - Debug.Console(0, this, "Constructing new {0} instance", name); + this.LogInformation("Constructing new {0} instance", name); // TODO [ ] Update the constructor as needed for the plugin device being developed - _config = config; + this.config = config; - ReceiveQueue = new GenericQueue(key + "-rxqueue"); // If you need to set the thread priority, use one of the available overloaded constructors. + 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); + ConnectFeedback = new BoolFeedback("connect", () => Connect); + OnlineFeedback = new BoolFeedback("online", () => commsMonitor.IsOnline); + StatusFeedback = new IntFeedback("status", () => (int)commsMonitor.Status); - _comms = comms; - _commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll); + this.comms = comms; + commsMonitor = new GenericCommunicationMonitor(this, this.comms, this.config.PollTimeMs, this.config.WarningTimeoutMs, this.config.ErrorTimeoutMs, Poll); - var socket = _comms as ISocketStatus; + var socket = this.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 + #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. + // Only one of the below handlers should be necessary. - // _comms gather for any API that has a defined delimiter + // 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; + commsGather = new CommunicationGather(this.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 + this.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; + // 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 + this.comms.TextReceived += Handle_TextReceived; - #endregion - } + #endregion + } private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) { - if (ConnectFeedback != null) - ConnectFeedback.FireUpdate(); + ConnectFeedback?.FireUpdate(); - if (StatusFeedback != null) - StatusFeedback.FireUpdate(); + 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)); + + // 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 + // 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(); - } + // TODO [ ] If not using an ASCII based API with no delimeter, delete the method below + void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e) + { + // TODO [ ] Implement method + throw new System.NotImplementedException(); + } - /// - /// This method should perform any necessary parsing of feedback messages from the device - /// - /// - void ProcessFeedbackMessage(string message) - { + /// + /// This method should perform any necessary parsing of feedback messages from the device + /// + /// + void ProcessFeedbackMessage(string message) + { - } + } // TODO [ ] If not using an ACII based API, delete the properties below @@ -198,7 +197,7 @@ namespace PepperDash.Essentials.Plugin { if (string.IsNullOrEmpty(text)) return; - _comms.SendText(string.Format("{0}{1}", text, CommsDelimiter)); + comms.SendText(string.Format("{0}{1}", text, commsDelimiter)); } // TODO [ ] If not using an HEX/byte based API, delete the properties below @@ -213,7 +212,7 @@ namespace PepperDash.Essentials.Plugin { if (bytes == null) return; - _comms.SendBytes(bytes); + comms.SendBytes(bytes); } /// @@ -225,74 +224,71 @@ namespace PepperDash.Essentials.Plugin public void Poll() { // TODO [ ] Update Poll method as needed for the plugin being developed - // Example: SendText("getstatus"); + // Example: SendText("getstatus"); throw new System.NotImplementedException(); - } + } - #endregion + #endregion - #region Overrides of EssentialsBridgeableDevice + #region Overrides of EssentialsBridgeableDevice - /// - /// Links the plugin device to the EISC bridge - /// - /// - /// - /// - /// - public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) - { - var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); + /// + /// Links the plugin device to the EISC bridge + /// + /// + /// + /// + /// + public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) + { + var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); - // This adds the join map to the collection on the bridge - if (bridge != null) - { - bridge.AddJoinMap(Key, joinMap); - } + // This adds the join map to the collection on the bridge + bridge?.AddJoinMap(Key, joinMap); - var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); + var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); - if (customJoins != null) - { - joinMap.SetCustomJoinData(customJoins); - } + 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); + this.LogDebug("Linking to Trilist {id}", trilist.ID.ToString("X")); + this.LogInformation("Linking to Bridge Type {type}", GetType().Name); - // TODO [ ] Implement bridge links as needed + // TODO [ ] Implement bridge links as needed - // links to bridge - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + // links to bridge + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig); - ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]); + 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]); + StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]); + OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]); - UpdateFeedbacks(); + UpdateFeedbacks(); - trilist.OnlineStatusChange += (o, a) => - { - if (!a.DeviceOnLine) return; + trilist.OnlineStatusChange += (o, a) => + { + if (!a.DeviceOnLine) return; - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - UpdateFeedbacks(); - }; - } + 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(); - } + private void UpdateFeedbacks() + { + // TODO [ ] Update as needed for the plugin being developed + ConnectFeedback.FireUpdate(); + OnlineFeedback.FireUpdate(); + StatusFeedback.FireUpdate(); + } - #endregion + #endregion - } + } } diff --git a/src/MakeModelDeviceFactory.cs b/src/MakeModelDeviceFactory.cs new file mode 100644 index 0000000..b767a29 --- /dev/null +++ b/src/MakeModelDeviceFactory.cs @@ -0,0 +1,85 @@ +using System.Collections.Generic; +using PepperDash.Core; +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin +{ + /// + /// Plugin device factory for devices that use IBasicCommunication + /// + /// + /// Rename the class to match the device plugin being developed + /// + /// + /// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory" + /// + public class MakeModelDeviceFactory : EssentialsPluginDeviceFactory + { + /// + /// Plugin device factory constructor + /// + /// + /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin + /// + /// + /// Set the minimum Essentials Framework Version + /// + /// MinimumEssentialsFrameworkVersion = "2.12.1; + /// + /// In the constructor we initialize the list with the typenames that will build an instance of this device + /// + /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; + /// + /// + public MakeModelDeviceFactory() + { + // Set the minimum Essentials Framework Version + // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against + MinimumEssentialsFrameworkVersion = "2.12.1"; + + // In the constructor we initialize the list with the typenames that will build an instance of this device + // TODO [ ] Update the TypeNames for the plugin being developed + TypeNames = new List() { "examplePluginDevice" }; + } + + /// + /// Builds and returns an instance of EssentialsPluginDeviceTemplate + /// + /// device configuration + /// plugin device or null + /// + /// The example provided below takes the device key, name, properties config and the comms device created. + /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. + /// + /// + public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) + { + Debug.LogVerbose("[{key}] Factory Attempting to create new device from type: {type}", dc.Key, dc.Type); + + // get the plugin device properties configuration object & check for null + var propertiesConfig = dc.Properties.ToObject(); + if (propertiesConfig == null) + { + Debug.LogError("[{key}] Factory: failed to read properties config for {name}", 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.LogError("[{key}] Factory Notice: No control object present for device {name}", dc.Key, dc.Name); + return null; + } + else + { + return new MakeModelDevice(dc.Key, dc.Name, propertiesConfig, comms); + } + + } + + } + +} + diff --git a/src/MakeModelFactory.cs b/src/MakeModelFactory.cs deleted file mode 100644 index e94994a..0000000 --- a/src/MakeModelFactory.cs +++ /dev/null @@ -1,239 +0,0 @@ -using System.Collections.Generic; -using Crestron.SimplSharpPro.UI; -using PepperDash.Core; -using PepperDash.Essentials.Core; - -namespace PepperDash.Essentials.Plugin -{ - /// - /// Plugin device factory for devices that use IBasicCommunication - /// - /// - /// Rename the class to match the device plugin being developed - /// - /// - /// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory" - /// - public class EssentialsPluginTemplateFactory : EssentialsPluginDeviceFactory - { - /// - /// Plugin device factory constructor - /// - /// - /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin - /// - /// - /// Set the minimum Essentials Framework Version - /// - /// MinimumEssentialsFrameworkVersion = "1.6.4; - /// - /// In the constructor we initialize the list with the typenames that will build an instance of this device - /// - /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; - /// - /// - public EssentialsPluginTemplateFactory() - { - // Set the minimum Essentials Framework Version - // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against - MinimumEssentialsFrameworkVersion = "1.6.4"; - - // In the constructor we initialize the list with the typenames that will build an instance of this device - // TODO [ ] Update the TypeNames for the plugin being developed - TypeNames = new List() { "examplePluginDevice" }; - } - - /// - /// Builds and returns an instance of EssentialsPluginDeviceTemplate - /// - /// device configuration - /// plugin device or null - /// - /// The example provided below takes the device key, name, properties config and the comms device created. - /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. - /// - /// - public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) - { - Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); - - // get the plugin device properties configuration object & check for null - var propertiesConfig = dc.Properties.ToObject(); - if (propertiesConfig == null) - { - Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); - return null; - } - - // attempt build the plugin device comms device & check for null - // TODO { ] As of PepperDash Core 1.0.41, HTTP and HTTPS are not valid eControlMethods and will throw an exception. - var comms = CommFactory.CreateCommForDevice(dc); - if (comms == null) - { - Debug.Console(1, "[{0}] Factory Notice: No control object present for device {1}", dc.Key, dc.Name); - return null; - } - else - { - return new EssentialsPluginTemplateDevice(dc.Key, dc.Name, propertiesConfig, comms); - } - - } - - } - - /// - /// Plugin device factory for logic devices that don't communicate - /// - /// - /// Rename the class to match the device plugin being developed - /// - /// - /// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory" - /// - public class EssentialsPluginTemplateFactoryLogicDevice : EssentialsPluginDeviceFactory - { - /// - /// Plugin device factory constructor - /// - /// - /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin - /// - /// - /// Set the minimum Essentials Framework Version - /// - /// MinimumEssentialsFrameworkVersion = "1.6.4; - /// - /// In the constructor we initialize the list with the typenames that will build an instance of this device - /// - /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; - /// - /// - public EssentialsPluginTemplateFactoryLogicDevice() - { - // Set the minimum Essentials Framework Version - // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against - MinimumEssentialsFrameworkVersion = "1.6.4"; - - // In the constructor we initialize the list with the typenames that will build an instance of this device - // TODO [ ] Update the TypeNames for the plugin being developed - TypeNames = new List() { "examplePluginLogicDevice" }; - } - - /// - /// Builds and returns an instance of EssentialsPluginTemplateLogicDevice - /// - /// device configuration - /// plugin device or null - /// - /// The example provided below takes the device key, name, properties config and the comms device created. - /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. - /// - /// - public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) - { - - Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); - - // get the plugin device properties configuration object & check for null - var propertiesConfig = dc.Properties.ToObject(); - if (propertiesConfig == null) - { - Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); - return null; - } - - var controlConfig = CommFactory.GetControlPropertiesConfig(dc); - - if (controlConfig == null) - { - return new EssentialsPluginTemplateLogicDevice(dc.Key, dc.Name, propertiesConfig); - } - else - { - Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name); - return null; - } - } - } - - /// - /// Plugin device factory for Crestron wrapper devices - /// - /// - /// Rename the class to match the device plugin being developed - /// - /// - /// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory" - /// - public class EssentialsPluginTemplateFactoryCrestronDevice : EssentialsPluginDeviceFactory - { - /// - /// Plugin device factory constructor - /// - /// - /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin - /// - /// - /// Set the minimum Essentials Framework Version - /// - /// MinimumEssentialsFrameworkVersion = "1.6.4; - /// - /// In the constructor we initialize the list with the typenames that will build an instance of this device - /// - /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; - /// - /// - public EssentialsPluginTemplateFactoryCrestronDevice() - { - // Set the minimum Essentials Framework Version - // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against - MinimumEssentialsFrameworkVersion = "1.7.5"; - - // In the constructor we initialize the list with the typenames that will build an instance of this device - // TODO [ ] Update the TypeNames for the plugin being developed - TypeNames = new List() { "examplePluginCrestronDevice" }; - } - - /// - /// Builds and returns an instance of EssentialsPluginTemplateCrestronDevice - /// - /// device configuration - /// plugin device or null - /// - /// The example provided below takes the device key, name, properties config and the comms device created. - /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. - /// - /// - public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) - { - - Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); - - // get the plugin device properties configuration object & check for null - var propertiesConfig = dc.Properties.ToObject(); - if (propertiesConfig == null) - { - Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); - return null; - } - - var controlConfig = CommFactory.GetControlPropertiesConfig(dc); - - if (controlConfig == null) - { - var myTouchpanel = new Tsw760(controlConfig.IpIdInt, Global.ControlSystem); - - return new EssentialsPluginTemplateCrestronDevice(dc.Key, dc.Name, propertiesConfig, myTouchpanel); - } - else - { - Debug.Console(0, "[{0}] Factory: Unable to get control properties from device config for {1}", dc.Key, dc.Name); - return null; - } - } - } - -} - - \ No newline at end of file diff --git a/src/MakeModelLogicDevice.cs b/src/MakeModelLogicDevice.cs index 44aeeec..02b3d35 100644 --- a/src/MakeModelLogicDevice.cs +++ b/src/MakeModelLogicDevice.cs @@ -1,25 +1,26 @@ -using Crestron.SimplSharpPro.DeviceSupport; -using PepperDash.Core; -using PepperDash.Essentials.Core; -using PepperDash.Essentials.Core.Bridges; - +using Crestron.SimplSharpPro.DeviceSupport; +using PepperDash.Core; +using PepperDash.Core.Logging; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; + namespace PepperDash.Essentials.Plugin { - /// - /// Plugin device template for logic devices that don't communicate outside the program - /// - /// - /// Rename the class to match the device plugin being developed. - /// - /// + /// + /// Plugin device template for logic devices that don't communicate outside the program + /// + /// + /// Rename the class to match the device plugin being developed. + /// + /// /// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice" - /// - public class EssentialsPluginTemplateLogicDevice : EssentialsBridgeableDevice + /// + public class MakeModelLogicDevice : EssentialsBridgeableDevice { /// /// It is often desirable to store the config /// - private EssentialsPluginTemplateConfigObject _config; + private readonly MakeModelConfig config; /// /// Plugin device constructor @@ -27,14 +28,14 @@ namespace PepperDash.Essentials.Plugin /// /// /// - public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginTemplateConfigObject config) + public MakeModelLogicDevice(string key, string name, MakeModelConfig config) : base(key, name) { - Debug.Console(0, this, "Constructing new {0} instance", name); + this.LogInformation("Constructing new {0} instance", name); // TODO [ ] Update the constructor as needed for the plugin device being developed - _config = config; + this.config = config; } #region Overrides of EssentialsBridgeableDevice @@ -51,10 +52,7 @@ namespace PepperDash.Essentials.Plugin var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); // This adds the join map to the collection on the bridge - if (bridge != null) - { - bridge.AddJoinMap(Key, joinMap); - } + bridge?.AddJoinMap(Key, joinMap); var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); @@ -63,8 +61,8 @@ namespace PepperDash.Essentials.Plugin joinMap.SetCustomJoinData(customJoins); } - Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); - Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); + this.LogDebug("Linking to Trilist {id}", trilist.ID.ToString("X")); + this.LogInformation("Linking to Bridge Type {type}", GetType().Name); // TODO [ ] Implement bridge links as needed diff --git a/src/MakeModelLogicDeviceFactory.cs b/src/MakeModelLogicDeviceFactory.cs new file mode 100644 index 0000000..1f8cfa2 --- /dev/null +++ b/src/MakeModelLogicDeviceFactory.cs @@ -0,0 +1,83 @@ +using System.Collections.Generic; +using PepperDash.Core; +using PepperDash.Essentials.Core; + +namespace PepperDash.Essentials.Plugin +{ + /// + /// Plugin device factory for logic devices that don't communicate + /// + /// + /// Rename the class to match the device plugin being developed + /// + /// + /// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory" + /// + public class MakeModelLogicDeviceFactory : EssentialsPluginDeviceFactory + { + /// + /// Plugin device factory constructor + /// + /// + /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin + /// + /// + /// Set the minimum Essentials Framework Version + /// + /// MinimumEssentialsFrameworkVersion = "1.6.4; + /// + /// In the constructor we initialize the list with the typenames that will build an instance of this device + /// + /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; + /// + /// + public MakeModelLogicDeviceFactory() + { + // Set the minimum Essentials Framework Version + // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against + MinimumEssentialsFrameworkVersion = "2.12.1"; + + // In the constructor we initialize the list with the typenames that will build an instance of this device + // TODO [ ] Update the TypeNames for the plugin being developed + TypeNames = new List() { "examplePluginLogicDevice" }; + } + + /// + /// Builds and returns an instance of EssentialsPluginTemplateLogicDevice + /// + /// device configuration + /// plugin device or null + /// + /// The example provided below takes the device key, name, properties config and the comms device created. + /// Modify the EssetnialsPlugingDeviceTemplate constructor as needed to meet the requirements of the plugin device. + /// + /// + public override EssentialsDevice BuildDevice(PepperDash.Essentials.Core.Config.DeviceConfig dc) + { + + Debug.LogDebug("[{key}] Factory Attempting to create new device from type: {type}", dc.Key, dc.Type); + + // get the plugin device properties configuration object & check for null + var propertiesConfig = dc.Properties.ToObject(); + if (propertiesConfig == null) + { + Debug.LogError("[{key}] Factory: failed to read properties config for {name}", dc.Key, dc.Name); + return null; + } + + var controlConfig = CommFactory.GetControlPropertiesConfig(dc); + + if (controlConfig == null) + { + return new MakeModelLogicDevice(dc.Key, dc.Name, propertiesConfig); + } + else + { + Debug.LogError("[{key}] Factory: Unable to get control properties from device config for {name}", dc.Key, dc.Name); + return null; + } + } + } + +} + diff --git a/src/epi-make-model.4Series.csproj b/src/epi-make-model.4Series.csproj index 7ac4bfa..081ac42 100644 --- a/src/epi-make-model.4Series.csproj +++ b/src/epi-make-model.4Series.csproj @@ -35,7 +35,7 @@ - + runtime From 22faf9ef109b4d49558f28a6ca6b445006a0f158 Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Tue, 29 Jul 2025 13:52:27 -0500 Subject: [PATCH 13/14] fix: use correct null check --- src/MakeModelCrestronDeviceFactory.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/MakeModelCrestronDeviceFactory.cs b/src/MakeModelCrestronDeviceFactory.cs index 8e3a994..f014b95 100644 --- a/src/MakeModelCrestronDeviceFactory.cs +++ b/src/MakeModelCrestronDeviceFactory.cs @@ -69,7 +69,7 @@ namespace PepperDash.Essentials.Plugin var controlConfig = CommFactory.GetControlPropertiesConfig(dc); - if (controlConfig == null) + if (controlConfig != null) { var myTouchpanel = new Tsw760(controlConfig.IpIdInt, Global.ControlSystem); From a86f97c4f4c5f239f2cdd2fd8f74e84f209bbd3c Mon Sep 17 00:00:00 2001 From: Andrew Welker Date: Tue, 29 Jul 2025 14:00:20 -0500 Subject: [PATCH 14/14] docs: update readme --- README.md | 36 ++++++++++++------------------------ 1 file changed, 12 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 458eca2..9d2df4d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![PepperDash Essentials Pluign Logo](/images/essentials-plugin-blue.png) -# Essentials Plugin Template (c) 2023 +# Essentials Plugin Template (c) 2025 ## License @@ -8,14 +8,14 @@ Provided under MIT license ## Overview -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. +Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://pepperdash.github.io/Essentials/docs/Plugins.html) 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 +* `MakeModelDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc +* `MakeModelLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program +* `MakeModelCrestronDevice`: 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`. +There are matching factory classes for each of the three categories of devices. The `MakeModelConfigObject` should be used as a template and modified for any of the categories of device. Same goes for the `MakeModeleBridgeJoinMap`. This also illustrates how a plugin can contain multiple devices. @@ -29,14 +29,7 @@ The [Essentials](https://github.com/PepperDash/Essentials) libraries are require ### Installing Dependencies -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 - -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. +Dependencies will be automatically installed when ### Instructions for Renaming Solution and Files @@ -46,15 +39,10 @@ For renaming instructions in particular, see the XML `remarks` tags on class def ## Build Instructions (PepperDash Internal) -## Generating Nuget Package +## Generating Nuget Package -In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" +A nuget package is automatically generated when the plugin is build. To modify the name and other details of the package, edit the following properties in the .csproj file: -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 +1. `PackageId` - This is the name that will be used to pull the package from Nuget once it's published +2. `PackgeProjectUrl` - This should match the URL for the plugin repo +3. `AssemblyTitle` - This is the dll file name that is will show on a processor when the plugin is loaded \ No newline at end of file