pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-08-31 19:08:29 +00:00
Code Issues Projects Releases Packages 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

36
src/PepperDash.Essentials.Core/Global/EthernetAdapterInfo.cs
View file

@ -6,18 +6,54 @@ using Crestron.SimplSharp;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Represents a EthernetAdapterInfo
/// </summary>
public class EthernetAdapterInfo
{
/// <summary>
/// Gets or sets the Type
/// </summary>
public EthernetAdapterType Type { get; set; }
/// <summary>
/// Gets or sets the DhcpIsOn
/// </summary>
public bool DhcpIsOn { get; set; }
/// <summary>
/// Gets or sets the Hostname
/// </summary>
public string Hostname { get; set; }
/// <summary>
/// Gets or sets the MacAddress
/// </summary>
public string MacAddress { get; set; }
/// <summary>
/// Gets or sets the IpAddress
/// </summary>
public string IpAddress { get; set; }
/// <summary>
/// Gets or sets the Subnet
/// </summary>
public string Subnet { get; set; }
/// <summary>
/// Gets or sets the Gateway
/// </summary>
public string Gateway { get; set; }
/// <summary>
/// Gets or sets the Dns1
/// </summary>
public string Dns1 { get; set; }
/// <summary>
/// Gets or sets the Dns2
/// </summary>
public string Dns2 { get; set; }
/// <summary>
/// Gets or sets the Dns3
/// </summary>
public string Dns3 { get; set; }
/// <summary>
/// Gets or sets the Domain
/// </summary>
public string Domain { get; set; }
}
}

17
src/PepperDash.Essentials.Core/Global/Global.cs
View file

@ -24,14 +24,26 @@ namespace PepperDash.Essentials.Core
{
public static class Global
{
/// <summary>
/// Gets or sets the ControlSystem
/// </summary>
public static CrestronControlSystem ControlSystem { get; set; }
/// <summary>
/// Gets or sets the Platform
/// </summary>
public static eDevicePlatform Platform { get { return CrestronEnvironment.DevicePlatform; } }
public static Dictionary<short, EthernetAdapterInfo> EthernetAdapterInfoCollection { get; private set; }
/// <summary>
/// Gets or sets the LicenseManager
/// </summary>
public static LicenseManager LicenseManager { get; set; }
/// <summary>
/// Gets or sets the ProcessorSeries
/// </summary>
public static eCrestronSeries ProcessorSeries { get { return CrestronEnvironment.ProgramCompatibility; } }
// TODO: consider making this configurable later
@ -99,7 +111,7 @@ namespace PepperDash.Essentials.Core
}
/// <summary>
/// The file path prefix to the folder containing configuration files
/// Gets or sets the FilePathPrefix
/// </summary>
public static string FilePathPrefix { get; private set; }
@ -162,6 +174,9 @@ namespace PepperDash.Essentials.Core
/// Sets the Assembly version to the version of the Essentials Library
/// </summary>
/// <param name="assemblyVersion"></param>
/// <summary>
/// SetAssemblyVersion method
/// </summary>
public static void SetAssemblyVersion(string assemblyVersion)
{
AssemblyVersion = assemblyVersion;

12
src/PepperDash.Essentials.Core/Global/JobTimer.cs
View file

@ -16,6 +16,9 @@ namespace PepperDash.Essentials.Core
///
/// </summary>
/// <param name="act"></param>
/// <summary>
/// AddAction method
/// </summary>
public static void AddAction(Action act)
{
@ -26,6 +29,9 @@ namespace PepperDash.Essentials.Core
/// </summary>
/// <param name="key"></param>
/// <param name="act"></param>
/// <summary>
/// AddJobTimerItem method
/// </summary>
public static void AddJobTimerItem(JobTimerItem item)
{
var existing = Items.FirstOrDefault(i => i.Key == item.Key);
@ -51,9 +57,9 @@ namespace PepperDash.Essentials.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Represents a JobTimerItem
/// </summary>
public class JobTimerItem
{
public string Key { get; private set; }

18
src/PepperDash.Essentials.Core/Global/Scheduler.cs
View file

@ -115,6 +115,9 @@ Recurrence Days: {evt.Value.Recurrence.RecurrenceDays}
/// Adds the event group to the global list
/// </summary>
/// <returns></returns>
/// <summary>
/// AddEventGroup method
/// </summary>
public static void AddEventGroup(ScheduledEventGroup eventGroup)
{
// Add this group to the global collection
@ -126,6 +129,9 @@ Recurrence Days: {evt.Value.Recurrence.RecurrenceDays}
/// Removes the event group from the global list
/// </summary>
/// <param name="eventGroup"></param>
/// <summary>
/// RemoveEventGroup method
/// </summary>
public static void RemoveEventGroup(ScheduledEventGroup eventGroup)
{
if(!EventGroups.ContainsKey(eventGroup.Name))
@ -148,6 +154,9 @@ Recurrence Days: {evt.Value.Recurrence.RecurrenceDays}
/// <param name="eventTime"></param>
/// <param name="recurrence"></param>
/// <returns></returns>
/// <summary>
/// CheckIfDayOfWeekMatchesRecurrenceDays method
/// </summary>
public static bool CheckIfDayOfWeekMatchesRecurrenceDays(DateTime eventTime, ScheduledEventCommon.eWeekDays recurrence)
{
bool isMatch = false;
@ -206,16 +215,25 @@ Recurrence Days: {evt.Value.Recurrence.RecurrenceDays}
return isMatch;
}
/// <summary>
/// CheckEventTimeForMatch method
/// </summary>
public static bool CheckEventTimeForMatch(ScheduledEvent evnt, DateTime time)
{
return evnt.DateAndTime.Hour == time.Hour && evnt.DateAndTime.Minute == time.Minute;
}
/// <summary>
/// CheckEventRecurrenceForMatch method
/// </summary>
public static bool CheckEventRecurrenceForMatch(ScheduledEvent evnt, ScheduledEventCommon.eWeekDays days)
{
return evnt.Recurrence.RecurrenceDays == days;
}
/// <summary>
/// CreateEventFromConfig method
/// </summary>
public static void CreateEventFromConfig(ScheduledEventConfig config, ScheduledEventGroup group, ScheduledEvent.UserEventCallBack handler)
{
try