Documents all join maps and moves them to their own files for easier linking in Confluence documentation.

PepperDashEssentials/Bridges/JoinMaps/SystemMonitorJoinMap.cs

@@ -0,0 +1,135 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+namespace PepperDash.Essentials.Bridges
+{
+    public class SystemMonitorJoinMap : JoinMapBase
+    {
+        /// <summary>
+        /// Offset to indicate where the range of iterated program joins will start
+        /// </summary>
+        public uint ProgramStartJoin { get; set; }
+
+        /// <summary>
+        /// Offset between each program join set
+        /// </summary>
+        public uint ProgramOffsetJoin { get; set; }
+
+        #region Digitals
+        /// <summary>
+        /// Range Sets and reports whether the corresponding program slot is started
+        /// </summary>
+        public uint ProgramStart { get; set; }
+        /// <summary>
+        /// Range Sets and reports whether the corresponding program slot is stopped
+        /// </summary>
+        public uint ProgramStop { get; set; }
+        /// <summary>
+        /// Range Sets and reports whether the corresponding program is registered
+        /// </summary>
+        public uint ProgramRegister { get; set; }
+        /// <summary>
+        /// Range Sets and reports whether the corresponding program is unregistered
+        /// </summary>
+        public uint ProgramUnregister { get; set; }
+        #endregion
+
+        #region Analogs
+        /// <summary>
+        /// Sets and reports the time zone
+        /// </summary>
+        public uint TimeZone { get; set; }
+        #endregion
+
+        #region Serials
+        /// <summary>
+        /// Reports the time zone name
+        /// </summary>
+        public uint TimeZoneName { get; set; }
+        /// <summary>
+        /// Reports the IO Controller Version
+        /// </summary>
+        public uint IOControllerVersion { get; set; }
+        /// <summary>
+        /// Reports the SNMP App Version
+        /// </summary>
+        public uint SnmpAppVersion { get; set; }
+        /// <summary>
+        /// Reports the BACnet App Version
+        /// </summary>
+        public uint BACnetAppVersion { get; set; }
+        /// <summary>
+        /// Reports the firmware version
+        /// </summary>
+        public uint ControllerVersion { get; set; }
+
+        /// <summary>
+        /// Reports the name of the corresponding program
+        /// </summary>
+        public uint ProgramName { get; set; }
+        /// <summary>
+        /// Reports the compile time of the corresponding program
+        /// </summary>
+        public uint ProgramCompiledTime { get; set; }
+        /// <summary>
+        /// Reports the Crestron Database version of the corresponding program
+        /// </summary>
+        public uint ProgramCrestronDatabaseVersion { get; set; }
+        /// <summary>
+        /// Reports the Environment Version of the corresponding program
+        /// </summary>
+        public uint ProgramEnvironmentVersion { get; set; }
+        /// <summary>
+        /// Serialized JSON output that aggregates the program info of the corresponding program
+        /// </summary>
+        public uint AggregatedProgramInfo { get; set; }
+        #endregion
+
+        public SystemMonitorJoinMap()
+        {
+            TimeZone = 1;
+
+            TimeZoneName = 1;
+            IOControllerVersion = 2;
+            SnmpAppVersion = 3;
+            BACnetAppVersion = 4;
+            ControllerVersion = 5;
+
+
+            ProgramStartJoin = 10;
+
+            ProgramOffsetJoin = 5;
+
+            // Offset in groups of 5 joins
+            ProgramStart = 1;
+            ProgramStop = 2;
+            ProgramRegister = 3;
+            ProgramUnregister = 4;
+
+            ProgramName = 1;
+            ProgramCompiledTime = 2;
+            ProgramCrestronDatabaseVersion = 3;
+            ProgramEnvironmentVersion = 4;
+            AggregatedProgramInfo = 5;
+        }
+
+        public override void OffsetJoinNumbers(uint joinStart)
+        {
+            var joinOffset = joinStart - 1;
+
+            TimeZone = TimeZone + joinOffset;
+
+            TimeZoneName = TimeZoneName + joinOffset;
+            IOControllerVersion = IOControllerVersion + joinOffset;
+            SnmpAppVersion = SnmpAppVersion + joinOffset;
+            BACnetAppVersion = BACnetAppVersion + joinOffset;
+            ControllerVersion = ControllerVersion + joinOffset;
+
+            // Sets the initial join value where the iterated program joins will begin
+            ProgramStartJoin = ProgramStartJoin + joinOffset;
+        }
+    }
+}