diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IAudioZone.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IAudioZone.cs
index 593c2ea8..0ec65d79 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IAudioZone.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IAudioZone.cs
@@ -5,6 +5,10 @@ namespace PepperDash.Essentials.Core
///
public interface IAudioZone : IBasicVolumeWithFeedback
{
+ ///
+ /// Selects the specified input
+ ///
+ /// The input to select
void SelectInput(ushort input);
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IBasicVolumeWithFeedback.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IBasicVolumeWithFeedback.cs
index addee08a..6071aeaf 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IBasicVolumeWithFeedback.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IBasicVolumeWithFeedback.cs
@@ -5,10 +5,26 @@ namespace PepperDash.Essentials.Core
///
public interface IBasicVolumeWithFeedback : IBasicVolumeControls
{
- BoolFeedback MuteFeedback { get; }
+
+ ///
+ /// Mutes the volume
+ ///
void MuteOn();
+
+ ///
+ /// Unmutes the volume
+ ///
void MuteOff();
+
+ ///
+ /// Sets the volume to the specified level
+ ///
+ /// The volume level to set
void SetVolume(ushort level);
+
+ ///
+ /// Gets the mute feedback
+ ///
IntFeedback VolumeLevelFeedback { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IBasicVolumeWithFeedbackAdvanced.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IBasicVolumeWithFeedbackAdvanced.cs
index 5f51ce02..f0a018c5 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IBasicVolumeWithFeedbackAdvanced.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IBasicVolumeWithFeedbackAdvanced.cs
@@ -5,8 +5,14 @@ namespace PepperDash.Essentials.Core
///
public interface IBasicVolumeWithFeedbackAdvanced : IBasicVolumeWithFeedback
{
+ ///
+ /// Gets the raw volume level
+ ///
int RawVolumeLevel { get; }
+ ///
+ /// Gets the volume level units
+ ///
eVolumeLevelUnits Units { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IChannel.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IChannel.cs
index 09e0ac7a..c8c54006 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IChannel.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IChannel.cs
@@ -7,26 +7,56 @@ using PepperDash.Essentials.Core.SmartObjects;
namespace PepperDash.Essentials.Core
{
///
- ///
+ /// Defines the contract for IChannel
///
public interface IChannel
{
+ ///
+ /// Channel up
+ ///
+ /// indicates whether this is a press or release
+ ///
void ChannelUp(bool pressRelease);
+ ///
+ /// Channel down
+ ///
+ /// indicates whether this is a press or release
void ChannelDown(bool pressRelease);
+
+ ///
+ /// Last channel
+ ///
+ /// indicates whether this is a press or release
void LastChannel(bool pressRelease);
+
+ ///
+ /// Guide
+ ///
+ /// indicates whether this is a press or release
+ ///
void Guide(bool pressRelease);
+
+ ///
+ /// Info
+ ///
+ /// indicates whether this is a press or release
void Info(bool pressRelease);
+
+ ///
+ /// Exit
+ ///
+ /// indicates whether this is a press or release
void Exit(bool pressRelease);
}
///
- ///
+ /// IChannelExtensions class
///
public static class IChannelExtensions
{
- ///
- /// LinkButtons method
- ///
+ ///
+ /// LinkButtons method
+ ///
public static void LinkButtons(this IChannel dev, BasicTriList triList)
{
triList.SetBoolSigAction(123, dev.ChannelUp);
@@ -37,9 +67,9 @@ namespace PepperDash.Essentials.Core
triList.SetBoolSigAction(134, dev.Exit);
}
- ///
- /// UnlinkButtons method
- ///
+ ///
+ /// UnlinkButtons method
+ ///
public static void UnlinkButtons(this IChannel dev, BasicTriList triList)
{
triList.ClearBoolSigAction(123);
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IColorFunctions.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IColorFunctions.cs
index 0df2a97d..69acc8f6 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IColorFunctions.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IColorFunctions.cs
@@ -7,24 +7,45 @@ using PepperDash.Essentials.Core.SmartObjects;
namespace PepperDash.Essentials.Core
{
///
- ///
+ /// IColor interface
///
public interface IColor
{
+ ///
+ /// Red button
+ ///
+ /// indicates whether this is a press or release
void Red(bool pressRelease);
+
+ ///
+ /// Green button
+ ///
+ /// indicates whether this is a press or release
void Green(bool pressRelease);
+
+ ///
+ /// Yellow button
+ ///
+ /// indicates whether this is a press or release
void Yellow(bool pressRelease);
+
+ ///
+ /// Blue button
+ ///
+ /// indicates whether this is a press or release
void Blue(bool pressRelease);
}
///
- ///
+ /// IColorExtensions class
///
public static class IColorExtensions
{
- ///
- /// LinkButtons method
- ///
+ ///
+ /// LinkButtons method
+ ///
+ /// The IColor device
+ /// The BasicTriList to link
public static void LinkButtons(this IColor dev, BasicTriList TriList)
{
TriList.SetBoolSigAction(155, dev.Red);
@@ -33,9 +54,11 @@ namespace PepperDash.Essentials.Core
TriList.SetBoolSigAction(158, dev.Blue);
}
- ///
- /// UnlinkButtons method
- ///
+ ///
+ /// UnlinkButtons method
+ ///
+ /// The IColor device
+ /// The BasicTriList to unlink
public static void UnlinkButtons(this IColor dev, BasicTriList triList)
{
triList.ClearBoolSigAction(155);
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IDPad.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IDPad.cs
index 4a070382..ec9362b8 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IDPad.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IDPad.cs
@@ -11,23 +11,57 @@ namespace PepperDash.Essentials.Core
///
public interface IDPad : IKeyed
{
+ ///
+ /// Up button press
+ ///
+ /// determines if the button is pressed or released
void Up(bool pressRelease);
+
+ ///
+ /// Down button press
+ ///
+ /// determines if the button is pressed or released
void Down(bool pressRelease);
+
+ ///
+ /// Left button press
+ ///
+ /// determines if the button is pressed or released
void Left(bool pressRelease);
+
+ ///
+ /// Right button press
+ ///
+ /// determines if the button is pressed or released
void Right(bool pressRelease);
+
+ ///
+ /// Select button press
+ ///
+ /// determines if the button is pressed or released
void Select(bool pressRelease);
+
+ ///
+ /// Menu button press
+ ///
+ /// determines if the button is pressed or released
void Menu(bool pressRelease);
+
+ ///
+ /// Exit button press
+ ///
+ /// determines if the button is pressed or released
void Exit(bool pressRelease);
}
///
- ///
+ /// IDPadExtensions class
///
public static class IDPadExtensions
{
- ///
- /// LinkButtons method
- ///
+ ///
+ /// LinkButtons method
+ ///
public static void LinkButtons(this IDPad dev, BasicTriList triList)
{
triList.SetBoolSigAction(138, dev.Up);
@@ -39,9 +73,9 @@ namespace PepperDash.Essentials.Core
triList.SetBoolSigAction(134, dev.Exit);
}
- ///
- /// UnlinkButtons method
- ///
+ ///
+ /// UnlinkButtons method
+ ///
public static void UnlinkButtons(this IDPad dev, BasicTriList triList)
{
triList.ClearBoolSigAction(138);
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IDvr.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IDvr.cs
index 214fa78b..527e8d46 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IDvr.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IDvr.cs
@@ -16,24 +16,40 @@ namespace PepperDash.Essentials.Core
///
public interface IDvr : IDPad
{
+ ///
+ /// DVR List button press
+ ///
+ /// determines if the button is pressed or released
void DvrList(bool pressRelease);
+
+ ///
+ /// Record button press
+ ///
+ /// determines if the button is pressed or released
void Record(bool pressRelease);
}
///
- ///
+ /// IDvrExtensions class
///
public static class IDvrExtensions
{
- ///
- /// LinkButtons method
- ///
+ ///
+ /// LinkButtons method
+ ///
+ /// IDvr device
+ /// BasicTriList to link to
public static void LinkButtons(this IDvr dev, BasicTriList triList)
{
triList.SetBoolSigAction(136, dev.DvrList);
triList.SetBoolSigAction(152, dev.Record);
}
+ ///
+ /// UnlinkButtons method
+ ///
+ /// IDvr device
+ /// BasicTriList to unlink from
public static void UnlinkButtons(this IDvr dev, BasicTriList triList)
{
triList.ClearBoolSigAction(136);
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IEmergencyOSD.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IEmergencyOSD.cs
index c24e3e7a..efc068b0 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IEmergencyOSD.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IEmergencyOSD.cs
@@ -11,7 +11,15 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface IEmergencyOSD
{
+ ///
+ /// Shows an emergency message on the OSD
+ ///
+ /// The URL of the emergency message to display
void ShowEmergencyMessage(string url);
+
+ ///
+ /// Hides the emergency message from the OSD
+ ///
void HideEmergencyMessage();
}
}
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IFullAudioSettings.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IFullAudioSettings.cs
index 5344dd6f..7036551c 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IFullAudioSettings.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IFullAudioSettings.cs
@@ -5,37 +5,149 @@ namespace PepperDash.Essentials.Core
///
public interface IFullAudioSettings : IBasicVolumeWithFeedback
{
+ ///
+ /// SetBalance method
+ ///
+ /// level to set
void SetBalance(ushort level);
+
+ ///
+ /// BalanceLeft method
+ ///
+ /// determines if the button is pressed or released
void BalanceLeft(bool pressRelease);
+
+ ///
+ /// BalanceRight method
+ ///
+ /// determines if the button is pressed or released
void BalanceRight(bool pressRelease);
+ ///
+ /// SetBass method
+ ///
+ /// level to set
void SetBass(ushort level);
+
+ ///
+ /// BassUp method
+ ///
+ /// determines if the button is pressed or released
void BassUp(bool pressRelease);
+
+ ///
+ /// BassDown method
+ ///
+ /// determines if the button is pressed or released
void BassDown(bool pressRelease);
+ ///
+ /// SetTreble method
+ ///
+ /// level to set
void SetTreble(ushort level);
+
+ ///
+ /// TrebleUp method
+ ///
+ /// determines if the button is pressed or released
void TrebleUp(bool pressRelease);
+
+ ///
+ /// TrebleDown method
+ ///
+ /// determines if the button is pressed or released
void TrebleDown(bool pressRelease);
+ ///
+ /// hasMaxVolume property
+ ///
bool hasMaxVolume { get; }
+
+ ///
+ /// SetMaxVolume method
+ ///
+ /// level to set
void SetMaxVolume(ushort level);
+
+ ///
+ /// MaxVolumeUp method
+ ///
+ /// determines if the button is pressed or released
void MaxVolumeUp(bool pressRelease);
+
+ ///
+ /// MaxVolumeDown method
+ ///
+ /// determines if the button is pressed or released
void MaxVolumeDown(bool pressRelease);
+ ///
+ /// hasDefaultVolume property
+ ///
bool hasDefaultVolume { get; }
+
+ ///
+ /// SetDefaultVolume method
+ ///
+ /// level to set
void SetDefaultVolume(ushort level);
+
+ ///
+ /// DefaultVolumeUp method
+ ///
+ /// determines if the button is pressed or released
void DefaultVolumeUp(bool pressRelease);
+
+ ///
+ /// DefaultVolumeDown method
+ ///
+ /// determines if the button is pressed or released
void DefaultVolumeDown(bool pressRelease);
+ ///
+ /// LoudnessToggle method
+ ///
void LoudnessToggle();
+
+ ///
+ /// MonoToggle method
+ ///
void MonoToggle();
+ ///
+ /// LoudnessFeedback property
+ ///
BoolFeedback LoudnessFeedback { get; }
+
+ ///
+ /// MonoFeedback property
+ ///
BoolFeedback MonoFeedback { get; }
+
+ ///
+ /// BalanceFeedback property
+ ///
IntFeedback BalanceFeedback { get; }
+
+ ///
+ /// BassFeedback property
+ ///
IntFeedback BassFeedback { get; }
+
+ ///
+ /// TrebleFeedback property
+ ///
IntFeedback TrebleFeedback { get; }
+
+ ///
+ /// MaxVolumeFeedback property
+ ///
IntFeedback MaxVolumeFeedback { get; }
+
+ ///
+ /// DefaultVolumeFeedback property
+ ///
IntFeedback DefaultVolumeFeedback { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasBranding.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasBranding.cs
index 299f1431..c05ef572 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasBranding.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasBranding.cs
@@ -7,7 +7,15 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface IHasBranding
{
+ ///
+ /// Gets whether branding is enabled
+ ///
bool BrandingEnabled { get; }
+
+ ///
+ /// Initializes branding for the device
+ ///
+ /// The key identifying the room for branding purposes
void InitializeBranding(string roomKey);
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasCurrentVolumeControls.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasCurrentVolumeControls.cs
index e6b1d7a3..8239f2d5 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasCurrentVolumeControls.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasCurrentVolumeControls.cs
@@ -7,11 +7,24 @@ namespace PepperDash.Essentials.Core
///
public interface IHasCurrentVolumeControls
{
+ ///
+ /// CurrentVolumeControls property
+ ///
IBasicVolumeControls CurrentVolumeControls { get; }
+
+ ///
+ /// CurrentVolumeDeviceChange event
+ ///
event EventHandler CurrentVolumeDeviceChange;
+ ///
+ /// SetDefaultLevels method
+ ///
void SetDefaultLevels();
+ ///
+ /// ZeroVolumeWhenSwtichingVolumeDevices property
+ ///
bool ZeroVolumeWhenSwtichingVolumeDevices { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasFarEndContentStatus.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasFarEndContentStatus.cs
index 114665db..5a8f66ee 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasFarEndContentStatus.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasFarEndContentStatus.cs
@@ -5,6 +5,9 @@
///
public interface IHasFarEndContentStatus
{
+ ///
+ /// Gets whether far end content is being received
+ ///
BoolFeedback ReceivingContent { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasInputs.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasInputs.cs
index ff9511fa..42e97b4b 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasInputs.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasInputs.cs
@@ -11,6 +11,9 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface IHasInputs : IKeyName
{
+ ///
+ /// Gets the collection of inputs
+ ///
ISelectableItems Inputs { get; }
}
}
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasMuteControl.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasMuteControl.cs
index 4a89d8cf..20867868 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasMuteControl.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasMuteControl.cs
@@ -5,6 +5,9 @@ namespace PepperDash.Essentials.Core
///
public interface IHasMuteControl
{
+ ///
+ /// MuteToggle method
+ ///
void MuteToggle();
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasMuteControlWithFeedback.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasMuteControlWithFeedback.cs
index 5278541a..eb71b40f 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasMuteControlWithFeedback.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasMuteControlWithFeedback.cs
@@ -5,8 +5,19 @@ namespace PepperDash.Essentials.Core
///
public interface IHasMuteControlWithFeedback : IHasMuteControl
{
+ ///
+ /// MuteFeedback property
+ ///
BoolFeedback MuteFeedback { get; }
+
+ ///
+ /// MuteOn method
+ ///
void MuteOn();
+
+ ///
+ /// MuteOff method
+ ///
void MuteOff();
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasPhoneDialing.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasPhoneDialing.cs
index 80fdcbe4..b884092b 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasPhoneDialing.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasPhoneDialing.cs
@@ -8,11 +8,36 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface IHasPhoneDialing
{
+ ///
+ /// Feedback that indicates whether the phone is off-hook
+ ///
BoolFeedback PhoneOffHookFeedback { get; }
+
+ ///
+ /// Feedback that provides the caller ID name
+ ///
StringFeedback CallerIdNameFeedback { get; }
+
+ ///
+ /// Feedback that provides the caller ID number
+ ///
StringFeedback CallerIdNumberFeedback { get; }
+
+ ///
+ /// Dials a phone call to the specified number
+ ///
+ /// the number to dial
void DialPhoneCall(string number);
+
+ ///
+ /// Ends the current phone call
+ ///
void EndPhoneCall();
+
+ ///
+ /// Sends a DTMF digit to the phone
+ ///
+ /// the DTMF digit to send
void SendDtmfToPhone(string digit);
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasSurroundSoundModes.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasSurroundSoundModes.cs
index c1c4ec86..45b24f8b 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasSurroundSoundModes.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasSurroundSoundModes.cs
@@ -11,10 +11,18 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
/// Describes a device that has selectable surround sound modes
///
/// the type to use as the key for each input item. Most likely an enum or string
+ /// the type used to select an item. Most likely an enum or string
public interface IHasSurroundSoundModes: IKeyName
{
+ ///
+ /// The available surround sound modes
+ ///
ISelectableItems SurroundSoundModes { get; }
+ ///
+ /// The currently selected surround sound mode
+ ///
+ /// the selector for the surround sound mode
void SetSurroundSoundMode(TSelector selector);
}
}
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeControl.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeControl.cs
index eae458a3..aff866de 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeControl.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeControl.cs
@@ -5,7 +5,16 @@ namespace PepperDash.Essentials.Core
///
public interface IHasVolumeControl
{
+ ///
+ /// VolumeUp method
+ ///
+ /// determines if the volume up command is a press or release action
void VolumeUp(bool pressRelease);
+
+ ///
+ /// VolumeDown method
+ ///
+ /// determines if the volume down command is a press or release action
void VolumeDown(bool pressRelease);
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeControlWithFeedback.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeControlWithFeedback.cs
index a021edb1..fe3f5440 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeControlWithFeedback.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeControlWithFeedback.cs
@@ -5,7 +5,15 @@ namespace PepperDash.Essentials.Core
///
public interface IHasVolumeControlWithFeedback : IHasVolumeControl
{
+ ///
+ /// SetVolume method
+ ///
+ /// The volume level to set
void SetVolume(ushort level);
+
+ ///
+ /// VolumeLevelFeedback property
+ ///
IntFeedback VolumeLevelFeedback { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeDevice.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeDevice.cs
index 706271aa..3012da19 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeDevice.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasVolumeDevice.cs
@@ -5,6 +5,9 @@ namespace PepperDash.Essentials.Core
///
public interface IHasVolumeDevice
{
+ ///
+ /// VolumeDevice property
+ ///
IBasicVolumeControls VolumeDevice { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasWebView.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasWebView.cs
index 3d95504c..be751f41 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasWebView.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IHasWebView.cs
@@ -11,9 +11,28 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface IHasWebView
{
+ ///
+ /// Indicates whether the webview is currently visible
+ ///
bool WebviewIsVisible { get; }
+
+ ///
+ /// Shows the webview with the specified parameters
+ ///
+ /// the URL to display in the webview
+ /// the display mode for the webview
+ /// the title to display on the webview
+ /// the target for the webview
void ShowWebView(string url, string mode, string title, string target);
+
+ ///
+ /// Hides the webview
+ ///
void HideWebView();
+
+ ///
+ /// Event raised when the webview status changes
+ ///
event EventHandler WebViewStatusChanged;
}
@@ -27,6 +46,10 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public string Status { get; }
+ ///
+ /// Constructor for WebViewStatusChangedEventArgs
+ ///
+ /// the new status of the webview
public WebViewStatusChangedEventArgs(string status)
{
Status = status;
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILanguageDefinition.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILanguageDefinition.cs
index 6a168f2d..f02c0e05 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILanguageDefinition.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILanguageDefinition.cs
@@ -8,14 +8,49 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface ILanguageDefinition
{
+ ///
+ /// The locale name for the language definition
+ ///
string LocaleName { get; set; }
+
+ ///
+ /// The friendly name for the language definition
+ ///
string FriendlyName { get; set; }
+
+ ///
+ /// Indicates whether the language definition is enabled
+ ///
bool Enable { get; set; }
+
+ ///
+ /// The UI labels for the language definition
+ ///
List UiLabels { get; set; }
+
+ ///
+ /// The source and destination labels for the language definition
+ ///
List Sources { get; set; }
+
+ ///
+ /// The destination labels for the language definition
+ ///
List Destinations { get; set; }
+
+ ///
+ /// The source group names for the language definition
+ ///
List SourceGroupNames { get; set; }
+
+ ///
+ /// The destination group names for the language definition
+ ///
List DestinationGroupNames { get; set; }
+
+ ///
+ /// The room names for the language definition
+ ///
List RoomNames { get; set; }
}
}
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILanguageProvider.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILanguageProvider.cs
index ea6afe3b..9ac22d2b 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILanguageProvider.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILanguageProvider.cs
@@ -8,8 +8,14 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface ILanguageProvider
{
+ ///
+ /// The current language definition
+ ///
ILanguageDefinition CurrentLanguage { get; set; }
+ ///
+ /// Event raised when the current language changes
+ ///
event EventHandler CurrentLanguageChanged;
}
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILevelControls.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILevelControls.cs
index 34c87419..e0a1081f 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILevelControls.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ILevelControls.cs
@@ -11,6 +11,9 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface ILevelControls
{
+ ///
+ /// The level control points
+ ///
Dictionary LevelControlPoints { get; }
}
}
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlAction.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlAction.cs
index 982deaae..86a3d61a 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlAction.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlAction.cs
@@ -8,8 +8,14 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface IMobileControlAction
{
+ ///
+ /// The messenger to use for mobile control actions
+ ///
IMobileControlMessenger Messenger { get; }
+ ///
+ /// The action to perform for mobile control actions
+ ///
Action Action { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlMessage.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlMessage.cs
index 41645da2..326eb38d 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlMessage.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlMessage.cs
@@ -3,14 +3,26 @@ using Newtonsoft.Json.Linq;
namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
{
+ ///
+ /// Defines the contract for IMobileControlMessage
+ ///
public interface IMobileControlMessage
{
+ ///
+ /// The type of mobile control message
+ ///
[JsonProperty("type")]
string Type { get; }
+ ///
+ /// The client ID for the mobile control message
+ ///
[JsonProperty("clientId", NullValueHandling = NullValueHandling.Ignore)]
string ClientId { get; }
+ ///
+ /// The content of the mobile control message
+ ///
[JsonProperty("content", NullValueHandling = NullValueHandling.Ignore)]
JToken Content { get; }
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlRoomMessenger.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlRoomMessenger.cs
index 6f4d9a17..9a0a5517 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlRoomMessenger.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IMobileControlRoomMessenger.cs
@@ -8,26 +8,60 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface IMobileControlRoomMessenger : IKeyed
{
+ ///
+ /// Raised when the user code changes
+ ///
event EventHandler UserCodeChanged;
+ ///
+ /// Raised when the user is prompted for the code
+ ///
event EventHandler UserPromptedForCode;
+ ///
+ /// Raised when a client joins the room
+ ///
event EventHandler ClientJoined;
+ ///
+ /// Raised when the app url changes
+ ///
event EventHandler AppUrlChanged;
+ ///
+ /// The user code for joining the room
+ ///
string UserCode { get; }
+ ///
+ /// The QR code URL for joining the room
+ ///
string QrCodeUrl { get; }
+ ///
+ /// The QR code checksum
+ ///
string QrCodeChecksum { get; }
+ ///
+ /// The Mobile Control server URL
+ ///
string McServerUrl { get; }
+ ///
+ /// The name of the room
+ ///
string RoomName { get; }
+ ///
+ /// The Mobile Control app URL
+ ///
string AppUrl { get; }
+ ///
+ /// Updates the url of the Mobile Control app
+ ///
+ /// The new URL of the Mobile Control app
void UpdateAppUrl(string url);
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/INumeric.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/INumeric.cs
index 3adb7f4e..fc0fca99 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/INumeric.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/INumeric.cs
@@ -10,37 +10,119 @@ namespace PepperDash.Essentials.Core
///
public interface INumericKeypad:IKeyed
{
+ ///
+ /// Digit buttons 0
+ ///
+ /// determines if the digit button command is a press or release action
void Digit0(bool pressRelease);
+
+ ///
+ /// Digit buttons 1
+ ///
+ /// determines if the digit button command is a press or release action
void Digit1(bool pressRelease);
+
+ ///
+ /// Digit buttons 2
+ ///
+ /// determines if the digit button command is a press or release action
void Digit2(bool pressRelease);
+
+ ///
+ /// Digit buttons 3
+ ///
+ /// determines if the digit button command is a press or release action
void Digit3(bool pressRelease);
+
+ ///
+ /// Digit buttons 4
+ ///
+ ///
void Digit4(bool pressRelease);
+
+ ///
+ /// Digit buttons 5
+ ///
+ /// determines if the digit button command is a press or release action
void Digit5(bool pressRelease);
+
+ ///
+ /// Digit buttons 6
+ ///
+ /// determines if the digit button command is a press or release action
void Digit6(bool pressRelease);
+
+ ///
+ /// Digit buttons 7
+ ///
+ /// determines if the digit button command is a press or release action
void Digit7(bool pressRelease);
+
+ ///
+ /// Digit buttons 8
+ ///
+ /// determines if the digit button command is a press or release action
void Digit8(bool pressRelease);
+
+ ///
+ /// Digit buttons 9
+ ///
+ /// determines if the digit button command is a press or release action
void Digit9(bool pressRelease);
///
/// Used to hide/show the button and/or text on the left-hand keypad button
///
bool HasKeypadAccessoryButton1 { get; }
+
+ ///
+ /// Label for the left-hand keypad button
+ ///
string KeypadAccessoryButton1Label { get; }
+
+ ///
+ /// Left-hand keypad button action
+ ///
+ /// determines if the button command is a press or release action
void KeypadAccessoryButton1(bool pressRelease);
+ ///
+ /// Used to hide/show the button and/or text on the right-hand keypad button
+ ///
bool HasKeypadAccessoryButton2 { get; }
+
+ ///
+ /// Label for the right-hand keypad button
+ ///
string KeypadAccessoryButton2Label { get; }
+
+ ///
+ /// Right-hand keypad button action
+ ///
+ /// determines if the button command is a press or release action
void KeypadAccessoryButton2(bool pressRelease);
}
+ ///
+ /// Defines the contract for ISetTopBoxNumericKeypad
+ ///
public interface ISetTopBoxNumericKeypad : INumericKeypad
{
+ ///
+ /// Dash button action
+ ///
+ /// determines if the button command is a press or release action
void Dash(bool pressRelease);
+
+ ///
+ /// Keypad Enter button action
+ ///
+ /// determines if the button command is a press or release action
void KeypadEnter(bool pressRelease);
}
///
- ///
+ /// INumericExtensions class
///
public static class INumericExtensions
{
@@ -65,9 +147,9 @@ namespace PepperDash.Essentials.Core
trilist.StringInput[111].StringValue = dev.KeypadAccessoryButton2Label;
}
- ///
- /// UnlinkButtons method
- ///
+ ///
+ /// UnlinkButtons method
+ ///
public static void UnlinkButtons(this INumericKeypad dev, BasicTriList trilist)
{
trilist.ClearBoolSigAction(110);
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IPasswordPrompt.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IPasswordPrompt.cs
index 31e7acaf..2ee85341 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IPasswordPrompt.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IPasswordPrompt.cs
@@ -19,10 +19,13 @@ namespace PepperDash.Essentials.Core
///
/// Submits the password
///
- ///
+ /// The password to submit
void SubmitPassword(string password);
}
+ ///
+ /// PasswordPromptEventArgs class
+ ///
public class PasswordPromptEventArgs : EventArgs
{
///
@@ -45,6 +48,13 @@ namespace PepperDash.Essentials.Core
///
public string Message { get; private set; }
+ ///
+ /// Constructor
+ ///
+ /// indicates if the last submitted password was incorrect
+ /// indicates if the login attempt failed
+ /// indicates if the login attempt was cancelled
+ /// provides a message related to the password prompt
public PasswordPromptEventArgs(bool lastAttemptIncorrect, bool loginFailed, bool loginCancelled, string message)
{
LastAttemptWasIncorrect = lastAttemptIncorrect;
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IPower.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IPower.cs
index 79c58fa2..b94a64ed 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IPower.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IPower.cs
@@ -19,6 +19,9 @@ namespace PepperDash.Essentials.Core
///
public interface IHasPowerControlWithFeedback : IHasPowerControl
{
+ ///
+ /// Feedback indicating whether the device is powered on
+ ///
BoolFeedback PowerIsOnFeedback { get; }
}
@@ -27,13 +30,24 @@ namespace PepperDash.Essentials.Core
///
public interface IHasPowerControl
{
+ ///
+ /// Powers the device on
+ ///
void PowerOn();
+
+ ///
+ /// Powers the device off
+ ///
void PowerOff();
+
+ ///
+ /// Toggles the power state of the device
+ ///
void PowerToggle();
}
///
- ///
+ /// IHasPowerControlExtensions class
///
public static class IHasPowerControlExtensions
{
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IProjectorScreenLiftControl.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IProjectorScreenLiftControl.cs
index 1d5d20da..56aef09e 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IProjectorScreenLiftControl.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IProjectorScreenLiftControl.cs
@@ -5,26 +5,60 @@ using Newtonsoft.Json.Converters;
namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
{
- ///
- /// Defines the contract for IProjectorScreenLiftControl
- ///
+ ///
+ /// Defines the contract for IProjectorScreenLiftControl
+ ///
public interface IProjectorScreenLiftControl
{
+ ///
+ /// Raises the screen/lift
+ ///
void Raise();
+
+ ///
+ /// Lowers the screen/lift
+ ///
void Lower();
+
+ ///
+ /// Stops the screen/lift
+ ///
BoolFeedback IsInUpPosition { get; }
+
+ ///
+ /// Gets whether the screen/lift is in the up position
+ ///
bool InUpPosition { get; }
+
+ ///
+ /// Gets whether the screen/lift is in the down position
+ ///
event EventHandler PositionChanged;
+
+ ///
+ /// The device key of the display associated with this screen/lift
+ ///
string DisplayDeviceKey { get; }
+
+ ///
+ /// The type of device
+ ///
eScreenLiftControlType Type { get; } // screen/lift
}
- ///
- /// Enumeration of eScreenLiftControlType values
- ///
+ ///
+ /// Enumeration of eScreenLiftControlType values
+ ///
public enum eScreenLiftControlType
{
+ ///
+ /// Lift type device
+ ///
lift,
+
+ ///
+ /// Screen type device
+ ///
screen
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISelectableItem.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISelectableItem.cs
index 8d99b959..ff05188e 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISelectableItem.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISelectableItem.cs
@@ -10,10 +10,20 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface ISelectableItem : IKeyName
{
+ ///
+ /// Raised when the item is updated
+ ///
event EventHandler ItemUpdated;
+ ///
+ /// Gets or sets whether the item is selected
+ ///
[JsonProperty("isSelected")]
bool IsSelected { get; set; }
+
+ ///
+ /// Selects the item
+ ///
void Select();
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISelectableItems.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISelectableItems.cs
index f3d2beec..c955a56f 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISelectableItems.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISelectableItems.cs
@@ -9,12 +9,25 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface ISelectableItems where TValue : ISelectableItem
{
+ ///
+ /// Raised when the items are updated
+ ///
event EventHandler ItemsUpdated;
+
+ ///
+ /// Raised when the current item changes
+ ///
event EventHandler CurrentItemChanged;
+ ///
+ /// Gets or sets the collection of selectable items
+ ///
[JsonProperty("items")]
Dictionary Items { get; set; }
+ ///
+ /// Gets or sets the current selected item key
+ ///
[JsonProperty("currentItem")]
TKey CurrentItem { get; set; }
@@ -24,9 +37,6 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
/// Describes a collection of items that can be selected
///
/// type for the keys in the collection. Probably a string or enum
- ///
- /// Defines the contract for ISelectableItems
- ///
public interface ISelectableItems : ISelectableItems
{
}
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISetTopBoxControls.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISetTopBoxControls.cs
index 646aab93..d8bf969e 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISetTopBoxControls.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ISetTopBoxControls.cs
@@ -5,9 +5,9 @@ using PepperDash.Essentials.Core.SmartObjects;
namespace PepperDash.Essentials.Core
{
- ///
- /// Defines the contract for ISetTopBoxControls
- ///
+ ///
+ /// Defines the contract for ISetTopBoxControls
+ ///
public interface ISetTopBoxControls : IChannel, IColor, IDPad, ISetTopBoxNumericKeypad,
ITransport, IUiDisplayInfo
{
@@ -31,27 +31,51 @@ namespace PepperDash.Essentials.Core
///
bool HasDpad { get; }
+ ///
+ /// TV Presets model
+ ///
PepperDash.Essentials.Core.Presets.DevicePresetsModel TvPresets { get; }
+
+ ///
+ /// LoadPresets method
+ ///
+ /// path to file that contains the presets
void LoadPresets(string filePath);
+ ///
+ /// DvrList button action
+ ///
+ /// determines if the button action is a press or release
void DvrList(bool pressRelease);
+
+ ///
+ /// Replay button action
+ ///
+ /// determines if the button action is a press or release
void Replay(bool pressRelease);
}
+ ///
+ /// ISetTopBoxControlsExtensions class
+ ///
public static class ISetTopBoxControlsExtensions
{
- ///
- /// LinkButtons method
- ///
+ ///
+ /// LinkButtons method
+ ///
+ /// The ISetTopBoxControls device
+ /// The BasicTriList to link buttons to
public static void LinkButtons(this ISetTopBoxControls dev, BasicTriList triList)
{
triList.SetBoolSigAction(136, dev.DvrList);
triList.SetBoolSigAction(152, dev.Replay);
}
- ///
- /// UnlinkButtons method
- ///
+ ///
+ /// UnlinkButtons method
+ ///
+ /// The ISetTopBoxControls device
+ /// The BasicTriList to unlink buttons from
public static void UnlinkButtons(this ISetTopBoxControls dev, BasicTriList triList)
{
triList.ClearBoolSigAction(136);
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITemperatureSensor.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITemperatureSensor.cs
index f77a2ef8..897855b4 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITemperatureSensor.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITemperatureSensor.cs
@@ -17,9 +17,15 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
IntFeedback TemperatureFeedback { get; }
-
+ ///
+ /// The temperature in Celsius format
+ ///
BoolFeedback TemperatureInCFeedback { get; }
+ ///
+ /// Sets the temperature format to Celsius or Fahrenheit
+ ///
+ /// If true, sets the format to Celsius; otherwise, sets it to Fahrenheit.
void SetTemperatureFormat(bool setToC);
}
}
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITransport.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITransport.cs
index 1a8f2a2b..917a4b19 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITransport.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITransport.cs
@@ -7,25 +7,65 @@ namespace PepperDash.Essentials.Core
///
public interface ITransport
{
+ ///
+ /// Play button action
+ ///
+ /// determines if the button action is a press or release
void Play(bool pressRelease);
+
+ ///
+ /// Pause button action
+ ///
+ /// determines if the button action is a press or release
void Pause(bool pressRelease);
+
+ ///
+ /// Rewind button action
+ ///
+ /// determines if the button action is a press or release
void Rewind(bool pressRelease);
+
+ ///
+ /// Fast Forward button action
+ ///
+ /// determines if the button action is a press or release
void FFwd(bool pressRelease);
+
+ ///
+ /// Chapter Minus button action
+ ///
+ /// determines if the button action is a press or release
void ChapMinus(bool pressRelease);
+
+ ///
+ /// Chapter Plus button action
+ ///
+ /// determines if the button action is a press or release
void ChapPlus(bool pressRelease);
+
+ ///
+ /// Stop button action
+ ///
+ /// determines if the button action is a press or release
void Stop(bool pressRelease);
+
+ ///
+ /// Record button action
+ ///
+ /// determines if the button action is a press or release
void Record(bool pressRelease);
}
///
- ///
+ /// ITransportExtensions class
///
public static class ITransportExtensions
{
///
/// Attaches to trilist joins: Play:145, Pause:146, Stop:147, ChapPlus:148, ChapMinus:149, Rewind:150, Ffwd:151, Record:154
- ///
///
+ /// The ITransport device
+ /// The BasicTriList to link buttons to
public static void LinkButtons(this ITransport dev, BasicTriList triList)
{
triList.SetBoolSigAction(145, dev.Play);
@@ -38,9 +78,11 @@ namespace PepperDash.Essentials.Core
triList.SetBoolSigAction(154, dev.Record);
}
- ///
- /// UnlinkButtons method
- ///
+ ///
+ /// UnlinkButtons method
+ ///
+ /// The ITransport device
+ /// The BasicTriList to unlink buttons from
public static void UnlinkButtons(this ITransport dev, BasicTriList triList)
{
triList.ClearBoolSigAction(145);
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITvPresetsProvider.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITvPresetsProvider.cs
index 68650fa4..09b7066c 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITvPresetsProvider.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/ITvPresetsProvider.cs
@@ -7,6 +7,9 @@ namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
///
public interface ITvPresetsProvider
{
+ ///
+ /// The TV presets model
+ ///
DevicePresetsModel TvPresets { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IUiDisplayInfo.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IUiDisplayInfo.cs
index aa0144fe..231abf1f 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IUiDisplayInfo.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IUiDisplayInfo.cs
@@ -2,11 +2,14 @@
namespace PepperDash.Essentials.Core
{
- ///
- /// Defines the contract for IUiDisplayInfo
- ///
+ ///
+ /// Defines the contract for IUiDisplayInfo
+ ///
public interface IUiDisplayInfo : IKeyed
{
+ ///
+ /// Display UI Type
+ ///
uint DisplayUiType { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IWarmingCooling.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IWarmingCooling.cs
index 2baf1548..e69bf35c 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IWarmingCooling.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IWarmingCooling.cs
@@ -11,7 +11,14 @@ namespace PepperDash.Essentials.Core
///
public interface IWarmingCooling
{
+ ///
+ /// Feedback indicating whether the device is warming up
+ ///
BoolFeedback IsWarmingUpFeedback { get; }
+
+ ///
+ /// Feedback indicating whether the device is cooling down
+ ///
BoolFeedback IsCoolingDownFeedback { get; }
}
}
\ No newline at end of file
diff --git a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/eVolumeLevelUnits.cs b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/eVolumeLevelUnits.cs
index 0ebb9270..b88ea928 100644
--- a/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/eVolumeLevelUnits.cs
+++ b/src/PepperDash.Essentials.Core/DeviceTypeInterfaces/eVolumeLevelUnits.cs
@@ -1,10 +1,28 @@
namespace PepperDash.Essentials.Core
{
+ ///
+ /// Volume level units
+ ///
public enum eVolumeLevelUnits
{
+ ///
+ /// Decibels
+ ///
Decibels,
+
+ ///
+ /// Percent
+ ///
Percent,
+
+ ///
+ /// Relative
+ ///
Relative,
+
+ ///
+ /// Absolute
+ ///
Absolute
}
}
\ No newline at end of file