diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 466990d..0000000 --- a/.editorconfig +++ /dev/null @@ -1,20 +0,0 @@ -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/.github/workflows/EssentialsPlugins-builds-caller.yml b/.github/workflows/EssentialsPlugins-builds-caller.yml index 606fcb9..6d9f244 100644 --- a/.github/workflows/EssentialsPlugins-builds-caller.yml +++ b/.github/workflows/EssentialsPlugins-builds-caller.yml @@ -9,7 +9,16 @@ 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 + 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 diff --git a/.github/workflows/essentialsplugins-updatereadme-caller.yml b/.github/workflows/essentialsplugins-updatereadme-caller.yml deleted file mode 100644 index 8f4bbe3..0000000 --- a/.github/workflows/essentialsplugins-updatereadme-caller.yml +++ /dev/null @@ -1,14 +0,0 @@ - -name: Generate README - -on: - push: - branches-ignore: - - 'robot-docs' - -jobs: - call-update-readme: - uses: PepperDash/workflow-templates/.github/workflows/update-readme.yml@main - with: - target-branch: ${{ github.ref_name }} - diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 48c5715..0000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "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 deleted file mode 100644 index 1ac4b1c..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "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.4Series.sln b/PDT.EssentialsPluginTemplate.EPI.4Series.sln similarity index 83% rename from epi-make-model.4Series.sln rename to PDT.EssentialsPluginTemplate.EPI.4Series.sln index e073161..af0013f 100644 --- a/epi-make-model.4Series.sln +++ b/PDT.EssentialsPluginTemplate.EPI.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}") = "epi-make-model.4Series", "src\epi-make-model.4Series.csproj", "{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PDT.EssentialsPluginTemplate.EPI.4Series.", "src\PDT.EssentialsPluginTemplate.EPI.4Series..csproj", "{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/README.md b/README.md index 9d2df4d..3e95e58 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![PepperDash Essentials Pluign Logo](/images/essentials-plugin-blue.png) -# Essentials Plugin Template (c) 2025 +# Essentials Plugin Template (c) 2023 ## 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://pepperdash.github.io/Essentials/docs/Plugins.html) article. +Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://github.com/PepperDash/Essentials/wiki/Plugins) article. This repo contains example classes for the three main categories of devices: -* `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 +* `EssentialsPluginTemplateDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc +* `EssentialsPluginTemplateLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program +* `EssentialsPluginTemplateCrestronDevice`: Used for devices that represent a piece of Crestron hardware -There are matching factory classes for each of the three categories of devices. The `MakeModelConfigObject` should be used as a template and modified for any of the categories of device. Same goes for the `MakeModeleBridgeJoinMap`. +There are matching factory classes for each of the three categories of devices. The `EssentialsPluginTemplateConfigObject` should be used as a template and modified for any of the categories of device. Same goes for the `EssentialsPluginTemplateBridgeJoinMap`. This also illustrates how a plugin can contain multiple devices. @@ -29,7 +29,14 @@ The [Essentials](https://github.com/PepperDash/Essentials) libraries are require ### Installing Dependencies -Dependencies will be automatically installed when +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. ### Instructions for Renaming Solution and Files @@ -39,10 +46,15 @@ For renaming instructions in particular, see the XML `remarks` tags on class def ## Build Instructions (PepperDash Internal) -## Generating Nuget Package +## Generating Nuget Package -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: +In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" -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 +1. Rename the file to match your plugin solution name +2. Edit the file to include your project specifics including + 1. PepperDash.Essentials.Plugin.MakeModel Convention is to use the prefix "PepperDash.Essentials.Plugin" and include the MakeModel of the device. + 2. https://github.com/PepperDash/EssentialsPluginTemplate Change to your url to the project repo + +There is no longer a requirement to adjust workflow files for nuget generation for private and public repositories. This is now handled automatically in the workflow. + +__If you do not make these changes to the nuspec file, the project will not generate a nuget package__ \ No newline at end of file diff --git a/packages.config b/packages.config new file mode 100644 index 0000000..2a12f4c --- /dev/null +++ b/packages.config @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/.releaserc.json b/releaserc.json similarity index 99% rename from .releaserc.json rename to releaserc.json index e6ec36a..c4bd268 100644 --- a/.releaserc.json +++ b/releaserc.json @@ -31,4 +31,4 @@ "channel": "replace-me-prerelease" } ] -} +} \ No newline at end of file diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 206b6c0..ef365ad 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -2,14 +2,14 @@ 1.0.0-local $(Version) - PepperDash Technology - PepperDash Technology + PepperDash Technologies + PepperDash Technologies PepperDash Essentials Plugin Template - Copyright © 2025 + Copyright © 2024 https://github.com/PepperDash/EssentialsPluginTemplate.git git Crestron; 4series - ..\output + ../output True LICENSE.md README.md diff --git a/src/MakeModelBridgeJoinMap.cs b/src/EssentialsPluginTemplateBridgeJoinMap.cs similarity index 94% rename from src/MakeModelBridgeJoinMap.cs rename to src/EssentialsPluginTemplateBridgeJoinMap.cs index 0d20a8f..140d021 100644 --- a/src/MakeModelBridgeJoinMap.cs +++ b/src/EssentialsPluginTemplateBridgeJoinMap.cs @@ -1,101 +1,101 @@ -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)) - { - } - } +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)) + { + } + } } \ No newline at end of file diff --git a/src/MakeModelConfigObject.cs b/src/EssentialsPluginTemplateConfigObject.cs similarity index 92% rename from src/MakeModelConfigObject.cs rename to src/EssentialsPluginTemplateConfigObject.cs index 0492f38..e216796 100644 --- a/src/MakeModelConfigObject.cs +++ b/src/EssentialsPluginTemplateConfigObject.cs @@ -2,7 +2,7 @@ using Newtonsoft.Json; using PepperDash.Essentials.Core; -namespace PepperDash.Essentials.Plugin +namespace EssentialsPluginTemplate { /// /// Plugin device configuration object @@ -14,7 +14,7 @@ namespace PepperDash.Essentials.Plugin /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" /// [ConfigSnippet("\"properties\":{\"control\":{}")] - public class MakeModelConfig + public class EssentialsPluginTemplateConfigObject { /// /// 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 MakeModelConfig() + public EssentialsPluginTemplateConfigObject() { - DeviceDictionary = new Dictionary(); + DeviceDictionary = new Dictionary(); } } @@ -172,7 +172,7 @@ namespace PepperDash.Essentials.Plugin /// } /// /// - public class MakeModelConfigDictionary + public class EssentialsPluginTemplateConfigObjectDictionary { /// /// Serializes collection name property diff --git a/src/EssentialsPluginTemplateDevice.cs b/src/EssentialsPluginTemplateDevice.cs new file mode 100644 index 0000000..8ccafee --- /dev/null +++ b/src/EssentialsPluginTemplateDevice.cs @@ -0,0 +1,256 @@ +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 + { + 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. + + private readonly IBasicCommunication _comms; + private readonly GenericCommunicationMonitor _commsMonitor; + private readonly CommunicationGather _commsGather; + + /// + /// Set this value to that of the delimiter used by the API (if applicable) + /// + private const string CommsDelimiter = "\r"; + 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); + + _config = config; + + ReceiveQueue = new GenericQueue(key + "-rxqueue"); + + 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) + { + socket.ConnectionChange += socket_ConnectionChange; + Connect = true; + } + + #region Communication data event handlers. Comment out any that don't apply to the API type + + _commsGather = new CommunicationGather(_comms, CommsDelimiter); + _commsGather.LineReceived += Handle_LineRecieved; + _comms.BytesReceived += Handle_BytesReceived; + _comms.TextReceived += Handle_TextReceived; + + #endregion + } + + + private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) + { + if (ConnectFeedback != null) + ConnectFeedback.FireUpdate(); + + if (StatusFeedback != null) + StatusFeedback.FireUpdate(); + } + + private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args) + { + ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage)); + } + + private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args) + { + throw new System.NotImplementedException(); + } + + void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e) + { + throw new System.NotImplementedException(); + } + + /// + /// This method should perform any necessary parsing of feedback messages from the device + /// + /// + void ProcessFeedbackMessage(string message) + { + throw new System.NotImplementedException(); + } + + /// + /// 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}"); + } + + /// + /// 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() + { + 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); + + 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); + + + 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() + { + ConnectFeedback.FireUpdate(); + OnlineFeedback.FireUpdate(); + StatusFeedback.FireUpdate(); + } + + #endregion + + } +} + diff --git a/src/EssentialsPluginTemplateFactory.cs b/src/EssentialsPluginTemplateFactory.cs new file mode 100644 index 0000000..0b58f52 --- /dev/null +++ b/src/EssentialsPluginTemplateFactory.cs @@ -0,0 +1,239 @@ +using System.Collections.Generic; +using PepperDash.Core; +using PepperDash.Essentials.Core; +using Crestron.SimplSharpPro.UI; + +namespace EssentialsPluginTemplate +{ + /// + /// 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/MakeModelCrestronDevice.cs b/src/MakeModelCrestronDevice.cs deleted file mode 100644 index a60d7cb..0000000 --- a/src/MakeModelCrestronDevice.cs +++ /dev/null @@ -1,96 +0,0 @@ -// For Basic SIMPL# Classes -// 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 MakeModelCrestronDevice : CrestronGenericBridgeableBaseDevice - { - /// - /// It is often desirable to store the config - /// - private readonly MakeModelConfig config; - - - #region Constructor for Devices without IBasicCommunication. Remove if not needed - /// - /// Plugin device constructor for Crestron devices - /// - /// - /// - /// - /// - public MakeModelCrestronDevice(string key, string name, MakeModelConfig config, GenericBase hardware) - : base(key, name, hardware) - { - 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 - - this.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 - bridge?.AddJoinMap(Key, joinMap); - - var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); - - if (customJoins != null) - { - joinMap.SetCustomJoinData(customJoins); - } - - 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 - - // 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/MakeModelCrestronDeviceFactory.cs b/src/MakeModelCrestronDeviceFactory.cs deleted file mode 100644 index f014b95..0000000 --- a/src/MakeModelCrestronDeviceFactory.cs +++ /dev/null @@ -1,87 +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 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 deleted file mode 100644 index ad89717..0000000 --- a/src/MakeModelDevice.cs +++ /dev/null @@ -1,294 +0,0 @@ -// For Basic SIMPL# Classes -// For Basic SIMPL#Pro classes - -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; - -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 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 readonly 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 readonly 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 MakeModelDevice(string key, string name, MakeModelConfig config, IBasicCommunication comms) - : base(key, name) - { - this.LogInformation("Constructing new {0} instance", name); - - // TODO [ ] Update the constructor as needed for the plugin device being developed - - this.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", () => Connect); - OnlineFeedback = new BoolFeedback("online", () => commsMonitor.IsOnline); - StatusFeedback = new IntFeedback("status", () => (int)commsMonitor.Status); - - this.comms = comms; - commsMonitor = new GenericCommunicationMonitor(this, this.comms, this.config.PollTimeMs, this.config.WarningTimeoutMs, this.config.ErrorTimeoutMs, Poll); - - 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 - - // 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(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 - 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 - this.comms.TextReceived += Handle_TextReceived; - - #endregion - } - - - private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) - { - ConnectFeedback?.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)); - } - - // 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 - bridge?.AddJoinMap(Key, joinMap); - - var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); - - if (customJoins != null) - { - joinMap.SetCustomJoinData(customJoins); - } - - 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 - - // 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/MakeModelDeviceFactory.cs b/src/MakeModelDeviceFactory.cs deleted file mode 100644 index b767a29..0000000 --- a/src/MakeModelDeviceFactory.cs +++ /dev/null @@ -1,85 +0,0 @@ -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/MakeModelLogicDevice.cs b/src/MakeModelLogicDevice.cs deleted file mode 100644 index 02b3d35..0000000 --- a/src/MakeModelLogicDevice.cs +++ /dev/null @@ -1,84 +0,0 @@ -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. - /// - /// - /// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice" - /// - public class MakeModelLogicDevice : EssentialsBridgeableDevice - { - /// - /// It is often desirable to store the config - /// - private readonly MakeModelConfig config; - - /// - /// Plugin device constructor - /// - /// - /// - /// - public MakeModelLogicDevice(string key, string name, MakeModelConfig config) - : base(key, name) - { - this.LogInformation("Constructing new {0} instance", name); - - // TODO [ ] Update the constructor as needed for the plugin device being developed - - this.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 - bridge?.AddJoinMap(Key, joinMap); - - var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); - - if (customJoins != null) - { - joinMap.SetCustomJoinData(customJoins); - } - - 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 - - // 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/MakeModelLogicDeviceFactory.cs b/src/MakeModelLogicDeviceFactory.cs deleted file mode 100644 index 1f8cfa2..0000000 --- a/src/MakeModelLogicDeviceFactory.cs +++ /dev/null @@ -1,83 +0,0 @@ -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/PDT.EssentialsPluginTemplate.EPI.4Series..csproj similarity index 57% rename from src/epi-make-model.4Series.csproj rename to src/PDT.EssentialsPluginTemplate.EPI.4Series..csproj index 081ac42..1f930c1 100644 --- a/src/epi-make-model.4Series.csproj +++ b/src/PDT.EssentialsPluginTemplate.EPI.4Series..csproj @@ -4,17 +4,17 @@ net472 - PepperDash.Essentials.Plugin + PDT.EssentialsPluginTemplate.EPI false - PepperDash.Essentials.Plugin.Make.Model - PepperDash Technology + PDT.EssentialsPluginTemplate.EPI + PepperDash Technologies This software is a template for a PepperDash Essentials Plugin. - Copyright 2025 + Copyright 2024 1.0.0-local true $(Version) - bin\$(Configuration)\ - PepperDash Technology + 4Series\bin\$(Configuration)\ + PepperDash Technologies Pepperdash.Essentials.Plugins.Template https://github.com/PepperDash/EssentialsPluginTemplate.git crestron 4series essentials plugin template @@ -31,20 +31,10 @@ - - + + - - - runtime - - - - - - - - - - - + + + + \ No newline at end of file diff --git a/src/epi-make-model.3Series.csproj b/src/PDT.EssentialsPluginTemplate.EPI.csproj similarity index 82% rename from src/epi-make-model.3Series.csproj rename to src/PDT.EssentialsPluginTemplate.EPI.csproj index 03aa3ce..edda00c 100644 --- a/src/epi-make-model.3Series.csproj +++ b/src/PDT.EssentialsPluginTemplate.EPI.csproj @@ -1,115 +1,115 @@ - - - Release - AnyCPU - 9.0.30729 - 2.0 - {9D249E47-8F95-4437-A6BB-563510287AD1} - Library - Properties - 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 - + + + Release + AnyCPU + 9.0.30729 + 2.0 + {9D249E47-8F95-4437-A6BB-563510287AD1} + Library + Properties + PDT.EssentialsPluginTemplate.EPI + PDT.EssentialsPluginTemplate.EPI + {0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} + WindowsCE + E2BECB1F-8C8C-41ba-B736-9BE7D946A398 + 5.0 + SmartDeviceProject1 + v3.5 + Windows CE + + + + + .allowedReferenceRelatedFileExtensions + true + full + false + bin\Debug\ + DEBUG;TRACE; + prompt + 4 + 512 + true + true + off + + + .allowedReferenceRelatedFileExtensions + none + true + bin\Release\ + prompt + 4 + 512 + true + true + off + + + + False + ..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll + + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll + False + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll + False + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe + False + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll + + + + + + + + + + + + + + + + + + rem S# Pro preparation will execute after these operations + \ No newline at end of file diff --git a/src/PDT.EssentialsPluginTemplate.nuspec b/src/PDT.EssentialsPluginTemplate.nuspec new file mode 100644 index 0000000..e72f807 --- /dev/null +++ b/src/PDT.EssentialsPluginTemplate.nuspec @@ -0,0 +1,23 @@ + + + + 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