Adds console method to print join maps at runtime. Adds overload of LinkToApi extension method for IBridge to allow passing the bridge in for JoinMapBaseAdvance applications

PepperDashEssentials/Bridges/BridgeBase.cs

@@ -20,6 +20,46 @@ using PepperDash.Essentials.DM;
 
 namespace PepperDash.Essentials.Bridges
 {
+    /// <summary>
+    /// Helper methods for bridges
+    /// </summary>
+    public static class BridgeHelper
+    {
+        public static void PrintJoinMap(string command)
+        {
+            string bridgeKey = "";
+            string deviceKey = "";
+
+            var targets = command.Split(' ');
+
+            bridgeKey = targets[0].Trim();
+
+            var bridge = DeviceManager.GetDeviceForKey(bridgeKey) as EiscApi;
+
+            if (bridge == null)
+            {
+                Debug.Console(0, "Unable to find bridge with key: '{0}'", bridgeKey);
+                return;
+            }
+
+            if (targets.Length > 1)
+            {
+                deviceKey = targets[1].Trim();
+
+                if (!string.IsNullOrEmpty(deviceKey))
+                {
+                    bridge.PrintJoinMapForDevice(deviceKey);
+                    return;
+                }
+            }
+            else
+            {
+                bridge.PrintJoinMaps();
+            }
+        }
+    }
+
+
     /// <summary>
     /// Base class for all bridge class variants
     /// </summary>
@@ -206,6 +246,36 @@ namespace PepperDash.Essentials.Bridges
             }
         }
 
+        /// <summary>
+        /// Prints all the join maps on this bridge
+        /// </summary>
+        public void PrintJoinMaps()
+        {
+            Debug.Console(0, this, "Join Maps for EISC IPID: {0}", Eisc.ID.ToString("X"));
+
+            foreach (var joinMap in JoinMaps)
+            {
+                joinMap.Value.PrintJoinMapInfo();
+            }
+        }
+
+        /// <summary>
+        /// Prints the join map for a device by key
+        /// </summary>
+        /// <param name="deviceKey"></param>
+        public void PrintJoinMapForDevice(string deviceKey)
+        {
+            var joinMap = JoinMaps[deviceKey];
+
+            if (joinMap == null)
+            {
+                Debug.Console(0, this, "Unable to find joinMap for device with key: '{0}'", deviceKey);
+                return;
+            }
+
+            joinMap.PrintJoinMapInfo();
+        }
+
         /// <summary>
         /// Used for debugging to trigger an action based on a join number and type
         /// </summary>

PepperDashEssentials/Bridges/IBridge.cs

@@ -10,5 +10,7 @@ namespace PepperDash.Essentials.Bridges
     public interface IBridge
     {
         void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey);
+
+        void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApi bridge);
     }
 }

PepperDashEssentials/ControlSystem.cs

@@ -47,9 +47,12 @@ namespace PepperDash.Essentials
                     ConsoleAccessLevelEnum.AccessOperator);
             }
 
-            CrestronConsole.AddNewConsoleCommand(PluginLoader.ReportAssemblyVersions, "reportversions", "Reports the versions of the loaded assemblies", ConsoleAccessLevelEnum.AccessOperator); 
+            CrestronConsole.AddNewConsoleCommand(PluginLoader.ReportAssemblyVersions, "reportversions", "Reports the versions of the loaded assemblies", ConsoleAccessLevelEnum.AccessOperator);
+
+            CrestronConsole.AddNewConsoleCommand(PepperDash.Essentials.Core.DeviceFactory.GetDeviceFactoryTypes, "gettypes", "Gets the device types that can be built. Accepts a filter string.", ConsoleAccessLevelEnum.AccessOperator);
+
+            CrestronConsole.AddNewConsoleCommand(PepperDash.Essentials.Bridges.BridgeHelper.PrintJoinMap, "getjoinmap", "gets map(s) for bridge or device on bridge [brKey [devKey]]", ConsoleAccessLevelEnum.AccessOperator);
 
-            // CrestronConsole.AddNewConsoleCommand(S => { ConfigWriter.WriteConfigFile(null); }, "writeconfig", "writes the current config to a file", ConsoleAccessLevelEnum.AccessOperator);
             CrestronConsole.AddNewConsoleCommand(s =>
             {
                 Debug.Console(0, Debug.ErrorLogLevel.Notice, "CONSOLE MESSAGE: {0}", s);

essentials-framework/Essentials Core/PepperDashEssentialsBase/Config/Comm and IR/GenericComm.cs

@@ -13,14 +13,11 @@ using PepperDash.Essentials.Core.Config;
 
 namespace PepperDash.Essentials.Core
 {
-
-
     /// <summary>
     /// Serves as a generic wrapper class for all styles of IBasicCommuncation ports
     /// </summary>
     public class GenericComm : ReconfigurableDevice
     {
-
         EssentialsControlPropertiesConfig PropertiesConfig;
 
         public IBasicCommunication CommPort { get; private set; }
@@ -32,7 +29,6 @@ namespace PepperDash.Essentials.Core
 
             CommPort = CommFactory.CreateCommForDevice(config);
 
-                   
         }
 
         public static IKeyed BuildDevice(DeviceConfig dc)
@@ -61,22 +57,19 @@ namespace PepperDash.Essentials.Core
 
             ConfigWriter.UpdateDeviceConfig(config);
         }
+    }
 
-        public class Factory : Essentials.Core.Factory
+    public class GenericCommFactory : Essentials.Core.EssentialsDeviceFactory<GenericComm>
+    {
+        public GenericCommFactory()
         {
-            #region IDeviceFactory Members
-
-            List<string> TypeNames = new List<string>() { "genericComm" };
-
-            #endregion
-
-            public override IKeyed BuildDevice(DeviceConfig dc)
-            {
-                Debug.Console(1, "Factory Attempting to create new Generic Comm Device");
-                return new GenericComm(dc);
-            }
+            TypeNames = new List<string>() { "genericComm" };
         }
-     }
-
 
+        public override EssentialsDevice BuildDevice(DeviceConfig dc)
+        {
+            Debug.Console(1, "Factory Attempting to create new Generic Comm Device");
+            return new GenericComm(dc);
+        }
+    }
 }

essentials-framework/Essentials Core/PepperDashEssentialsBase/Devices/EssentialsDevice.cs

@@ -19,15 +19,24 @@ namespace PepperDash.Essentials.Core
         {
 
         }
+
+        protected EssentialsDevice(string key, string name)
+            : base(key, name)
+        {
+
+        }
     }
 
-    public abstract class Factory : IDeviceFactory
+    /// <summary>
+    /// Devices the basic needs for a Device Factory
+    /// </summary>
+    public abstract class EssentialsDeviceFactory<T> : IDeviceFactory where T:EssentialsDevice
     {
         #region IDeviceFactory Members
 
         public List<string> TypeNames { get; protected set; }
 
-        public virtual void LoadTypeFactories()
+        public void LoadTypeFactories()
         {
             foreach (var typeName in TypeNames)
             {
@@ -35,13 +44,16 @@ namespace PepperDash.Essentials.Core
             }
         }
 
+        public abstract EssentialsDevice BuildDevice(DeviceConfig dc);
+
         #endregion
+    }
 
-        public abstract IKeyed BuildDevice(DeviceConfig dc);
-
-        protected Factory()
-        {
-            TypeNames = new List<string>();
-        }
+    /// <summary>
+    /// Devices the basic needs for a Device Factory
+    /// </summary>
+    public abstract class EssentialsPluginDeviceFactory<T> : EssentialsDeviceFactory<T>, IPluginDeviceFactory where T : EssentialsDevice
+    {
+        public string MinimumEssentialsFrameworkVersion { get; protected set; }
     }
 }

essentials-framework/Essentials Core/PepperDashEssentialsBase/Factory/DeviceFactory.cs

@@ -86,6 +86,31 @@ namespace PepperDash.Essentials.Core
 
             return null;
         }
+
+        /// <summary>
+        /// Prints the type names fromt the FactoryMethods collection.
+        /// </summary>
+        /// <param name="command"></param>
+        public static void GetDeviceFactoryTypes(string filter)
+        {
+            List<string> typeNames = new List<string>();
+
+            if (!string.IsNullOrEmpty(filter))
+            {
+                typeNames = FactoryMethods.Keys.Where(k => k.Contains(filter)).ToList();
+            }
+            else
+            {
+                typeNames = FactoryMethods.Keys.ToList();
+            }
+
+            Debug.Console(0, "Device Types:");
+
+            foreach (var type in typeNames)
+            {
+                Debug.Console(0, "type: '{0}'", type);
+            }
+        }
     }
 
 
@@ -96,7 +121,7 @@ namespace PepperDash.Essentials.Core
     {
         public CoreDeviceFactory()
         {
-            var genComm = new GenericComm.Factory() as IDeviceFactory;
+            var genComm = new GenericCommFactory() as IDeviceFactory;
             genComm.LoadTypeFactories();
         }
     }

essentials-framework/Essentials Core/PepperDashEssentialsBase/Factory/IDeviceFactory.cs

@@ -4,6 +4,9 @@ using System.Linq;
 using System.Text;
 using Crestron.SimplSharp;
 
+using PepperDash.Core;
+using PepperDash.Essentials.Core.Config;
+
 namespace PepperDash.Essentials.Core
 {
     /// <summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/JoinMaps/JoinMapBase.cs

@@ -48,16 +48,17 @@ namespace PepperDash.Essentials.Core
 
             if (joinMapSerialzed != null)
             {
-                var joinMap = JsonConvert.DeserializeObject<Dictionary<string, JoinData>>(joinMapSerialzed);
+                var joinMapData = JsonConvert.DeserializeObject<Dictionary<string, JoinData>>(joinMapSerialzed);
 
-                if (joinMap != null)
-                    return joinMap;
+                if (joinMapData != null)
+                    return joinMapData;
                 else
                     return null;
             }
             else
                 return null;
         }
+
     }
 
     /// <summary>
@@ -255,6 +256,8 @@ namespace PepperDash.Essentials.Core
                     Debug.Console(2, "No mathcing key found in join map for: '{0}'", customJoinData.Key);
                 }
             }
+
+            PrintJoinMapInfo();
         }
 
         ///// <summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Plugins/PluginLoader.cs

@@ -8,6 +8,7 @@ using Crestron.SimplSharp.Reflection;
 
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core.Plugins;
 
 namespace PepperDash.Essentials
 {
@@ -69,6 +70,11 @@ namespace PepperDash.Essentials
                         {
                             version = Global.AssemblyVersion;
                             assembly = Assembly.GetExecutingAssembly();
+                            break;
+                        }
+                    case ("PepperDashEssentialsBase.dll"):
+                        {
+
                             break;
                         }
                     case ("PepperDash_Core.dll"):
@@ -338,47 +344,19 @@ namespace PepperDash.Essentials
                     {
                         try
                         {
-                            var methods = type.GetMethods(BindingFlags.Public | BindingFlags.Static);
-                            var loadPlugin = methods.FirstOrDefault(m => m.Name.Equals("LoadPlugin"));
-                            if (loadPlugin != null)
+                            if (typeof(IPluginDeviceFactory).IsAssignableFrom(type))
                             {
-                                Debug.Console(2, "LoadPlugin method found in {0}", type.Name);
-
-                                var fields = type.GetFields(BindingFlags.Public | BindingFlags.Static);
-
-                                var minimumVersion = fields.FirstOrDefault(p => p.Name.Equals("MinimumEssentialsFrameworkVersion"));
-                                if (minimumVersion != null)
+                                var plugin = (IPluginDeviceFactory)Crestron.SimplSharp.Reflection.Activator.CreateInstance(type);
+                                LoadCustomPlugin(plugin, loadedAssembly);
+                            }
+                            else
+                            {
+                                var methods = type.GetMethods(BindingFlags.Public | BindingFlags.Static);
+                                var loadPlugin = methods.FirstOrDefault(m => m.Name.Equals("LoadPlugin"));
+                                if (loadPlugin != null)
                                 {
-                                    Debug.Console(2, "MinimumEssentialsFrameworkVersion found");
-
-                                    var minimumVersionString = minimumVersion.GetValue(null) as string;
-
-                                    if (!string.IsNullOrEmpty(minimumVersionString))
-                                    {
-                                        var passed = Global.IsRunningMinimumVersionOrHigher(minimumVersionString);
-
-                                        if (!passed)
-                                        {
-                                            Debug.Console(0, Debug.ErrorLogLevel.Error, "Plugin indicates minimum Essentials version {0}.  Dependency check failed.  Skipping Plugin", minimumVersionString);
-                                            continue;
-                                        }
-                                        else
-                                        {
-                                            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Passed plugin passed dependency check (required version {0})", minimumVersionString);
-                                        }
-                                    }
-                                    else
-                                    {
-                                        Debug.Console(0, Debug.ErrorLogLevel.Warning, "MinimumEssentialsFrameworkVersion found but not set.  Loading plugin, but your mileage may vary.");
-                                    }
+                                    LoadCustomLegacyPlugin(type, loadPlugin, loadedAssembly);
                                 }
-                                else
-                                {
-                                    Debug.Console(0, Debug.ErrorLogLevel.Warning, "MinimumEssentialsFrameworkVersion not found.  Loading plugin, but your mileage may vary.");
-                                }
-
-                                Debug.Console(0, Debug.ErrorLogLevel.Notice, "Adding plugin: {0}", loadedAssembly.Name);
-                                loadPlugin.Invoke(null, null);
                             }
                         }
                         catch (Exception e)
@@ -400,6 +378,75 @@ namespace PepperDash.Essentials
             Debug.Console(0, "Done Loading Custom Plugin Types.");
         }
 
+        /// <summary>
+        /// Loads a
+        /// </summary>
+        /// <param name="plugin"></param>
+        static void LoadCustomPlugin(IPluginDeviceFactory plugin, LoadedAssembly loadedAssembly)
+        {
+            var passed = Global.IsRunningMinimumVersionOrHigher(plugin.MinimumEssentialsFrameworkVersion);
+
+            if (!passed)
+            {
+                Debug.Console(0, Debug.ErrorLogLevel.Error, "Plugin indicates minimum Essentials version {0}.  Dependency check failed.  Skipping Plugin", plugin.MinimumEssentialsFrameworkVersion);
+                return;
+            }
+            else
+            {
+                Debug.Console(0, Debug.ErrorLogLevel.Notice, "Passed plugin passed dependency check (required version {0})", plugin.MinimumEssentialsFrameworkVersion);
+            }
+
+            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Loading plugin: {0}", loadedAssembly.Name);
+            plugin.LoadTypeFactories();
+        }
+
+        /// <summary>
+        /// Loads a a custom plugin via the legacy method
+        /// </summary>
+        /// <param name="type"></param>
+        /// <param name="loadPlugin"></param>
+        static void LoadCustomLegacyPlugin(CType type, MethodInfo loadPlugin, LoadedAssembly loadedAssembly)
+        {
+            Debug.Console(2, "LoadPlugin method found in {0}", type.Name);
+
+            var fields = type.GetFields(BindingFlags.Public | BindingFlags.Static);
+
+            var minimumVersion = fields.FirstOrDefault(p => p.Name.Equals("MinimumEssentialsFrameworkVersion"));
+            if (minimumVersion != null)
+            {
+                Debug.Console(2, "MinimumEssentialsFrameworkVersion found");
+
+                var minimumVersionString = minimumVersion.GetValue(null) as string;
+
+                if (!string.IsNullOrEmpty(minimumVersionString))
+                {
+                    var passed = Global.IsRunningMinimumVersionOrHigher(minimumVersionString);
+
+                    if (!passed)
+                    {
+                        Debug.Console(0, Debug.ErrorLogLevel.Error, "Plugin indicates minimum Essentials version {0}.  Dependency check failed.  Skipping Plugin", minimumVersionString);
+                        return;
+                    }
+                    else
+                    {
+                        Debug.Console(0, Debug.ErrorLogLevel.Notice, "Passed plugin passed dependency check (required version {0})", minimumVersionString);
+                    }
+                }
+                else
+                {
+                    Debug.Console(0, Debug.ErrorLogLevel.Warning, "MinimumEssentialsFrameworkVersion found but not set.  Loading plugin, but your mileage may vary.");
+                }
+            }
+            else
+            {
+                Debug.Console(0, Debug.ErrorLogLevel.Warning, "MinimumEssentialsFrameworkVersion not found.  Loading plugin, but your mileage may vary.");
+            }
+
+            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Loading legacy plugin: {0}", loadedAssembly.Name);
+            loadPlugin.Invoke(null, null);
+
+        }
+
         /// <summary>
         /// Loads plugins
         /// </summary>
@@ -415,15 +462,17 @@ namespace PepperDash.Essentials
                 // Deal with any .cplz files
                 UnzipAndMoveCplzArchives();
 
-				if(Directory.Exists(_loadedPluginsDirectoryPath)) {
-					// Load the assemblies from the loadedPlugins folder into the AppDomain
-					LoadPluginAssemblies();
+                if (Directory.Exists(_loadedPluginsDirectoryPath))
+                {
+                    // Load the assemblies from the loadedPlugins folder into the AppDomain
+                    LoadPluginAssemblies();
 
-					// Load the types from any custom plugin assemblies
-					LoadCustomPluginTypes();
-				}
+                    // Load the types from any custom plugin assemblies
+                    LoadCustomPluginTypes();
+                }
             }
         }
+
     }
 
     /// <summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Touchpanels/Mpc3Touchpanel.cs

@@ -28,7 +28,6 @@ namespace PepperDash.Essentials.Core.Touchpanels
 
             _Touchpanel.ButtonStateChange += new Crestron.SimplSharpPro.DeviceSupport.ButtonEventHandler(_Touchpanel_ButtonStateChange);
 
-
             AddPostActivationAction(() =>
                 {
                     // Link up the button feedbacks to the specified BoolFeedbacks
@@ -40,7 +39,7 @@ namespace PepperDash.Essentials.Core.Touchpanels
                         {
                             var bKey = button.Key.ToLower();
 
-                            var feedback = device.GetFeedbackProperty(feedbackConfig.BoolFeedbackName);
+                            var feedback = device.GetFeedbackProperty(feedbackConfig.FeedbackName);
 
                             var bFeedback = feedback as BoolFeedback;
                             var iFeedback = feedback as IntFeedback;
@@ -72,7 +71,7 @@ namespace PepperDash.Essentials.Core.Touchpanels
                             }
                             else
                             {
-                                Debug.Console(1, this, "Unable to get BoolFeedback with name: {0} from device: {1}", feedbackConfig.BoolFeedbackName, device.Key);
+                                Debug.Console(1, this, "Unable to get BoolFeedback with name: {0} from device: {1}", feedbackConfig.FeedbackName, device.Key);
                             }
                         }
                         else
@@ -140,6 +139,6 @@ namespace PepperDash.Essentials.Core.Touchpanels
     public class KeypadButtonFeedback
     {
         public string DeviceKey { get; set; }
-        public string BoolFeedbackName { get; set; }
+        public string FeedbackName { get; set; }
     }
 }