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/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 - -In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" - -1. Rename the file to match your plugin solution name -2. Edit the file to include your project specifics including - 1. PepperDash.Essentials.Plugin.MakeModel Convention is to use the prefix "PepperDash.Essentials.Plugin" and include the MakeModel of the device. - 2. https://github.com/PepperDash/EssentialsPluginTemplate Change to your url to the project repo +## Generating Nuget Package -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. +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: -__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 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 @@ public class EssentialsPluginTemplateConfigObject /// /// /// "control": { - /// "method": "tcpIp", + /// "method": "tcpIp", /// "controlPortDevKey": "processor", /// "controlPortNumber": 1, /// "comParams": { @@ -139,7 +139,7 @@ public class EssentialsPluginTemplateConfigObject /// /// [JsonProperty("DeviceDictionary")] - public Dictionary DeviceDictionary { get; set; } + public Dictionary DeviceDictionary { get; set; } /// /// Constuctor @@ -148,9 +148,9 @@ public class EssentialsPluginTemplateConfigObject /// 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 @@ public EssentialsPluginTemplateConfigObject() /// } /// /// - 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 @@ public class EssentialsPluginTemplateCrestronDevice : CrestronGenericBridgeableB /// /// /// - 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 @@ public override void LinkToApi(BasicTriList trilist, uint joinStart, string join 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 @@ public override void LinkToApi(BasicTriList trilist, uint joinStart, string join 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..f014b95 --- /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 @@ public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice /// 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 @@ public bool Connect /// /// /// - 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 @@ public void SendText(string text) { 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 @@ public void SendBytes(byte[] bytes) { if (bytes == null) return; - _comms.SendBytes(bytes); + comms.SendBytes(bytes); } /// @@ -225,74 +224,71 @@ public void SendBytes(byte[] bytes) 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 @@ public class EssentialsPluginTemplateLogicDevice : EssentialsBridgeableDevice /// /// /// - 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 @@ public override void LinkToApi(BasicTriList trilist, uint joinStart, string join 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 @@ public override void LinkToApi(BasicTriList trilist, uint joinStart, string join 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