pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-15 20:54:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add mute logic to ScreenLiftController

Browse Source 
- adds a config value that mutes the display when the screen is in the up position
- screens will now mute/unmute based on their position if the config is set
This commit is contained in:
Nick Genovese
2026-01-01 09:02:04 -06:00
parent 3fb30d5561
commit 7910b7931e
2 changed files with 170 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

227
src/PepperDash.Essentials.Devices.Common/Displays/ScreenLiftController.cs
View File

@@ -19,7 +19,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
{ {
None, None,
Raise, Raise,
Lower Lower,
} }
/// <summary> /// <summary>
@@ -50,7 +50,8 @@ namespace PepperDash.Essentials.Devices.Common.Shades
get { return _isInUpPosition; } get { return _isInUpPosition; }
set set
{ {
if (value == _isInUpPosition) return; if (value == _isInUpPosition)
return;
_isInUpPosition = value; _isInUpPosition = value;
IsInUpPosition.FireUpdate(); IsInUpPosition.FireUpdate();
PositionChanged?.Invoke(this, new EventArgs()); PositionChanged?.Invoke(this, new EventArgs());
@@ -87,7 +88,11 @@ namespace PepperDash.Essentials.Devices.Common.Shades
/// <summary> /// <summary>
/// Constructor for ScreenLiftController /// Constructor for ScreenLiftController
/// </summary> /// </summary>
public ScreenLiftController(string key, string name, ScreenLiftControllerConfigProperties config) public ScreenLiftController(
string key,
string name,
ScreenLiftControllerConfigProperties config
)
: base(key, name) : base(key, name)
{ {
Config = config; Config = config;
@@ -105,27 +110,60 @@ namespace PepperDash.Essentials.Devices.Common.Shades
switch (Mode) switch (Mode)
{ {
case eScreenLiftControlMode.momentary: case eScreenLiftControlMode.momentary:
{ {
RaiseRelayConfig = Config.Relays["raise"]; RaiseRelayConfig = Config.Relays["raise"];
LowerRelayConfig = Config.Relays["lower"]; LowerRelayConfig = Config.Relays["lower"];
break; break;
} }
case eScreenLiftControlMode.latched: case eScreenLiftControlMode.latched:
{ {
LatchedRelayConfig = Config.Relays["latched"]; LatchedRelayConfig = Config.Relays["latched"];
break; break;
} }
} }
IsInUpPosition.OutputChange += (sender, args) =>
{
this.LogDebug(
"ScreenLiftController '{name}' IsInUpPosition changed to {position}",
Name,
IsInUpPosition.BoolValue ? "Up" : "Down"
);
if (!Config.MuteOnScreenUp)
{
return;
}
if (args.BoolValue)
{
return;
}
if (DisplayDevice is IBasicVideoMuteWithFeedback videoMute)
{
this.LogInformation("Unmuting video because screen is down");
videoMute.VideoMuteOff();
}
};
IsInUpPosition.FireUpdate();
} }
private void IsCoolingDownFeedback_OutputChange(object sender, FeedbackEventArgs e) private void IsCoolingDownFeedback_OutputChange(object sender, FeedbackEventArgs e)
{ {
if (!DisplayDevice.IsCoolingDownFeedback.BoolValue && Type == eScreenLiftControlType.lift) if (
!DisplayDevice.IsCoolingDownFeedback.BoolValue
&& Type == eScreenLiftControlType.lift
)
{ {
Raise(); Raise();
return; return;
} }
if (DisplayDevice.IsCoolingDownFeedback.BoolValue && Type == eScreenLiftControlType.screen) if (
DisplayDevice.IsCoolingDownFeedback.BoolValue
&& Type == eScreenLiftControlType.screen
)
{ {
Raise(); Raise();
return; return;
@@ -150,18 +188,18 @@ namespace PepperDash.Essentials.Devices.Common.Shades
switch (Mode) switch (Mode)
{ {
case eScreenLiftControlMode.momentary: case eScreenLiftControlMode.momentary:
{ {
this.LogDebug("Getting relays for {mode}", Mode); this.LogDebug("Getting relays for {mode}", Mode);
RaiseRelay = GetSwitchedOutputFromDevice(RaiseRelayConfig.DeviceKey); RaiseRelay = GetSwitchedOutputFromDevice(RaiseRelayConfig.DeviceKey);
LowerRelay = GetSwitchedOutputFromDevice(LowerRelayConfig.DeviceKey); LowerRelay = GetSwitchedOutputFromDevice(LowerRelayConfig.DeviceKey);
break; break;
} }
case eScreenLiftControlMode.latched: case eScreenLiftControlMode.latched:
{ {
this.LogDebug("Getting relays for {mode}", Mode); this.LogDebug("Getting relays for {mode}", Mode);
LatchedRelay = GetSwitchedOutputFromDevice(LatchedRelayConfig.DeviceKey); LatchedRelay = GetSwitchedOutputFromDevice(LatchedRelayConfig.DeviceKey);
break; break;
} }
} }
this.LogDebug("Getting display with key {displayKey}", DisplayDeviceKey); this.LogDebug("Getting display with key {displayKey}", DisplayDeviceKey);
@@ -172,7 +210,8 @@ namespace PepperDash.Essentials.Devices.Common.Shades
this.LogDebug("Subscribing to {displayKey} feedbacks", DisplayDeviceKey); this.LogDebug("Subscribing to {displayKey} feedbacks", DisplayDeviceKey);
DisplayDevice.IsWarmingUpFeedback.OutputChange += IsWarmingUpFeedback_OutputChange; DisplayDevice.IsWarmingUpFeedback.OutputChange += IsWarmingUpFeedback_OutputChange;
DisplayDevice.IsCoolingDownFeedback.OutputChange += IsCoolingDownFeedback_OutputChange; DisplayDevice.IsCoolingDownFeedback.OutputChange +=
IsCoolingDownFeedback_OutputChange;
} }
return base.CustomActivate(); return base.CustomActivate();
@@ -183,10 +222,17 @@ namespace PepperDash.Essentials.Devices.Common.Shades
/// </summary> /// </summary>
public void Raise() public void Raise()
{ {
if (RaiseRelay == null && LatchedRelay == null) return; if (RaiseRelay == null && LatchedRelay == null)
return;
this.LogDebug("Raise called for {type}", Type); this.LogDebug("Raise called for {type}", Type);
if (Config.MuteOnScreenUp && DisplayDevice is IBasicVideoMuteWithFeedback videoMute)
{
this.LogInformation("Muting video because screen is going up");
videoMute.VideoMuteOn();
}
// If device is moving, bank the command // If device is moving, bank the command
if (_isMoving) if (_isMoving)
{ {
@@ -200,33 +246,33 @@ namespace PepperDash.Essentials.Devices.Common.Shades
switch (Mode) switch (Mode)
{ {
case eScreenLiftControlMode.momentary: case eScreenLiftControlMode.momentary:
{ {
PulseOutput(RaiseRelay, RaiseRelayConfig.PulseTimeInMs); PulseOutput(RaiseRelay, RaiseRelayConfig.PulseTimeInMs);
// Set moving flag and start timer if movement time is configured // Set moving flag and start timer if movement time is configured
if (RaiseRelayConfig.MoveTimeInMs > 0) if (RaiseRelayConfig.MoveTimeInMs > 0)
{
_isMoving = true;
_currentMovement = RequestedState.Raise;
if (_movementTimer.Enabled)
{
_movementTimer.Stop();
}
_movementTimer.Interval = RaiseRelayConfig.MoveTimeInMs;
_movementTimer.Start();
}
else
{
InUpPosition = true;
}
break;
}
case eScreenLiftControlMode.latched:
{ {
LatchedRelay.Off(); _isMoving = true;
InUpPosition = true; _currentMovement = RequestedState.Raise;
break; if (_movementTimer.Enabled)
{
_movementTimer.Stop();
}
_movementTimer.Interval = RaiseRelayConfig.MoveTimeInMs;
_movementTimer.Start();
} }
else
{
InUpPosition = true;
}
break;
}
case eScreenLiftControlMode.latched:
{
LatchedRelay.Off();
InUpPosition = true;
break;
}
} }
} }
@@ -235,7 +281,8 @@ namespace PepperDash.Essentials.Devices.Common.Shades
/// </summary> /// </summary>
public void Lower() public void Lower()
{ {
if (LowerRelay == null && LatchedRelay == null) return; if (LowerRelay == null && LatchedRelay == null)
return;
this.LogDebug("Lower called for {type}", Type); this.LogDebug("Lower called for {type}", Type);
@@ -252,33 +299,33 @@ namespace PepperDash.Essentials.Devices.Common.Shades
switch (Mode) switch (Mode)
{ {
case eScreenLiftControlMode.momentary: case eScreenLiftControlMode.momentary:
{ {
PulseOutput(LowerRelay, LowerRelayConfig.PulseTimeInMs); PulseOutput(LowerRelay, LowerRelayConfig.PulseTimeInMs);
// Set moving flag and start timer if movement time is configured // Set moving flag and start timer if movement time is configured
if (LowerRelayConfig.MoveTimeInMs > 0) if (LowerRelayConfig.MoveTimeInMs > 0)
{
_isMoving = true;
_currentMovement = RequestedState.Lower;
if (_movementTimer.Enabled)
{
_movementTimer.Stop();
}
_movementTimer.Interval = LowerRelayConfig.MoveTimeInMs;
_movementTimer.Start();
}
else
{
InUpPosition = false;
}
break;
}
case eScreenLiftControlMode.latched:
{ {
LatchedRelay.On(); _isMoving = true;
InUpPosition = false; _currentMovement = RequestedState.Lower;
break; if (_movementTimer.Enabled)
{
_movementTimer.Stop();
}
_movementTimer.Interval = LowerRelayConfig.MoveTimeInMs;
_movementTimer.Start();
} }
else
{
InUpPosition = false;
}
break;
}
case eScreenLiftControlMode.latched:
{
LatchedRelay.On();
InUpPosition = false;
break;
}
} }
} }
@@ -339,16 +386,13 @@ namespace PepperDash.Essentials.Devices.Common.Shades
{ {
output.On(); output.On();
var timer = new Timer(pulseTime) var timer = new Timer(pulseTime) { AutoReset = false };
{
AutoReset = false
};
timer.Elapsed += (sender, e) => timer.Elapsed += (sender, e) =>
{ {
output.Off(); output.Off();
timer.Dispose(); timer.Dispose();
}; };
timer.Start(); timer.Start();
} }
@@ -361,7 +405,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
} }
else else
{ {
this.LogWarning("Error: Unable to get relay device with key '{relayKey}'", relayKey); this.LogWarning(
"Error: Unable to get relay device with key '{relayKey}'",
relayKey
);
return null; return null;
} }
} }
@@ -375,11 +422,13 @@ namespace PepperDash.Essentials.Devices.Common.Shades
} }
else else
{ {
this.LogWarning("Error: Unable to get display device with key '{displayKey}'", displayKey); this.LogWarning(
"Error: Unable to get display device with key '{displayKey}'",
displayKey
);
return null; return null;
} }
} }
} }
/// <summary> /// <summary>
@@ -387,7 +436,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
/// </summary> /// </summary>
public class ScreenLiftControllerFactory : EssentialsDeviceFactory<RelayControlledShade> public class ScreenLiftControllerFactory : EssentialsDeviceFactory<RelayControlledShade>
{ {
/// <summary> /// <summary>
/// Constructor for ScreenLiftControllerFactory /// Constructor for ScreenLiftControllerFactory
/// </summary> /// </summary>
public ScreenLiftControllerFactory() public ScreenLiftControllerFactory()
@@ -404,4 +453,4 @@ namespace PepperDash.Essentials.Devices.Common.Shades
return new ScreenLiftController(dc.Key, dc.Name, props); return new ScreenLiftController(dc.Key, dc.Name, props);
} }
} }
} }

60
src/PepperDash.Essentials.Devices.Common/Displays/ScreenLiftControllerConfigProperties.cs
View File

@@ -5,37 +5,41 @@ using PepperDash.Essentials.Core.DeviceTypeInterfaces;
namespace PepperDash.Essentials.Devices.Common.Shades namespace PepperDash.Essentials.Devices.Common.Shades
{ {
/// <summary>
/// Represents a ScreenLiftControllerConfigProperties
/// </summary>
public class ScreenLiftControllerConfigProperties
{
/// <summary> /// <summary>
/// Gets or sets the DisplayDeviceKey /// Represents a ScreenLiftControllerConfigProperties
/// </summary> /// </summary>
[JsonProperty("displayDeviceKey")] public class ScreenLiftControllerConfigProperties
public string DisplayDeviceKey { get; set; } {
/// <summary>
/// Gets or sets the DisplayDeviceKey
/// </summary>
[JsonProperty("displayDeviceKey")]
public string DisplayDeviceKey { get; set; }
/// <summary> /// <summary>
/// Gets or sets the Type /// Gets or sets the Type
/// </summary> /// </summary>
[JsonProperty("type")] [JsonProperty("type")]
[JsonConverter(typeof(StringEnumConverter))] [JsonConverter(typeof(StringEnumConverter))]
public eScreenLiftControlType Type { get; set; } public eScreenLiftControlType Type { get; set; }
/// <summary> /// <summary>
/// Gets or sets the Mode /// Gets or sets the Mode
/// </summary> /// </summary>
[JsonProperty("mode")] [JsonProperty("mode")]
[JsonConverter(typeof(StringEnumConverter))] [JsonConverter(typeof(StringEnumConverter))]
public eScreenLiftControlMode Mode { get; set; } public eScreenLiftControlMode Mode { get; set; }
/// <summary> /// <summary>
/// Gets or sets the Relays /// Gets or sets the Relays
/// </summary> /// </summary>
[JsonProperty("relays")] [JsonProperty("relays")]
public Dictionary<string, ScreenLiftRelaysConfig> Relays { get; set; } public Dictionary<string, ScreenLiftRelaysConfig> Relays { get; set; }
} /// <summary>
} /// Mutes the display when the screen is in the up position
/// </summary>
[JsonProperty("muteOnScreenUp")]
public bool MuteOnScreenUp { get; set; }
}
}