diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs new file mode 100644 index 0000000..2377387 --- /dev/null +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs @@ -0,0 +1,99 @@ +// For Basic SIMPL# Classes +// For Basic SIMPL#Pro classes + +using Crestron.SimplSharpPro.DeviceSupport; +using Crestron.SimplSharpPro; +using PepperDash.Core; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; + +namespace EssentialsPluginTemplate +{ + /// + /// Plugin device + /// + /// + /// Rename the class to match the device plugin being developed. + /// + /// + /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" + /// + public class EssentialsPluginTemplateCrestronDevice : CrestronGenericBridgeableBaseDevice + { + /// + /// It is often desirable to store the config + /// + private EssentialsPluginConfigObjectTemplate _config; + + + #region Constructor for Devices without IBasicCommunication. Remove if not needed + /// + /// Plugin device constructor for Crestron devices + /// + /// + /// + /// + /// + public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, GenericBase hardware) + : base(key, name, hardware) + { + Debug.Console(0, this, "Constructing new {0} instance", name); + + // The base class takes care of registering the hardware device for you + + // TODO [ ] Update the constructor as needed for the plugin device being developed + + _config = config; + } + + #endregion + + + #region Overrides of EssentialsBridgeableDevice + + /// + /// Links the plugin device to the EISC bridge + /// + /// + /// + /// + /// + public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) + { + var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); + + // This adds the join map to the collection on the bridge + if (bridge != null) + { + bridge.AddJoinMap(Key, joinMap); + } + + var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); + + if (customJoins != null) + { + joinMap.SetCustomJoinData(customJoins); + } + + Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); + Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); + + // TODO [ ] Implement bridge links as needed + + // links to bridge + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + + trilist.OnlineStatusChange += (o, a) => + { + if (!a.DeviceOnLine) return; + + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + }; + } + + + #endregion + + } +} + diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs index 649c7e6..837eb2c 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs @@ -9,7 +9,7 @@ using PepperDash.Essentials.Core.Bridges; namespace EssentialsPluginTemplate { /// - /// Plugin device + /// Plugin device template for third party devices that use IBasicCommunication /// /// /// Rename the class to match the device plugin being developed. @@ -17,15 +17,26 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" /// - public class EssentialsPluginDeviceTemplate : EssentialsBridgeableDevice - { - // TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed + public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice + { + /// + /// It is often desirable to store the config + /// + private EssentialsPluginConfigObjectTemplate _config; + + #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 @@ -33,7 +44,6 @@ namespace EssentialsPluginTemplate private byte[] _commsByteBuffer = { }; - private EssentialsPluginConfigObjectTemplate _config; /// /// Connects/disconnects the comms of the plugin device @@ -75,13 +85,13 @@ namespace EssentialsPluginTemplate public IntFeedback StatusFeedback { get; private set; } /// - /// Plugin device constructor + /// Plugin device constructor for devices that need IBasicCommunication /// /// /// /// /// - public EssentialsPluginDeviceTemplate(string key, string name, EssentialsPluginConfigObjectTemplate config, IBasicCommunication comms) + public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, IBasicCommunication comms) : base(key, name) { Debug.Console(0, this, "Constructing new {0} instance", name); @@ -103,79 +113,28 @@ namespace EssentialsPluginTemplate // device comms is IP **ELSE** device comms is RS232 socket.ConnectionChange += socket_ConnectionChange; Connect = true; - } + } - // _comms gather for ASCII based API's - // TODO [ ] If not using an ASCII based API, delete the properties below + #region Communication data event handlers. Comment out any that don't apply to the API type + + // Only one of the below handlers should be necessary. + + // _comms gather for any API that has a defined delimiter + // TODO [ ] If not using an ASCII based API, remove the line below _commsGather = new CommunicationGather(_comms, CommsDelimiter); - AddPostActivationAction(() => _commsGather.LineReceived += Handle_LineRecieved); + _commsGather.LineReceived += Handle_LineRecieved; - // _comms byte buffer for HEX/byte based API's - // TODO [ ] If not using an HEX/byte based API, delete the properties below + // _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; - AddPostActivationAction(() => _comms.BytesReceived += Handle_BytesReceived); - } - #region Overrides of EssentialsBridgeableDevice + // _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; - /// - /// Links the plugin device to the EISC bridge - /// - /// - /// - /// - /// - public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) - { - var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); + #endregion + } - // This adds the join map to the collection on the bridge - if (bridge != null) - { - bridge.AddJoinMap(Key, joinMap); - } - - var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); - - if (customJoins != null) - { - joinMap.SetCustomJoinData(customJoins); - } - - Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); - Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); - - // TODO [ ] Implement bridge links as needed - - // links to bridge - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - - trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig); - ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]); - - StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]); - OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]); - - UpdateFeedbacks(); - - trilist.OnlineStatusChange += (o, a) => - { - if (!a.DeviceOnLine) return; - - trilist.SetString(joinMap.DeviceName.JoinNumber, Name); - UpdateFeedbacks(); - }; - } - - private void UpdateFeedbacks() - { - // TODO [ ] Update as needed for the plugin being developed - ConnectFeedback.FireUpdate(); - OnlineFeedback.FireUpdate(); - StatusFeedback.FireUpdate(); - } - - #endregion private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) { @@ -186,20 +145,28 @@ namespace EssentialsPluginTemplate StatusFeedback.FireUpdate(); } - // TODO [ ] If not using an ASCII based API, delete the properties below + // TODO [ ] If not using an API with a delimeter, delete the method below private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args) { // TODO [ ] Implement method throw new System.NotImplementedException(); } - // TODO [ ] If not using an HEX/byte based API, delete the properties 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 ACII based API, delete the properties below /// /// Sends text to the device plugin comms @@ -239,8 +206,74 @@ namespace EssentialsPluginTemplate 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 EssentialsPluginBridgeJoinMapTemplate(joinStart); + + // This adds the join map to the collection on the bridge + if (bridge != null) + { + bridge.AddJoinMap(Key, joinMap); + } + + var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); + + if (customJoins != null) + { + joinMap.SetCustomJoinData(customJoins); + } + + Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); + Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); + + // TODO [ ] Implement bridge links as needed + + // links to bridge + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + + trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig); + ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]); + + StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]); + OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]); + + UpdateFeedbacks(); + + trilist.OnlineStatusChange += (o, a) => + { + if (!a.DeviceOnLine) return; + + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + UpdateFeedbacks(); + }; + } + + private void UpdateFeedbacks() + { + // TODO [ ] Update as needed for the plugin being developed + ConnectFeedback.FireUpdate(); + OnlineFeedback.FireUpdate(); + StatusFeedback.FireUpdate(); + } + + #endregion + + } } diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs index 76e5baa..8cfa212 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs @@ -1,19 +1,20 @@ using System.Collections.Generic; using PepperDash.Core; using PepperDash.Essentials.Core; +using Crestron.SimplSharpPro.UI; namespace EssentialsPluginTemplate { /// - /// Plugin device factory + /// Plugin device factory for devices that use IBasicCommunication /// /// /// Rename the class to match the device plugin being developed /// /// - /// "EssentialsPluginFactoryTemplate" renamed to "SamsungMdcFactory" + /// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory" /// - public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory + public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -22,14 +23,14 @@ namespace EssentialsPluginTemplate /// Update the MinimumEssentialsFrameworkVersion & TypeNames as needed when creating a plugin /// /// + /// Set the minimum Essentials Framework Version /// - /// // Set the minimum Essentials Framework Version - /// MinimumEssentialsFrameworkVersion = "1.5.5"; - /// // In the constructor we initialize the list with the typenames that will build an instance of this device -#pragma warning disable 1570 + /// 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" }; -#pragma warning restore 1570 - /// + /// /// public EssentialsPluginFactoryTemplate() { @@ -54,39 +55,185 @@ namespace EssentialsPluginTemplate /// 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); + 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 + // 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; - } + if (propertiesConfig == null) + { + Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); + return null; + } - // TODO [ ] Discuss with Andrew/Neil on recommended best practice - - // Method 1 - //var username = dc.Properties["control"].Value("tcpSshProperties").Username; - //var password = dc.Properties["control"].Value("tcpSshProperties").Password; - //var method = dc.Properties["control"].Value("method"); - - // Method 2 - Returns a JValue, has to be casted to string - var username = (string)dc.Properties["control"]["tcpSshProperties"]["username"]; - var password = (string)dc.Properties["control"]["tcpSshProperties"]["password"]; - var method = (string)dc.Properties["control"]["method"]; - - // build the plugin device comms & 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(0, "[{0}] Factory: failed to create comm 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); + } - return new EssentialsPluginDeviceTemplate(dc.Key, dc.Name, propertiesConfig, comms); } } -} \ No newline at end of file + + /// + /// 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 EssentialsPluginFactoryLogicDeviceTemplate : 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 EssentialsPluginFactoryLogicDeviceTemplate() + { + // 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 EssentialsPluginFactoryCrestronDeviceTemplate : 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 EssentialsPluginFactoryCrestronDeviceTemplate() + { + // 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() { "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/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs new file mode 100644 index 0000000..eda5ad0 --- /dev/null +++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs @@ -0,0 +1,86 @@ +using Crestron.SimplSharpPro.DeviceSupport; +using PepperDash.Core; +using PepperDash.Essentials.Core; +using PepperDash.Essentials.Core.Bridges; + +namespace EssentialsPluginTemplate +{ + /// + /// Plugin device template for logic devices that don't communicate outside the program + /// + /// + /// Rename the class to match the device plugin being developed. + /// + /// + /// "EssentialsPluginTemplateLogicDevice" renamed to "SamsungMdcDevice" + /// + public class EssentialsPluginTemplateLogicDevice : EssentialsBridgeableDevice + { + /// + /// It is often desirable to store the config + /// + private EssentialsPluginConfigObjectTemplate _config; + + /// + /// Plugin device constructor + /// + /// + /// + /// + public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginConfigObjectTemplate config) + : base(key, name) + { + Debug.Console(0, this, "Constructing new {0} instance", name); + + // TODO [ ] Update the constructor as needed for the plugin device being developed + + _config = config; + } + + #region Overrides of EssentialsBridgeableDevice + + /// + /// Links the plugin device to the EISC bridge + /// + /// + /// + /// + /// + public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) + { + var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); + + // This adds the join map to the collection on the bridge + if (bridge != null) + { + bridge.AddJoinMap(Key, joinMap); + } + + var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey); + + if (customJoins != null) + { + joinMap.SetCustomJoinData(customJoins); + } + + Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); + Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name); + + // TODO [ ] Implement bridge links as needed + + // links to bridge + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + + trilist.OnlineStatusChange += (o, a) => + { + if (!a.DeviceOnLine) return; + + trilist.SetString(joinMap.DeviceName.JoinNumber, Name); + }; + } + + #endregion + + } +} + diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj index 6517361..6dd00f2 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj +++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj @@ -46,6 +46,10 @@ off + + False + ..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll + False ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll @@ -95,6 +99,8 @@ + + diff --git a/README.md b/README.md index 9447de4..67a4614 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,15 @@ Provided under MIT license 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: +* `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 `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. + ## Cloning Instructions After forking this repository into your own GitHub space, you can create a new repository using this one as the template. Then you must install the necessary dependencies as indicated below.