Merge pull request #53 from PepperDash/hotfix/system-monitor-not-reporting-correctly

added input sig links for the program information

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]-"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.  
+
+**Stacktrace**
+
+Include a stack trace of the exception if possible.
+```
+Paste stack trace here
+```
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]-"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+If this is a request for support for a new device or type, be as specific as possible and include any pertinent manufacturer and model information.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

PepperDashEssentials/Bridges/SystemMonitorBridge.cs

@@ -61,6 +61,16 @@ namespace PepperDash.Essentials.Bridges
                     (b => SystemMonitor.ProgramCollection[programNumber].RegistrationState = eProgramRegistrationState.Unregister));
                 p.Value.ProgramUnregisteredFeedback.LinkInputSig(trilist.BooleanInput[programSlotJoinStart + joinMap.ProgramUnregister]);
 
+                p.Value.ProgramNameFeedback.LinkInputSig(trilist.StringInput[programSlotJoinStart + joinMap.ProgramName]);
+                p.Value.ProgramCompileTimeFeedback.LinkInputSig(
+                    trilist.StringInput[programSlotJoinStart + joinMap.ProgramCompiledTime]);
+                p.Value.CrestronDataBaseVersionFeedback.LinkInputSig(
+                    trilist.StringInput[programSlotJoinStart + joinMap.ProgramCrestronDatabaseVersion]);
+                p.Value.EnvironmentVersionFeedback.LinkInputSig(
+                    trilist.StringInput[programSlotJoinStart + joinMap.ProgramEnvironmentVersion]);
+                p.Value.AggregatedProgramInfoFeedback.LinkInputSig(
+                    trilist.StringInput[programSlotJoinStart + joinMap.AggregatedProgramInfo]);
+
                 programSlotJoinStart = programSlotJoinStart + joinMap.ProgramOffsetJoin;
             }
         }

PepperDashEssentials/ControlSystem.cs

@@ -96,7 +96,7 @@ namespace PepperDash.Essentials
                 string directoryPrefix;
 
                 directoryPrefix = Crestron.SimplSharp.CrestronIO.Directory.GetApplicationRootDirectory();
-
+                
                 var version = Crestron.SimplSharp.Reflection.Assembly.GetExecutingAssembly().GetName().Version;
 
                 Global.SetAssemblyVersion(string.Format("{0}.{1}.{2}", version.Major, version.Minor, version.Build));

PepperDashEssentials/UI/EssentialsTouchpanelController.cs

@@ -106,12 +106,18 @@ namespace PepperDash.Essentials
                 Debug.Console(0, this, Debug.ErrorLogLevel.Notice, "WARNING: Registration failed. Continuing, but panel may not function: {0}", Panel.RegistrationFailureReason);
 
             // Give up cleanly if SGD is not present.
-            var sgdName = Global.FilePathPrefix
-                + Global.DirectorySeparator + "sgd" + Global.DirectorySeparator + props.SgdFile;
+            var sgdName = Global.FilePathPrefix + "sgd" + Global.DirectorySeparator + props.SgdFile;
             if (!File.Exists(sgdName))
             {
-                Debug.Console(0, this, "ERROR: Smart object file '{0}' not present. Exiting TSW load", sgdName);
-                return;
+                Debug.Console(0, this, "Smart object file '{0}' not present in User folder. Looking for embedded file", sgdName);
+
+                sgdName = Global.ApplicationDirectoryPathPrefix + Global.DirectorySeparator + "SGD" + Global.DirectorySeparator + props.SgdFile;
+
+                if (!File.Exists(sgdName))
+                {
+                    Debug.Console(0, this, "Unable to find SGD file '{0}' in User sgd or application SGD folder. Exiting touchpanel load.", sgdName);
+                    return;
+                }
             }
 
             Panel.LoadSmartObjects(sgdName);

README.md

@@ -16,38 +16,29 @@ Essentials Framework is a collection of C# / Simpl# Pro libraries that can be ut
 
 ## Dependencies
 
-The PepperDash.Core SIMPL# library is required.  It is referenced as a submodule and will be automatically checked out when cloning this repo if set to recurse submodules.  This allows different builds of the PepperDash.Core library to be reference by checking out the desired submodule commit.
+The [PepperDash.Core](https://github.com/PepperDash/PepperDashCore) SIMPL# library is required.  It is referenced as a submodule and will be automatically checked out when cloning this repo if set to recurse submodules.  This allows different builds of the PepperDash.Core library to be referenced by checking out the desired submodule commit.
 
 ## Utilization
 Essentials was originally conceptualized as a standalone application for running control system logic entirely in Simpl# Pro. It is primarily designed around accomplishing this goal, but during development, it became obvious that it could easily be leveraged to also serve as a partner application to one or more SIMPL Windows programs.
 
 Utilization of Essentials Framework falls into the following categories:
 
-1. Standalone Control System Application for controlling one or more rooms
+1. Standalone Control System Application for controlling one or more rooms. See [Standalone Use](https://github.com/PepperDash/Essentials/wiki/Standalone-Use#standalone-application)
 
-2. Partner Application to a SIMPL Windows program. This allows for several useful advantages
+2. Partner Application to a SIMPL Windows program. This allows for several useful advantages. See [SIMPL Windows Bridging](https://github.com/PepperDash/Essentials/wiki/SIMPL-Bridging#simpl-windows-bridging)
 
-- Dynamic device instantiation. Devices can be defined in configuration and instantiated at runtime and then "bridged" to a SIMPL Windows program via EISC.
+- Dynamic device instantiation. Devices can be defined in configuration and instantiated at runtime and then bridged to a SIMPL Windows program via EISC.
 
-- Advanced logic. Some logic operations that cannot be affectively accomplished in SIMPL Windows (ex. JSON/XML serialization/deserialization, database operations, etc.) can be done in the Simpl# Pro environment and the necessary input and output "bridged" to a SIMPL Windows program via EISC.
+- Advanced logic. Some logic operations that cannot be affectively accomplished in SIMPL Windows (ex. JSON/XML serialization/deserialization, database operations, etc.) can be done in the Simpl# Pro environment and the necessary input and output bridged to a SIMPL Windows program via EISC.
 
 3. Hybrid Application that may contain elements of both standalone control and SIMPL partner application integration.
-- There may be a use case where a device can only be defined in a single application, but that device may need to be interacted with from multiple applications.  The device can be defined in an Essentials application, interacted with in that application and also "bridged" to one or more SIMPL Windows applications.
+- There may be a use case where a device can only be defined in a single application, but that device may need to be interacted with from multiple applications.  The device can be defined in an Essentials application, interacted with in that application and also bridged to one or more SIMPL Windows applications.
 
  ## Documentation
- For detailed documentation, follow this [LINK](https://github.com/PepperDash/EssentialsFramework/wiki) to the Wiki.
+ For detailed documentation, see the [Wiki](https://github.com/PepperDash/EssentialsFramework/wiki).
 
 ## How-To (Getting Started)
-To help understand Essentials Framework, we recommend starting with the current [Example Build]() and loading it to a Crestron 3-Series processor.
 
-1. First, load the PepperDashEssentials.cpz to the processor in program slot 1 and start the program.
-2. On first boot, the Essentials Application will build the necessary configuration folder structure in the User/Program1/ path.
-3. Load the ExampleEssentialsConfigurationFile.json to the User/Program1/ folder.
-4. Reset the program via console (progreset -p:1).  The program will load the example configuration file.
-5. Launch the EssentialsExampleXpanel.vtz project.  You can interact with the program (which uses simulated device logic to emulate a real commercial huddle room with presentation, audio and video calling capabilities).
-6. Via console, you can run the (**devlist:1**) command to get some insight into what has been loaded from the configuration file into the system .  This will print the basic device information in the form of ["key"] "Name".  The "key" value is what we can use to interact with each device uniquely.
-7. Run the command (**devprops:1 display-1**).  This will print the real-time property values of the device with key "display-1".
-8. Run the command (**devmethods:1 display-1**).  This will print the public methods available for the device with key "display-1".
-9. Run the command (**devjson:1 {"deviceKey":"display-1","methodName":"PowerOn", "params": []}**).  This will call the method PowerOn() on the device with key "display-1".
+See [Getting Started](https://github.com/PepperDash/Essentials/wiki/Get-started#how-to-get-started)
 
 

essentials-framework/Essentials Core/PepperDashEssentialsBase/Global/Global.cs

@@ -26,6 +26,17 @@ namespace PepperDash.Essentials.Core
         /// </summary>
         public static string FilePathPrefix { get; private set; }
 
+        /// <summary>
+        /// The file path prefix to the applciation directory
+        /// </summary>
+        public static string ApplicationDirectoryPathPrefix 
+        {
+            get
+            {
+                return Crestron.SimplSharp.CrestronIO.Directory.GetApplicationDirectory();
+            }
+        }
+
         /// <summary>
         /// Returns the directory separator character based on the running OS
         /// </summary>