fix: update template repo

1. update workflow files
2. Add 3-series SLN and csproj files
- Remove from project when using the template if not needed
3. Update 4-series SLN and csproj files
4. Moved SLN's to root of project
5. Rename *.cs files to identify naming convention of 'MakeModel'
6. Upate packages.config to reference latest Essentials v1 release
This commit is contained in:
jdevito
2025-01-30 16:39:56 -06:00
parent 7c3c0bea71
commit 85d2e4e1dc
14 changed files with 579 additions and 573 deletions

View File

@@ -9,6 +9,7 @@ jobs:
getVersion: getVersion:
uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-getversion.yml@main uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-getversion.yml@main
secrets: inherit secrets: inherit
build-3Series: build-3Series:
uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-3Series-builds.yml@main uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-3Series-builds.yml@main
secrets: inherit secrets: inherit
@@ -19,6 +20,7 @@ jobs:
version: ${{ needs.getVersion.outputs.version }} version: ${{ needs.getVersion.outputs.version }}
tag: ${{ needs.getVersion.outputs.tag }} tag: ${{ needs.getVersion.outputs.tag }}
channel: ${{ needs.getVersion.outputs.channel }} channel: ${{ needs.getVersion.outputs.channel }}
build-4Series: build-4Series:
uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-4Series-builds.yml@main uses: PepperDash/workflow-templates/.github/workflows/essentialsplugins-4Series-builds.yml@main
secrets: inherit secrets: inherit

View File

@@ -0,0 +1,20 @@
Microsoft Visual Studio Solution File, Format Version 10.00
# Visual Studio 2008
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "epi-make-model.3Series", "src\epi-make-model.3Series.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU
{9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU
{9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
EndGlobal

View File

@@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17 # Visual Studio Version 17
VisualStudioVersion = 17.11.35327.3 VisualStudioVersion = 17.11.35327.3
MinimumVisualStudioVersion = 10.0.40219.1 MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PDT.EssentialsPluginTemplate.EPI.4Series.", "src\PDT.EssentialsPluginTemplate.EPI.4Series..csproj", "{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}" Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "epi-make-model.4Series", "src\epi-make-model.4Series.csproj", "{52E6E0A0-A710-4B5F-AF52-08816F5C99BB}"
EndProject EndProject
Global Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution GlobalSection(SolutionConfigurationPlatforms) = preSolution

View File

@@ -1,3 +1,3 @@
<packages> <packages>
<package id="PepperDashEssentials" version="1.10.2" targetFramework="net35" allowedVersions="[1.0,2.0)"/> <package id="PepperDashEssentials" version="1.16.1" targetFramework="net35" allowedVersions="[1.0,2.0)"/>
</packages> </packages>

View File

@@ -5,7 +5,7 @@
<Authors>PepperDash Technologies</Authors> <Authors>PepperDash Technologies</Authors>
<Company>PepperDash Technologies</Company> <Company>PepperDash Technologies</Company>
<Product>PepperDash Essentials Plugin Template</Product> <Product>PepperDash Essentials Plugin Template</Product>
<Copyright>Copyright © 2024</Copyright> <Copyright>Copyright © 2025</Copyright>
<RepositoryUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</RepositoryUrl> <RepositoryUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</RepositoryUrl>
<RepositoryType>git</RepositoryType> <RepositoryType>git</RepositoryType>
<PackageTags>Crestron; 4series</PackageTags> <PackageTags>Crestron; 4series</PackageTags>

View File

@@ -1,101 +1,101 @@
using PepperDash.Essentials.Core; using PepperDash.Essentials.Core;
namespace EssentialsPluginTemplate namespace PepperDash.Essentials.Plugin
{ {
/// <summary> /// <summary>
/// Plugin device Bridge Join Map /// Plugin device Bridge Join Map
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Rename the class to match the device plugin being developed. Reference Essentials JoinMaps, if one exists for the device plugin being developed /// Rename the class to match the device plugin being developed. Reference Essentials JoinMaps, if one exists for the device plugin being developed
/// </remarks> /// </remarks>
/// <see cref="PepperDash.Essentials.Core.Bridges"/> /// <see cref="PepperDash.Essentials.Core.Bridges"/>
/// <example> /// <example>
/// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap" /// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap"
/// </example> /// </example>
public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced
{ {
#region Digital #region Digital
// TODO [ ] Add digital joins below plugin being developed // TODO [ ] Add digital joins below plugin being developed
[JoinName("IsOnline")] [JoinName("IsOnline")]
public JoinDataComplete IsOnline = new JoinDataComplete( public JoinDataComplete IsOnline = new JoinDataComplete(
new JoinData new JoinData
{ {
JoinNumber = 1, JoinNumber = 1,
JoinSpan = 1 JoinSpan = 1
}, },
new JoinMetadata new JoinMetadata
{ {
Description = "Is Online", Description = "Is Online",
JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinCapabilities = eJoinCapabilities.ToSIMPL,
JoinType = eJoinType.Digital JoinType = eJoinType.Digital
}); });
[JoinName("Connect")] [JoinName("Connect")]
public JoinDataComplete Connect = new JoinDataComplete( public JoinDataComplete Connect = new JoinDataComplete(
new JoinData new JoinData
{ {
JoinNumber = 2, JoinNumber = 2,
JoinSpan = 1 JoinSpan = 1
}, },
new JoinMetadata new JoinMetadata
{ {
Description = "Connect (Held)/Disconnect (Release) & corresponding feedback", Description = "Connect (Held)/Disconnect (Release) & corresponding feedback",
JoinCapabilities = eJoinCapabilities.ToFromSIMPL, JoinCapabilities = eJoinCapabilities.ToFromSIMPL,
JoinType = eJoinType.Digital JoinType = eJoinType.Digital
}); });
#endregion #endregion
#region Analog #region Analog
// TODO [ ] Add analog joins below plugin being developed // TODO [ ] Add analog joins below plugin being developed
[JoinName("Status")] [JoinName("Status")]
public JoinDataComplete Status = new JoinDataComplete( public JoinDataComplete Status = new JoinDataComplete(
new JoinData new JoinData
{ {
JoinNumber = 1, JoinNumber = 1,
JoinSpan = 1 JoinSpan = 1
}, },
new JoinMetadata new JoinMetadata
{ {
Description = "Socket Status", Description = "Socket Status",
JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinCapabilities = eJoinCapabilities.ToSIMPL,
JoinType = eJoinType.Analog JoinType = eJoinType.Analog
}); });
#endregion #endregion
#region Serial #region Serial
// TODO [ ] Add serial joins below plugin being developed // TODO [ ] Add serial joins below plugin being developed
public JoinDataComplete DeviceName = new JoinDataComplete( public JoinDataComplete DeviceName = new JoinDataComplete(
new JoinData new JoinData
{ {
JoinNumber = 1, JoinNumber = 1,
JoinSpan = 1 JoinSpan = 1
}, },
new JoinMetadata new JoinMetadata
{ {
Description = "Device Name", Description = "Device Name",
JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinCapabilities = eJoinCapabilities.ToSIMPL,
JoinType = eJoinType.Serial JoinType = eJoinType.Serial
}); });
#endregion #endregion
/// <summary> /// <summary>
/// Plugin device BridgeJoinMap constructor /// Plugin device BridgeJoinMap constructor
/// </summary> /// </summary>
/// <param name="joinStart">This will be the join it starts on the EISC bridge</param> /// <param name="joinStart">This will be the join it starts on the EISC bridge</param>
public EssentialsPluginTemplateBridgeJoinMap(uint joinStart) public EssentialsPluginTemplateBridgeJoinMap(uint joinStart)
: base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap)) : base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap))
{ {
} }
} }
} }

View File

@@ -1,8 +1,8 @@
using System.Collections.Generic; using System.Collections.Generic;
using Newtonsoft.Json; using Newtonsoft.Json;
using PepperDash.Essentials.Core; using PepperDash.Essentials.Core;
namespace EssentialsPluginTemplate namespace PepperDash.Essentials.Plugin
{ {
/// <summary> /// <summary>
/// Plugin device configuration object /// Plugin device configuration object

View File

@@ -1,13 +1,13 @@
// For Basic SIMPL# Classes // For Basic SIMPL# Classes
// For Basic SIMPL#Pro classes // For Basic SIMPL#Pro classes
using Crestron.SimplSharpPro.DeviceSupport; using Crestron.SimplSharpPro;
using Crestron.SimplSharpPro; using Crestron.SimplSharpPro.DeviceSupport;
using PepperDash.Core; using PepperDash.Core;
using PepperDash.Essentials.Core; using PepperDash.Essentials.Core;
using PepperDash.Essentials.Core.Bridges; using PepperDash.Essentials.Core.Bridges;
namespace EssentialsPluginTemplate namespace PepperDash.Essentials.Plugin
{ {
/// <summary> /// <summary>
/// Plugin device /// Plugin device

View File

@@ -1,299 +1,298 @@
// For Basic SIMPL# Classes // For Basic SIMPL# Classes
// For Basic SIMPL#Pro classes // For Basic SIMPL#Pro classes
using Crestron.SimplSharpPro.DeviceSupport; using Crestron.SimplSharpPro.DeviceSupport;
using PepperDash.Core; using PepperDash.Core;
using PepperDash.Essentials.Core; using PepperDash.Essentials.Core;
using PepperDash.Essentials.Core.Bridges; using PepperDash.Essentials.Core.Bridges;
using PepperDash.Essentials.Core.Queues; using PepperDash.Essentials.Core.Queues;
namespace PepperDash.Essentials.Plugin
namespace EssentialsPluginTemplate {
{ /// <summary>
/// <summary> /// Plugin device template for third party devices that use IBasicCommunication
/// Plugin device template for third party devices that use IBasicCommunication /// </summary>
/// </summary> /// <remarks>
/// <remarks> /// Rename the class to match the device plugin being developed.
/// Rename the class to match the device plugin being developed. /// </remarks>
/// </remarks> /// <example>
/// <example> /// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice"
/// "EssentialsPluginDeviceTemplate" renamed to "SamsungMdcDevice" /// </example>
/// </example> public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice
public class EssentialsPluginTemplateDevice : EssentialsBridgeableDevice {
{ /// <summary>
/// <summary> /// It is often desirable to store the config
/// It is often desirable to store the config /// </summary>
/// </summary> private EssentialsPluginTemplateConfigObject _config;
private EssentialsPluginTemplateConfigObject _config;
/// <summary>
/// <summary> /// Provides a queue and dedicated worker thread for processing feedback messages from a device.
/// Provides a queue and dedicated worker thread for processing feedback messages from a device. /// </summary>
/// </summary> private GenericQueue ReceiveQueue;
private 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
// TODO [ ] Add, modify, remove properties and fields as needed for the plugin being developed private readonly IBasicCommunication _comms;
private readonly IBasicCommunication _comms; private readonly GenericCommunicationMonitor _commsMonitor;
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
// TODO [ ] If not using an ASCII based API, delete the properties below private readonly CommunicationGather _commsGather;
private readonly CommunicationGather _commsGather;
/// <summary>
/// <summary> /// Set this value to that of the delimiter used by the API (if applicable)
/// Set this value to that of the delimiter used by the API (if applicable) /// </summary>
/// </summary> private const string CommsDelimiter = "\r";
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
// TODO [ ] If not using an HEX/byte based API, delete the properties below private byte[] _commsByteBuffer = { };
private byte[] _commsByteBuffer = { };
/// <summary>
/// <summary> /// Connects/disconnects the comms of the plugin device
/// Connects/disconnects the comms of the plugin device /// </summary>
/// </summary> /// <remarks>
/// <remarks> /// 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 /// </remarks>
/// </remarks> public bool Connect
public bool Connect {
{ get { return _comms.IsConnected; }
get { return _comms.IsConnected; } set
set {
{ if (value)
if (value) {
{ _comms.Connect();
_comms.Connect(); _commsMonitor.Start();
_commsMonitor.Start(); }
} else
else {
{ _comms.Disconnect();
_comms.Disconnect(); _commsMonitor.Stop();
_commsMonitor.Stop(); }
} }
} }
}
/// <summary>
/// <summary> /// Reports connect feedback through the bridge
/// Reports connect feedback through the bridge /// </summary>
/// </summary> public BoolFeedback ConnectFeedback { get; private set; }
public BoolFeedback ConnectFeedback { get; private set; }
/// <summary>
/// <summary> /// Reports online feedback through the bridge
/// Reports online feedback through the bridge /// </summary>
/// </summary> public BoolFeedback OnlineFeedback { get; private set; }
public BoolFeedback OnlineFeedback { get; private set; }
/// <summary>
/// <summary> /// Reports socket status feedback through the bridge
/// Reports socket status feedback through the bridge /// </summary>
/// </summary> public IntFeedback StatusFeedback { get; private set; }
public IntFeedback StatusFeedback { get; private set; }
/// <summary>
/// <summary> /// Plugin device constructor for devices that need IBasicCommunication
/// Plugin device constructor for devices that need IBasicCommunication /// </summary>
/// </summary> /// <param name="key"></param>
/// <param name="key"></param> /// <param name="name"></param>
/// <param name="name"></param> /// <param name="config"></param>
/// <param name="config"></param> /// <param name="comms"></param>
/// <param name="comms"></param> public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms)
public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) : base(key, name)
: base(key, name) {
{ Debug.Console(0, this, "Constructing new {0} instance", name);
Debug.Console(0, this, "Constructing new {0} instance", name);
// TODO [ ] Update the constructor as needed for the plugin device being developed
// TODO [ ] Update the constructor as needed for the plugin device being developed
_config = config;
_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);
ConnectFeedback = new BoolFeedback(() => Connect); OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline);
OnlineFeedback = new BoolFeedback(() => _commsMonitor.IsOnline); StatusFeedback = new IntFeedback(() => (int)_commsMonitor.Status);
StatusFeedback = new IntFeedback(() => (int)_commsMonitor.Status);
_comms = comms;
_comms = comms; _commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll);
_commsMonitor = new GenericCommunicationMonitor(this, _comms, _config.PollTimeMs, _config.WarningTimeoutMs, _config.ErrorTimeoutMs, Poll);
var socket = _comms as ISocketStatus;
var socket = _comms as ISocketStatus; if (socket != null)
if (socket != null) {
{ // device comms is IP **ELSE** device comms is RS232
// device comms is IP **ELSE** device comms is RS232 socket.ConnectionChange += socket_ConnectionChange;
socket.ConnectionChange += socket_ConnectionChange; Connect = true;
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
// TODO [ ] If not using an ASCII based API, remove the line below _commsGather = new CommunicationGather(_comms, CommsDelimiter);
_commsGather = new CommunicationGather(_comms, CommsDelimiter); _commsGather.LineReceived += Handle_LineRecieved;
_commsGather.LineReceived += Handle_LineRecieved;
// _comms byte buffer for HEX/byte based API's with no delimiter
// _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
// TODO [ ] If not using an HEX/byte based API, remove the line below _comms.BytesReceived += Handle_BytesReceived;
_comms.BytesReceived += Handle_BytesReceived;
// _comms byte buffer for HEX/byte based API's with no delimiter
// _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
// TODO [ ] If not using an HEX/byte based API, remove the line below _comms.TextReceived += Handle_TextReceived;
_comms.TextReceived += Handle_TextReceived;
#endregion
#endregion }
}
private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args)
private void socket_ConnectionChange(object sender, GenericSocketStatusChageEventArgs args) {
{ if (ConnectFeedback != null)
if (ConnectFeedback != null) ConnectFeedback.FireUpdate();
ConnectFeedback.FireUpdate();
if (StatusFeedback != null)
if (StatusFeedback != null) StatusFeedback.FireUpdate();
StatusFeedback.FireUpdate(); }
}
// TODO [ ] If not using an API with a delimeter, delete the method below
// TODO [ ] If not using an API with a delimeter, delete the method below private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args)
private void Handle_LineRecieved(object sender, GenericCommMethodReceiveTextArgs args) {
{ // TODO [ ] Implement method
// TODO [ ] Implement method
// Enqueues the message to be processed in a dedicated thread, but the specified method
// Enqueues the message to be processed in a dedicated thread, but the specified method ReceiveQueue.Enqueue(new ProcessStringMessage(args.Text, ProcessFeedbackMessage));
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)
private void Handle_BytesReceived(object sender, GenericCommMethodReceiveBytesArgs args) {
{ // TODO [ ] Implement method
// TODO [ ] Implement method throw new System.NotImplementedException();
throw new System.NotImplementedException(); }
}
// TODO [ ] If not using an ASCII based API with no delimeter, delete the method below
// TODO [ ] If not using an ASCII based API with no delimeter, delete the method below void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e)
void Handle_TextReceived(object sender, GenericCommMethodReceiveTextArgs e) {
{ // TODO [ ] Implement method
// TODO [ ] Implement method throw new System.NotImplementedException();
throw new System.NotImplementedException(); }
}
/// <summary>
/// <summary> /// This method should perform any necessary parsing of feedback messages from the device
/// This method should perform any necessary parsing of feedback messages from the device /// </summary>
/// </summary> /// <param name="message"></param>
/// <param name="message"></param> void ProcessFeedbackMessage(string message)
void ProcessFeedbackMessage(string message) {
{
}
}
// TODO [ ] If not using an ACII based API, delete the properties below
// TODO [ ] If not using an ACII based API, delete the properties below /// <summary>
/// <summary> /// Sends text to the device plugin comms
/// Sends text to the device plugin comms /// </summary>
/// </summary> /// <remarks>
/// <remarks> /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
/// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands /// </remarks>
/// </remarks> /// <param name="text">Command to be sent</param>
/// <param name="text">Command to be sent</param> public void SendText(string text)
public void SendText(string text) {
{ if (string.IsNullOrEmpty(text)) return;
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
// TODO [ ] If not using an HEX/byte based API, delete the properties below /// <summary>
/// <summary> /// Sends bytes to the device plugin comms
/// Sends bytes to the device plugin comms /// </summary>
/// </summary> /// <remarks>
/// <remarks> /// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands
/// Can be used to test commands with the device plugin using the DEVPROPS and DEVJSON console commands /// </remarks>
/// </remarks> /// <param name="bytes">Bytes to be sent</param>
/// <param name="bytes">Bytes to be sent</param> public void SendBytes(byte[] bytes)
public void SendBytes(byte[] bytes) {
{ if (bytes == null) return;
if (bytes == null) return;
_comms.SendBytes(bytes);
_comms.SendBytes(bytes); }
}
/// <summary>
/// <summary> /// Polls the device
/// Polls the device /// </summary>
/// </summary> /// <remarks>
/// <remarks> /// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed
/// Poll method is used by the communication monitor. Update the poll method as needed for the plugin being developed /// </remarks>
/// </remarks> public void Poll()
public void Poll() {
{ // TODO [ ] Update Poll method as needed for the plugin being developed
// TODO [ ] Update Poll method as needed for the plugin being developed // Example: SendText("getstatus");
// Example: SendText("getstatus"); throw new System.NotImplementedException();
throw new System.NotImplementedException(); }
}
#endregion
#endregion
#region Overrides of EssentialsBridgeableDevice
#region Overrides of EssentialsBridgeableDevice
/// <summary>
/// <summary> /// Links the plugin device to the EISC bridge
/// Links the plugin device to the EISC bridge /// </summary>
/// </summary> /// <param name="trilist"></param>
/// <param name="trilist"></param> /// <param name="joinStart"></param>
/// <param name="joinStart"></param> /// <param name="joinMapKey"></param>
/// <param name="joinMapKey"></param> /// <param name="bridge"></param>
/// <param name="bridge"></param> public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) {
{ var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart);
// This adds the join map to the collection on the bridge
// This adds the join map to the collection on the bridge if (bridge != null)
if (bridge != null) {
{ bridge.AddJoinMap(Key, joinMap);
bridge.AddJoinMap(Key, joinMap); }
}
var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
var customJoins = JoinMapHelper.TryGetJoinMapAdvancedForDevice(joinMapKey);
if (customJoins != null)
if (customJoins != null) {
{ joinMap.SetCustomJoinData(customJoins);
joinMap.SetCustomJoinData(customJoins); }
}
Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X"));
Debug.Console(1, "Linking to Trilist '{0}'", trilist.ID.ToString("X")); Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
Debug.Console(0, "Linking to Bridge Type {0}", GetType().Name);
// TODO [ ] Implement bridge links as needed
// TODO [ ] Implement bridge links as needed
// links to bridge
// links to bridge trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig);
trilist.SetBoolSigAction(joinMap.Connect.JoinNumber, sig => Connect = sig); ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]);
ConnectFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Connect.JoinNumber]);
StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]);
StatusFeedback.LinkInputSig(trilist.UShortInput[joinMap.Status.JoinNumber]); OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]);
OnlineFeedback.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]);
UpdateFeedbacks();
UpdateFeedbacks();
trilist.OnlineStatusChange += (o, a) =>
trilist.OnlineStatusChange += (o, a) => {
{ if (!a.DeviceOnLine) return;
if (!a.DeviceOnLine) return;
trilist.SetString(joinMap.DeviceName.JoinNumber, Name);
trilist.SetString(joinMap.DeviceName.JoinNumber, Name); UpdateFeedbacks();
UpdateFeedbacks(); };
}; }
}
private void UpdateFeedbacks()
private void UpdateFeedbacks() {
{ // TODO [ ] Update as needed for the plugin being developed
// TODO [ ] Update as needed for the plugin being developed ConnectFeedback.FireUpdate();
ConnectFeedback.FireUpdate(); OnlineFeedback.FireUpdate();
OnlineFeedback.FireUpdate(); StatusFeedback.FireUpdate();
StatusFeedback.FireUpdate(); }
}
#endregion
#endregion
}
} }
}

View File

@@ -1,9 +1,9 @@
using System.Collections.Generic; using System.Collections.Generic;
using PepperDash.Core; using Crestron.SimplSharpPro.UI;
using PepperDash.Essentials.Core; using PepperDash.Core;
using Crestron.SimplSharpPro.UI; using PepperDash.Essentials.Core;
namespace EssentialsPluginTemplate namespace PepperDash.Essentials.Plugin
{ {
/// <summary> /// <summary>
/// Plugin device factory for devices that use IBasicCommunication /// Plugin device factory for devices that use IBasicCommunication

View File

@@ -1,9 +1,9 @@
using Crestron.SimplSharpPro.DeviceSupport; using Crestron.SimplSharpPro.DeviceSupport;
using PepperDash.Core; using PepperDash.Core;
using PepperDash.Essentials.Core; using PepperDash.Essentials.Core;
using PepperDash.Essentials.Core.Bridges; using PepperDash.Essentials.Core.Bridges;
namespace EssentialsPluginTemplate namespace PepperDash.Essentials.Plugin
{ {
/// <summary> /// <summary>
/// Plugin device template for logic devices that don't communicate outside the program /// Plugin device template for logic devices that don't communicate outside the program

View File

@@ -1,23 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<package >
<metadata>
<id>PDT.EssentialsPluginTemplate</id>
<readme>docs\README.md</readme>
<version>2.0.2</version>
<title>Essentials Plugin Template</title>
<authors>PepperDash Technologies</authors>
<owners>pepperdash</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">MIT</license>
<projectUrl>https://github.com/PepperDash/EssentialsPluginTemplate</projectUrl>
<copyright>Copyright 2022</copyright>
<description>This software iserves as a template for generating new Essentials-Compliant plugins</description>
<tags>crestron 3series 4series essentials pepperdash pepperdashessentials epi essentials plugin</tags>
<repository type="git" url="https://github.com/PepperDash/EssentialsPluginTemplate"/>
</metadata>
<files>
<file src="**" target="lib\net35"/>
<file src="**" target="lib\net47"/>
<file src="README.md" target="docs\"/>
</files>
</package>

View File

@@ -1,115 +1,115 @@
<Project ToolsVersion="3.5" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> <Project ToolsVersion="3.5" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup> <PropertyGroup>
<Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration> <Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform> <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<ProductVersion>9.0.30729</ProductVersion> <ProductVersion>9.0.30729</ProductVersion>
<SchemaVersion>2.0</SchemaVersion> <SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>{9D249E47-8F95-4437-A6BB-563510287AD1}</ProjectGuid> <ProjectGuid>{9D249E47-8F95-4437-A6BB-563510287AD1}</ProjectGuid>
<OutputType>Library</OutputType> <OutputType>Library</OutputType>
<AppDesignerFolder>Properties</AppDesignerFolder> <AppDesignerFolder>Properties</AppDesignerFolder>
<RootNamespace>PDT.EssentialsPluginTemplate.EPI</RootNamespace> <RootNamespace>PepperDash.Essentials.Plugin</RootNamespace>
<AssemblyName>PDT.EssentialsPluginTemplate.EPI</AssemblyName> <AssemblyName>MakeModelPlugin</AssemblyName>
<ProjectTypeGuids>{0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids> <ProjectTypeGuids>{0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>
<PlatformFamilyName>WindowsCE</PlatformFamilyName> <PlatformFamilyName>WindowsCE</PlatformFamilyName>
<PlatformID>E2BECB1F-8C8C-41ba-B736-9BE7D946A398</PlatformID> <PlatformID>E2BECB1F-8C8C-41ba-B736-9BE7D946A398</PlatformID>
<OSVersion>5.0</OSVersion> <OSVersion>5.0</OSVersion>
<DeployDirSuffix>SmartDeviceProject1</DeployDirSuffix> <DeployDirSuffix>SmartDeviceProject1</DeployDirSuffix>
<TargetFrameworkVersion>v3.5</TargetFrameworkVersion> <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
<NativePlatformName>Windows CE</NativePlatformName> <NativePlatformName>Windows CE</NativePlatformName>
<FormFactorID> <FormFactorID>
</FormFactorID> </FormFactorID>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' "> <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
<AllowedReferenceRelatedFileExtensions>.allowedReferenceRelatedFileExtensions</AllowedReferenceRelatedFileExtensions> <AllowedReferenceRelatedFileExtensions>.allowedReferenceRelatedFileExtensions</AllowedReferenceRelatedFileExtensions>
<DebugSymbols>true</DebugSymbols> <DebugSymbols>true</DebugSymbols>
<DebugType>full</DebugType> <DebugType>full</DebugType>
<Optimize>false</Optimize> <Optimize>false</Optimize>
<OutputPath>bin\Debug\</OutputPath> <OutputPath>bin\Debug\</OutputPath>
<DefineConstants>DEBUG;TRACE;</DefineConstants> <DefineConstants>DEBUG;TRACE;</DefineConstants>
<ErrorReport>prompt</ErrorReport> <ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel> <WarningLevel>4</WarningLevel>
<FileAlignment>512</FileAlignment> <FileAlignment>512</FileAlignment>
<NoStdLib>true</NoStdLib> <NoStdLib>true</NoStdLib>
<NoConfig>true</NoConfig> <NoConfig>true</NoConfig>
<GenerateSerializationAssemblies>off</GenerateSerializationAssemblies> <GenerateSerializationAssemblies>off</GenerateSerializationAssemblies>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' "> <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<AllowedReferenceRelatedFileExtensions>.allowedReferenceRelatedFileExtensions</AllowedReferenceRelatedFileExtensions> <AllowedReferenceRelatedFileExtensions>.allowedReferenceRelatedFileExtensions</AllowedReferenceRelatedFileExtensions>
<DebugType>none</DebugType> <DebugType>none</DebugType>
<Optimize>true</Optimize> <Optimize>true</Optimize>
<OutputPath>bin\Release\</OutputPath> <OutputPath>bin\Release\</OutputPath>
<ErrorReport>prompt</ErrorReport> <ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel> <WarningLevel>4</WarningLevel>
<FileAlignment>512</FileAlignment> <FileAlignment>512</FileAlignment>
<NoStdLib>true</NoStdLib> <NoStdLib>true</NoStdLib>
<NoConfig>true</NoConfig> <NoConfig>true</NoConfig>
<GenerateSerializationAssemblies>off</GenerateSerializationAssemblies> <GenerateSerializationAssemblies>off</GenerateSerializationAssemblies>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<Reference Include="Crestron.SimplSharpPro.UI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <Reference Include="Crestron.SimplSharpPro.UI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll</HintPath> <HintPath>C:\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll</HintPath>
</Reference> </Reference>
<Reference Include="Essentials Devices Common, Version=1.6.2.33892, Culture=neutral, processorArchitecture=MSIL"> <Reference Include="Essentials Devices Common, Version=1.6.2.33892, Culture=neutral, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll</HintPath> <HintPath>..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll</HintPath>
</Reference> </Reference>
<Reference Include="mscorlib" /> <Reference Include="mscorlib" />
<Reference Include="PepperDashEssentials, Version=1.4.19.29953, Culture=neutral, processorArchitecture=MSIL"> <Reference Include="PepperDashEssentials, Version=1.4.19.29953, Culture=neutral, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll</HintPath> <HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll</HintPath>
</Reference> </Reference>
<Reference Include="PepperDash_Core, Version=1.0.20.28344, Culture=neutral, processorArchitecture=MSIL"> <Reference Include="PepperDash_Core, Version=1.0.20.28344, Culture=neutral, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll</HintPath> <HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll</HintPath>
</Reference> </Reference>
<Reference Include="PepperDash_Essentials_Core, Version=1.4.19.29946, Culture=neutral, processorArchitecture=MSIL"> <Reference Include="PepperDash_Essentials_Core, Version=1.4.19.29946, Culture=neutral, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll</HintPath> <HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll</HintPath>
</Reference> </Reference>
<Reference Include="PepperDash_Essentials_DM, Version=1.3.7177.29951, Culture=neutral, processorArchitecture=MSIL"> <Reference Include="PepperDash_Essentials_DM, Version=1.3.7177.29951, Culture=neutral, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll</HintPath> <HintPath>..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll</HintPath>
</Reference> </Reference>
<Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <Reference Include="SimplSharpCustomAttributesInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath> <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll</HintPath>
<Private>False</Private> <Private>False</Private>
</Reference> </Reference>
<Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <Reference Include="SimplSharpHelperInterface, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath> <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll</HintPath>
<Private>False</Private> <Private>False</Private>
</Reference> </Reference>
<Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <Reference Include="SimplSharpNewtonsoft, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll</HintPath> <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll</HintPath>
</Reference> </Reference>
<Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <Reference Include="SimplSharpPro, Version=1.5.3.17, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath> <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpPro.exe</HintPath>
<Private>False</Private> <Private>False</Private>
</Reference> </Reference>
<Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL"> <Reference Include="SimplSharpReflectionInterface, Version=1.0.5583.25238, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion> <SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll</HintPath> <HintPath>C:\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll</HintPath>
</Reference> </Reference>
<Reference Include="System" /> <Reference Include="System" />
<Reference Include="System.Core" /> <Reference Include="System.Core" />
<Reference Include="System.Data" /> <Reference Include="System.Data" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<Compile Include="EssentialsPluginTemplateLogicDevice.cs" /> <Compile Include="MakeModelCrestronDevice.cs" />
<Compile Include="EssentialsPluginTemplateCrestronDevice.cs" /> <Compile Include="MakeModelBridgeJoinMap.cs" />
<Compile Include="EssentialsPluginTemplateBridgeJoinMap.cs" /> <Compile Include="MakeModelConfigObject.cs" />
<Compile Include="EssentialsPluginTemplateConfigObject.cs" /> <Compile Include="MakeModelDevice.cs" />
<Compile Include="EssentialsPluginTemplateFactory.cs" /> <Compile Include="MakeModelFactory.cs" />
<Compile Include="Properties\AssemblyInfo.cs" /> <Compile Include="MakeModelLogicDevice.cs" />
<Compile Include="EssentialsPluginTemplateDevice.cs" /> <Compile Include="Properties\AssemblyInfo.cs" />
<None Include="Properties\ControlSystem.cfg" /> <None Include="Properties\ControlSystem.cfg" />
</ItemGroup> </ItemGroup>
<Import Project="$(MSBuildBinPath)\Microsoft.CompactFramework.CSharp.targets" /> <Import Project="$(MSBuildBinPath)\Microsoft.CompactFramework.CSharp.targets" />
<PropertyGroup> <PropertyGroup>
<PostBuildEvent>rem S# Pro preparation will execute after these operations</PostBuildEvent> <PostBuildEvent>rem S# Pro preparation will execute after these operations</PostBuildEvent>
</PropertyGroup> </PropertyGroup>
</Project> </Project>

View File

@@ -4,12 +4,12 @@
</PropertyGroup> </PropertyGroup>
<PropertyGroup> <PropertyGroup>
<TargetFramework>net472</TargetFramework> <TargetFramework>net472</TargetFramework>
<RootNamespace>PDT.EssentialsPluginTemplate.EPI</RootNamespace> <RootNamespace>PepperDash.Essentials.Plugin</RootNamespace>
<Deterministic>false</Deterministic> <Deterministic>false</Deterministic>
<AssemblyTitle>PDT.EssentialsPluginTemplate.EPI</AssemblyTitle> <AssemblyTitle>PepperDash.Essentials.Plugin.Make.Model</AssemblyTitle>
<Company>PepperDash Technologies</Company> <Company>PepperDash Technologies</Company>
<Description>This software is a template for a PepperDash Essentials Plugin.</Description> <Description>This software is a template for a PepperDash Essentials Plugin.</Description>
<Copyright>Copyright 2024</Copyright> <Copyright>Copyright 2025</Copyright>
<Version>1.0.0-local</Version> <Version>1.0.0-local</Version>
<GenerateAssemblyInfo>true</GenerateAssemblyInfo> <GenerateAssemblyInfo>true</GenerateAssemblyInfo>
<InformationalVersion>$(Version)</InformationalVersion> <InformationalVersion>$(Version)</InformationalVersion>
@@ -31,10 +31,18 @@
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<None Remove="PDT.EssentialsPluginTemplate.projectinfo" /> <None Remove="epi-make-model.projectinfo" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="PepperDashEssentials" Version="2.0.0-beta-2559" /> <PackageReference Include="PepperDashEssentials" Version="2.0.0-hotfix-2613" />
</ItemGroup> </ItemGroup>
<ItemGroup>
<None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" />
</ItemGroup>
<ItemGroup>
<None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" />
</ItemGroup>
</Project> </Project>