From caf2731dfbe40b18084a3689106b9c3c5f40a9f2 Mon Sep 17 00:00:00 2001
From: Neil Dorin <ndorin@pepperdash.com>
Date: Thu, 13 Feb 2020 12:40:23 -0700
Subject: [PATCH] Updates to add comments and better organize.  Updates to
 Github repo for submodule and to latest release version of Essentials
 (1.4.31)

---
 .gitmodules                                   |   2 +-
 EssentialsBuilds                              |   2 +-
 .../EssentailsPluginTemplate.cs               |  34 +++++++++-------
 .../EssentialsPluginTemplateConfigObject.cs   |  16 +++++++-
 .../EssentialsPluginTemplateDevice.cs         |  38 ++++++++++++++++++
 .../PDT.EssentialsPluginTemplate.EPI.csproj   |   1 +
 .../PDT.EssentialsPluginTemplate.EPI.suo      | Bin 23040 -> 22016 bytes
 .../PDT.EssentialsPluginTemplate.projectinfo  | Bin 0 -> 428 bytes
 8 files changed, 76 insertions(+), 17 deletions(-)
 create mode 100644 PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs
 create mode 100644 PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.projectinfo

diff --git a/.gitmodules b/.gitmodules
index 07e762c..726935e 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,3 +1,3 @@
 [submodule "EssentialsBuilds"]
 	path = EssentialsBuilds
-	url = https://bitbucket.org/Pepperdash_Products/essentials-builds.git
+url=https://github.com/PepperDash/Essentials-Builds.git
\ No newline at end of file
diff --git a/EssentialsBuilds b/EssentialsBuilds
index 2a6c167..855dccd 160000
--- a/EssentialsBuilds
+++ b/EssentialsBuilds
@@ -1 +1 @@
-Subproject commit 2a6c167efbd9b3770821d11effd846fabae4f8be
+Subproject commit 855dccd0d41aac272512f58d6bcd4764307bbb14
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentailsPluginTemplate.cs b/PDT.EssentialsPluginTemplate.EPI/EssentailsPluginTemplate.cs
index 07f6aa6..b80b595 100644
--- a/PDT.EssentialsPluginTemplate.EPI/EssentailsPluginTemplate.cs
+++ b/PDT.EssentialsPluginTemplate.EPI/EssentailsPluginTemplate.cs
@@ -12,29 +12,35 @@ using PepperDash.Core;
 
 namespace EssentialsPluginTemplateEPI 
 {
-	public class EssentialsPluginTemplate : Device
-
+	public class EssentialsPluginTemplate
 	{
+        /// <summary> 
+        /// This string is used to define the minimum version of the
+        /// Essentials Framework required for this plugin
+        /// </summary>
+        public static string MinimumEssentialsFrameworkVersion = "1.4.23";
+
+        /// <summary>
+        /// This method will get called by Essentials when this plugin is loaded.  
+        /// Use it to add factory methods for all new Device types defined in this plugin
+        /// </summary>
 		public static void LoadPlugin()
 		{
 			PepperDash.Essentials.Core.DeviceFactory.AddFactoryForType("EssentialsPluginTemplate", EssentialsPluginTemplate.BuildDevice);	
 		}
 
-		public static EssentialsPluginTemplate BuildDevice(DeviceConfig dc)
+        /// <summary>
+        /// Builds an instance of the device type
+        /// </summary>
+        /// <param name="dc">The device configuration</param>
+        /// <returns>The device</returns>
+		public static EssentialsPluginTemplateDevice BuildDevice(DeviceConfig dc)
 		{
-			var config = JsonConvert.DeserializeObject<EssentialsPluginTemplateConfigObject>(dc.Properties.ToString());
-			var newMe = new EssentialsPluginTemplate(dc.Key, dc.Name, config);
-			return newMe;
+			var config = JsonConvert.DeserializeObject<EssentialsPluginTemplatePropertiesConfig>(dc.Properties.ToString());
+			var newDevice = new EssentialsPluginTemplateDevice(dc.Key, dc.Name, config);
+			return newDevice;
 		}
 
-
-		GenericSecureTcpIpClient_ForServer Client;
-
-		public EssentialsPluginTemplate(string key, string name, EssentialsPluginTemplateConfigObject config)
-			: base(key, name)
-		{
-			
-		}
 	}
 }
 
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs
index 715707c..22f9a10 100644
--- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs
+++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs
@@ -4,9 +4,23 @@ using System.Linq;
 using System.Text;
 using Crestron.SimplSharp;
 
+using PepperDash.Core;
+
+using Newtonsoft.Json;
+
 namespace EssentialsPluginTemplateEPI
 {
-	public class EssentialsPluginTemplateConfigObject
+    /// <summary>
+    /// Example of a config class that represents the structure of the Properties object of a DeviceConfig
+    /// </summary>
+	public class EssentialsPluginTemplatePropertiesConfig 
 	{
+        /// <summary>
+        /// Control properties if needed to communicate with device
+        /// </summary>
+        [JsonProperty("control")]
+        ControlPropertiesConfig Control { get; set; }
+
+
 	}
 }
\ No newline at end of file
diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs
new file mode 100644
index 0000000..434dde4
--- /dev/null
+++ b/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs
@@ -0,0 +1,38 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Crestron.SimplSharpPro.DeviceSupport;
+
+using PepperDash.Essentials;
+using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core.Config;
+using PepperDash.Core;
+
+namespace EssentialsPluginTemplateEPI
+{
+    /// <summary>
+    /// Example of a plugin device
+    /// </summary>
+    public class EssentialsPluginTemplateDevice : Device, IBridge
+    {
+        /// <summary>
+        /// Device Constructor.  Called by 
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="name"></param>
+        /// <param name="config"></param>
+        public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplatePropertiesConfig config)
+            : base(key, name)
+        {
+
+        }
+
+        public void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey)
+        {
+
+
+        }
+    }
+}
\ No newline at end of file
diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj
index 4413a7d..5a9ae47 100644
--- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj
+++ b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj
@@ -95,6 +95,7 @@
     <Compile Include="EssentialsPluginTemplateBridge.cs" />
     <Compile Include="EssentialsPluginTemplateConfigObject.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="EssentialsPluginTemplateDevice.cs" />
     <None Include="Properties\ControlSystem.cfg" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CompactFramework.CSharp.targets" />
diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.suo b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.suo
index 8754faac5331a5c0281f2398fa001ade594ceed5..3b9a273efda09627deb240f8d48a51672e4d7b0a 100644
GIT binary patch
delta 1599
zcmbtUUuaWj6hGhX&A;Z>#-^!Bjcu$+TT1h%wQj4Fsx{U&4SH*f1uMnbmLjW8V(jSZ
zMg(Dxn>o(|AGU|-7}hHyjDZz}4eMVN#1~5+ME2kiE2v<z-*?lDZZIhJUJl>+_nmXT
z^DlE*WPTPGlgioNwheVew3y4~LO5#yHGujh-r{ucpvbC8QNbJ4>JryEum0owBT)n~
z8Ix*{(0ssb02s*eeKnXZRr!r2ph=4o9FTF)nrFB{NG9t_y=4oCIDci0`Xnn1DzYSw
z;cNoz;+xjp-h!o0aCQT_0Nnr%+Rlh^{>fHnKM8U|vL4&&U58I)Zgq%Q;@6kG=R15~
z&hv~t#@p>Tww#B?PTEQbX@EYb6n#cV=opPrfa1VXG)lviHYG=ZpMai@0GnFZ@m!;y
zQ{nhJ7{E7*TWQ?*l+-+fr$d|gPsb4dt~PSISl8^}mjLiCGbt9Sc!l2<PYD~JboSXT
z%Y;^`-KiK`HG5GHDIi`6qSpW-4;{7sVJ()HUMM6;lT7n_-uAueJ%5_Y1(A8)5j?%|
zhte<p{nD&!L6q@p*IiAP5O)6wv7sEqpw+xfH1a<QIS$D|)&os^*ca#90gb=azpnF8
zY6VdWw2)hQCgU1gYo#I*OHr?Z(^|goc3WhE?Gh8k{N6n!k~~?S6Z?76lPD4EA(RbN
zNUE{mxvcO*Zv#K@Hlw)1W@-QP;FY}uW(yh27j~T1u<&ooR>rkbxb!S@YiR^=)tIcD
z63!^l*?diShvPJ7{4;#rQOnzED#9NUNa#{kTnH!cNJcqbozcF5{iPlwzE@L?jGt?l
z;jAd%W-r0QvhRu66(1CvEO*Q?g6^L{a}4uEeNb&`-rT}rJ)~8@$L$L(Wq&Qc$nj}k
z2)d<4Cisi8d3JRp7wU(@qja3cF>Yz#@j?JNBdGZacy=1^6Bc1yuWPU3OOYVI3pckC
z$;~sj3hxghIv<ENV7bXTiLmJTE!%ZNlXFrDD6}Cjbm^KG4A*jIx_hsJ9zr3Fh3?rR
zu1WaWpA38~$NSByf;zz0_H5^lU?q1(s}P*rGhTifoZ<FFicj^O;Y`njF|l74VuVGT
z+j$H#AlDt19X}n2Zup2=@qdEsrOnJ1vMBp_2shUA{6K=s94+duoqalgx34YR?^Wd%
MHUj-~;_M;yZ<s-!&Hw-a

delta 1702
zcmb_cZD><h7(VBElitLeHs+&E+Qy_!O=C4}qj5jF&SoW=egvD+B90ZIwd%UnDQzl*
z&Ju>;{%z#>wO^C54gA25T^ahX-JC;EY(>F;Dk$@p%IHQnw#N6|d=UKAi3gtZp7Xxv
zzUR5mdC$q5=b0<~QbLj)j4>pQ!5v;2_y`Sz)m**_yNTujLNg&qXdwvy7GW<B4)Ls<
z;Oo&Kdo7O!KH0nZz<s`sLQyR(_jA=r!wQ1Phb6fQ^OZ7I3_evjMH&G#8GTk;!669g
z&S7Ja_uz!F%{@b|5TTXORtSg5_TpD#+!dqIF2Zg?oG?kqXRSENkK;^5vr^jVK}FCy
z5$O27Cf%60wlw)$a)0jzEGX@WD%bfFgj=8DlF5jdrhQ5+r75vanUiWAIV@#PgG`f`
z_}e_o70j$3Qk1fw#YB_c5_QyM+M)~XvZ5*KKT@1?@;wtGF(=Cyevr&!r>hd<f4PNI
zZ_hfr1Ot}0g+%#~-Ww$>RwwXv)t0PvncMNF^^R(wNHw8ITUWndFrkJeQw`=?Dm|aE
z1FVCMuo*VZ4zelgN7%<K#YV}F<FVUbH?7a6*+*0mhuBe4bX;FK!VV$)t`mc{ZoFvR
zfae|?zI1y-$0*BDc1&NBViROV&Qa>c4oBD+Wk{3%Q;`jGjURNc{m=8{nUTp%*R3$8
z-?7_C_uKXw&hVdomX9Ot$ngtEJNqoU0#;gDR6<*JUXg+cR(Z2_@?VpG;H%uJl{-Iw
zC(4E;*zb-_cQ5+=@t>YPKG8gOB!Wd(#Pj4W%e2{YkR+NQVHl$VK+e5OwbNMCL6N3m
zD^32;(zUbP(oVzkg|jnb!QF*qD2hz|f=Yox^A(F=U)5`;`QyeI=VrX0XhX`Iv5Adt
zcnV*=@j=7uJKY-Iwmq`rowXhyy$cS>QKIR5jpmyd9dT(ljZxuEP;nl{yzRr5@V5WK
z%87e+t5w_<Q3SWoMQkrtpXZ2fJ?@5rh_>v+>CS3A+S;m}^~WU42eSA)9{o1BQM(Xx
zam18PEYibKgioo@_FPxRNxCRu@kFuQlT^j6t}J(^dIv0AJakoMUTwMe);eVS&l<#S
zcj2;s5c7MY;!>9`dk026^>0-~72nwAa6{Q1SmWJjkZU0|Ww8>9Q0bb`6<@&4z9~#4
zPiBW*rc*@s3&N__F#M1s+I(D_987Y)AH1^;-9vo{$c}8#g<q8SO5znoEVn+T?iFID
B>`DLt

diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.projectinfo b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.projectinfo
new file mode 100644
index 0000000000000000000000000000000000000000..a449593860716ecbdce08cf7947eb99102f354fa
GIT binary patch
literal 428
zcmV;d0aN}TiwFP!000040PVd8U>r%7B_=Oz%6orG^-9;^bfE}<U=t+RkU$XZ!HCV~
zlI$I6M<Xe#DuK#nR%Kmg7C_AHoxJznd+)vX-h1!8_qscsPAB)@|36%2WC3jU&Pv+J
zo*{s$$R9s`d>=m|e(^`YTQU3S(MP)<jXuggdUT$ZO+NZ)Vt<>`cQ2p58J{*yzHAHn
z@MXEaD3)*X#j4EOe0=)yj9#5dvtBFu>Vm%7+1c6M=KsCf*?GkOqi+h^%TL?iUe?u5
z=hOCVd0ss$%6yqEa(e&d(eL~Fez&UM7R!tDX;D*ysxI>8_x*ieKK*@v-yziS?PkPp
zXt5Gp3c`i3J!`1v_S$0l`nqZJ#S20379^sPUDVm)Z1yI*7^c=qwOG-(XJ0M{$#%M!
z<g?e+x}N68^>kib<`$>ZWi~1E=hX#4yRe_0RIBSZ)w8Oc<#qGXBQxcDAN`WiM_&}n
zVzFL4E9%8nR_8xSEs6?#?~ZqN9@78!9#WTIuG`hReVMiMpS{VTZm9R-yqIP!q3|ki
W)@4iRe((Fg<o^Ml23PH+0ssJRneIsd

literal 0
HcmV?d00001