pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-06 08:16:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: complete XML documentation for all projects with inheritdoc tags

Browse Source 
Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/PepperDash.Essentials.Core/Config/AudioControlPointListItem.cs
View File

@@ -8,6 +8,9 @@ using System.Threading.Tasks;
namespace PepperDash.Essentials.Core.Config
{
/// <summary>
/// Represents a AudioControlPointListItem
/// </summary>
public class AudioControlPointListItem
{
[JsonProperty("levelControls")]

9
src/PepperDash.Essentials.Core/Config/BasicConfig.cs
View File

@@ -33,6 +33,9 @@ namespace PepperDash.Essentials.Core.Config
public Dictionary<string, Dictionary<string, CameraListItem>> CameraLists { get; set; }
[JsonProperty("tieLines")]
/// <summary>
/// Gets or sets the TieLines
/// </summary>
public List<TieLineConfig> TieLines { get; set; }
[JsonProperty("joinMaps")]
@@ -81,6 +84,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary>
/// <param name="key">key of the list to retrieve</param>
/// <returns>AudioControlPointList if the key exists, null otherwise</returns>
/// <summary>
/// GetAudioControlPointListForKey method
/// </summary>
public AudioControlPointListItem GetAudioControlPointListForKey(string key)
{
if (AudioControlPointLists == null || string.IsNullOrEmpty(key) || !AudioControlPointLists.ContainsKey(key))
@@ -105,6 +111,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary>
/// <param name="key">Key of desired device</param>
/// <returns></returns>
/// <summary>
/// GetDeviceForKey method
/// </summary>
public DeviceConfig GetDeviceForKey(string key)
{
if (string.IsNullOrEmpty(key))

5
src/PepperDash.Essentials.Core/Config/ConfigPropertiesHelpers.cs
View File

@@ -11,10 +11,13 @@ using Newtonsoft.Json.Linq;
namespace PepperDash.Essentials.Core.Config
{
/// <summary>
/// Represents a ConfigPropertiesHelpers
/// </summary>
public class ConfigPropertiesHelpers
{
/// <summary>
/// Returns the value of properties.hasAudio, or false if not defined
/// GetHasAudio method
/// </summary>
public static bool GetHasAudio(DeviceConfig deviceConfig)
{

31
src/PepperDash.Essentials.Core/Config/DeviceConfig.cs
View File

@@ -13,25 +13,46 @@ using PepperDash.Essentials.Core;
namespace PepperDash.Essentials.Core.Config
{
/// <summary>
/// Represents a DeviceConfig
/// </summary>
public class DeviceConfig
{
[JsonProperty("key")]
/// <summary>
/// Gets or sets the Key
/// </summary>
public string Key { get; set; }
[JsonProperty("uid")]
/// <summary>
/// Gets or sets the Uid
/// </summary>
public int Uid { get; set; }
[JsonProperty("name")]
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get; set; }
[JsonProperty("group")]
/// <summary>
/// Gets or sets the Group
/// </summary>
public string Group { get; set; }
[JsonProperty("type")]
/// <summary>
/// Gets or sets the Type
/// </summary>
public string Type { get; set; }
[JsonProperty("properties")]
[JsonConverter(typeof(DevicePropertiesConverter))]
/// <summary>
/// Gets or sets the Properties
/// </summary>
public JToken Properties { get; set; }
public DeviceConfig(DeviceConfig dc)
@@ -51,11 +72,14 @@ namespace PepperDash.Essentials.Core.Config
}
/// <summary>
///
/// Represents a DevicePropertiesConverter
/// </summary>
public class DevicePropertiesConverter : JsonConverter
{
/// <summary>
/// CanConvert method
/// </summary>
public override bool CanConvert(Type objectType)
{
return objectType == typeof(JToken);
@@ -66,6 +90,7 @@ namespace PepperDash.Essentials.Core.Config
return JToken.ReadFrom(reader);
}
/// <inheritdoc />
public override bool CanWrite
{
get
@@ -74,6 +99,10 @@ namespace PepperDash.Essentials.Core.Config
}
}
/// <summary>
/// WriteJson method
/// </summary>
/// <inheritdoc />
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
throw new NotImplementedException("SOD OFF HOSER");

9
src/PepperDash.Essentials.Core/Config/Essentials/ConfigReader.cs
View File

@@ -26,6 +26,9 @@ namespace PepperDash.Essentials.Core.Config
public static EssentialsConfig ConfigObject { get; private set; }
/// <summary>
/// LoadConfig2 method
/// </summary>
public static bool LoadConfig2()
{
Debug.LogMessage(LogEventLevel.Information, "Loading unmerged system/template portal configuration file.");
@@ -157,6 +160,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary>
/// <param name="filePath"></param>
/// <returns></returns>
/// <summary>
/// GetConfigFiles method
/// </summary>
public static FileInfo[] GetConfigFiles(string filePath)
{
// Get the directory
@@ -189,6 +195,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
/// <summary>
/// GetGroupForDeviceKey method
/// </summary>
public static string GetGroupForDeviceKey(string key)
{
var dev = ConfigObject.Devices.FirstOrDefault(d => d.Key.Equals(key, StringComparison.OrdinalIgnoreCase));

12
src/PepperDash.Essentials.Core/Config/Essentials/ConfigUpdater.cs
View File

@@ -20,6 +20,9 @@ namespace PepperDash.Essentials.Core.Config
{
public static event EventHandler<ConfigStatusEventArgs> ConfigStatusChanged;
/// <summary>
/// GetConfigFromServer method
/// </summary>
public static void GetConfigFromServer(string url)
{
Debug.LogMessage(LogEventLevel.Information, "Attempting to get new config from '{0}'", url);
@@ -202,6 +205,9 @@ namespace PepperDash.Essentials.Core.Config
}
/// <summary>
/// Enumeration of eUpdateStatus values
/// </summary>
public enum eUpdateStatus
{
UpdateStarted,
@@ -214,8 +220,14 @@ namespace PepperDash.Essentials.Core.Config
UpdateFailed
}
/// <summary>
/// Represents a ConfigStatusEventArgs
/// </summary>
public class ConfigStatusEventArgs : EventArgs
{
/// <summary>
/// Gets or sets the UpdateStatus
/// </summary>
public eUpdateStatus UpdateStatus { get; private set; }
public ConfigStatusEventArgs(eUpdateStatus status)

12
src/PepperDash.Essentials.Core/Config/Essentials/ConfigWriter.cs
View File

@@ -31,6 +31,9 @@ namespace PepperDash.Essentials.Core.Config
/// <param name="deviceKey"></param>
/// <param name="properties"></param>
/// <returns></returns>
/// <summary>
/// UpdateDeviceProperties method
/// </summary>
public static bool UpdateDeviceProperties(string deviceKey, JToken properties)
{
bool success = false;
@@ -53,6 +56,9 @@ namespace PepperDash.Essentials.Core.Config
return success;
}
/// <summary>
/// UpdateDeviceConfig method
/// </summary>
public static bool UpdateDeviceConfig(DeviceConfig config)
{
bool success = false;
@@ -73,6 +79,9 @@ namespace PepperDash.Essentials.Core.Config
return success;
}
/// <summary>
/// UpdateRoomConfig method
/// </summary>
public static bool UpdateRoomConfig(DeviceConfig config)
{
bool success = false;
@@ -124,6 +133,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary>
/// <param name="filepath"></param>
/// <param name="o"></param>
/// <summary>
/// WriteFile method
/// </summary>
public static void WriteFile(string filePath, string configData)
{
if (WriteTimer != null)

12
src/PepperDash.Essentials.Core/Config/Essentials/EssentialsConfig.cs
View File

@@ -68,6 +68,9 @@ namespace PepperDash.Essentials.Core.Config
}
[JsonProperty("rooms")]
/// <summary>
/// Gets or sets the Rooms
/// </summary>
public List<DeviceConfig> Rooms { get; set; }
@@ -78,11 +81,14 @@ namespace PepperDash.Essentials.Core.Config
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Represents a SystemTemplateConfigs
/// </summary>
public class SystemTemplateConfigs
{
/// <summary>
/// Gets or sets the System
/// </summary>
public EssentialsConfig System { get; set; }
public EssentialsConfig Template { get; set; }

3
src/PepperDash.Essentials.Core/Config/ILoadConfig.cs
View File

@@ -6,6 +6,9 @@ using System.Threading.Tasks;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Defines the contract for ILoadConfig
/// </summary>
public interface ILoadConfig
{
void GoWithLoad();

17
src/PepperDash.Essentials.Core/Config/InfoConfig.cs
View File

@@ -22,18 +22,33 @@ namespace PepperDash.Essentials.Core.Config
public string Type { get; set; }
[JsonProperty("version")]
/// <summary>
/// Gets or sets the Version
/// </summary>
public string Version { get; set; }
[JsonProperty("runtimeInfo")]
/// <summary>
/// Gets or sets the RuntimeInfo
/// </summary>
public RuntimeInfo RuntimeInfo { get; set; }
[JsonProperty("comment")]
/// <summary>
/// Gets or sets the Comment
/// </summary>
public string Comment { get; set; }
[JsonProperty("hostname")]
/// <summary>
/// Gets or sets the HostName
/// </summary>
public string HostName { get; set; }
[JsonProperty("appNumber")]
/// <summary>
/// Gets or sets the AppNumber
/// </summary>
public uint AppNumber { get; set; }
public InfoConfig()
@@ -52,7 +67,7 @@ namespace PepperDash.Essentials.Core.Config
/// <summary>
/// Represents runtime information about the program/processor
/// Represents a RuntimeInfo
/// </summary>
public class RuntimeInfo
{

6
src/PepperDash.Essentials.Core/Config/SourceDevicePropertiesConfigBase.cs
View File

@@ -6,8 +6,14 @@ using Crestron.SimplSharp;
namespace PepperDash.Essentials.Core.Config
{
/// <summary>
/// Represents a SourceDevicePropertiesConfigBase
/// </summary>
public class SourceDevicePropertiesConfigBase
{
/// <summary>
/// Gets or sets the DisableSharing
/// </summary>
public bool DisableSharing { get; set; }
}
}