[PowerRun] Fix sleep function

[donlaci]

Summary of the Pull Request

[PowerRun] Update sleep function: Send message to put PC in Modern Standby mode

PR Checklist

• Closes: Cannot use keyboard to wake laptop after put it to sleep with PowerToys run "sleep" #16613
• Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
• Tests: Added/updated and all pass
• Localization: All end user facing strings can be localized
• Dev docs: Added/updated
• New binaries: Added on the required places
  • JSON for signing for new binaries
  • WXS for installer for new binaries and localization folder
  • YML for CI pipeline for new test projects
  • YML for signed pipeline
• Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

Sending message to the system which switches off the monitors, which again initiates the Modern standby mode.
Sending it in a background task to be able to close the PowerRun UI.

Validation Steps Performed

Tested locally

[jaimecbernardo]

Hi, Thanks for opening the PR.
What are we actually doing here? This is lots of magic numbers. The code should have extensive comments to explain what's going on and with links to documentation if possible.
Everyone is going to look at this and think "What? Why?"

[der3318]

Some more background to help reviewers understand the context.

PowerRun triggers sleep via SetSuspendState(bHibernate=false), whose behavior highly differentiates between system configurations:

Default OS Sleep State	S0 Low Power Idle	Traditional S1 S2 S3
Hibernate Available	Start Menu's Sleep: Modern Standby PowerRun's Sleep: Hibernate	Start Menu's Sleep: S1-S3 or Hybrid Sleep PowerRun's Sleep: S1-S3 or Hybrid Sleep
Hibernate Disabled/Unsupported	Start Menu's Sleep: Modern Standby PowerRun's Sleep: Do Nothing	Start Menu's Sleep: S1-S3 Sleep PowerRun's Sleep: S1-S3 Sleep

To fix the gap (for modern laptops having S0-idle enabled), the PR author suggests to use a "screen off" message as a replacement, which seems to work.

Here are a list of reported issues:

• 'sleep' actually hibernates #10557
• Cannot use keyboard to wake laptop after put it to sleep with PowerToys run "sleep" #16613
• Put computer to sleep #23806
• Sleep mode #23882

[der3318]

For laptops that are still using S1-S3 instead of S0-idle, does the new "monitor power off" message put the device into the correct sleep state? Do we need to branch the actions into 2 cases? For example:

NativeMethods.GetPwrCapabilities(out SystemPowerCapabilities powerCapabilities);
if (powerCapabilities.AoAc) // modern standby is enabled
{
    return ResultHelper.ExecuteCommand(confirmCommands, Resources.Microsoft_plugin_sys_sleep_confirmation, () => Task.Run(() => _ = NativeMethods.SendMessage(HWNDBROADCAST, WMSYSCOMMAND, SCMONITORPOWER, POWEROFF)));
}
return ResultHelper.ExecuteCommand(confirmCommands, Resources.Microsoft_plugin_sys_sleep_confirmation, () => NativeMethods.SetSuspendState(false, true, true));

NativeMethods.cs for GetPwrCapabilities

[DllImport("Powrprof.dll", SetLastError = true)]
public static extern bool GetPwrCapabilities(out SystemPowerCapabilities lpSystemPowerCapabilities);

ref:

• https://learn.microsoft.com/en-us/windows/win32/api/powerbase/nf-powerbase-getpwrcapabilities
• https://learn.microsoft.com/en-us/windows/win32/api/winnt/ns-winnt-system_power_capabilities
• https://github.com/microsoft/PowerToys/blob/main/src/modules/awake/Awake/Core/Models/SystemPowerCapabilities.cs

[donlaci]

Hi @der3318,
Thank you for your comment!
Indeed, I could not test the changes on a system with traditional S1-3 power modes. It is also not clear, where the boundaries are (until which Windows version for example) and whether the change makes the sleep function worse on those systems or not.
I will investigate deeper this topic. Your code suggestion seems to be logical, thank you very much!!

[donlaci]

Hi @der3318
I have tested the code you proposed. Albight it seems logical, it did not work for me, the GetPwrCapabilities function did return false response, AoAc was false on my system, which is faulty. I've experimented with it, but it was always the same.
My conclusion in the current situation is that in this form I cannot extend the code.
I will keep analysing the problem. Just letting you know.
Thanks for the contribution!

[der3318]

Thank you for the effort. Sadly I am not aware of any issue regarding API GetPwrCapabilities and the field AoAc, which has been publicly used since at least XP.

Just to confirm 😊 - is it possible that you are not marshaling the struct SYSTEM_POWER_CAPABILITIES correctly? As I just noticed that MSFT's documentation regarding this struct is inaccurate. If you take a look at the actual winnt.h (e.g., the one under C:\Program Files (x86)\Windows Kits\10\Include\10.0.22621.0\um), it should be:

typedef struct {
...
  BOOLEAN                 ProcessorThrottle;
  BYTE                    ProcessorMinThrottle;
+ #if (NTDDI_VERSION < NTDDI_WINXP)
  BYTE                    ProcessorThrottleScale;
  BYTE                    spare2[4];
+ #else
  BYTE                    ProcessorMaxThrottle;
  BOOLEAN                 FastSystemS4;
  BOOLEAN                 Hiberboot;
  BOOLEAN                 WakeAlarmPresent;
  BOOLEAN                 AoAc;
+ #endif
  BOOLEAN                 DiskSpinDown;
...
} SYSTEM_POWER_CAPABILITIES, *PSYSTEM_POWER_CAPABILITIES;

[donlaci]

Hi @der3318,
Yes indeed, there was a glitch in the marshaling. I've rewritten it and it works. I thank you for your colaboration!!

[jaimecbernardo]

Gave it a test, but it doesn't seem to be working well for me.
When I choose "Sleep" from the start menu, it goes to sleep and then wakes up after I press a keystroke.
When I choose "Sleep" from PowerToys, it goes to sleep but everytime I press a key it seems to try to wake up but then go right to sleep again right away. To wake it up, I have to keep mashing my keyboard to avoid sending it to sleep again. Doesn't seem like this is good behavior.

[crutkas]

@AkazaRenn commented #10557 (comment)

Here seems to be a solution that can be referred to: Open-Shell/Open-Shell-Menu#719

MIT license project too

[jaimecbernardo]

@Jay-o-Way , the solution here when I tested it put my PC on a sleep loop. It's still a WIP.

[Copilot]

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

Files not reviewed (1)

• .github/actions/spell-check/expect.txt: Language not supported

Comments suppressed due to low confidence (1)

src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Components/Commands.cs:107

• The new behavior introduced by SendMessage to initiate Modern Standby mode is not covered by tests. Consider adding tests to validate this behavior.

return ResultHelper.ExecuteCommand(confirmCommands, Resources.Microsoft_plugin_sys_sleep_confirmation, () => Task.Run(() => _ = NativeMethods.SendMessage(HWNDBROADCAST, WMSYSCOMMAND, SCMONITORPOWER, POWEROFF)));

[Copilot]

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

Files not reviewed (1)

• .github/actions/spell-check/expect.txt: Language not supported

Comments suppressed due to low confidence (3)

src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Components/Commands.cs:107

• Ensure that the SendMessage method is covered by tests to validate the new behavior.

return ResultHelper.ExecuteCommand(confirmCommands, Resources.Microsoft_plugin_sys_sleep_confirmation, () => Task.Run(() => _ = NativeMethods.SendMessage(HWNDBROADCAST, WMSYSCOMMAND, SCMONITORPOWER, POWEROFF)));

src/modules/launcher/Wox.Plugin/Common/Win32/NativeMethods.cs:115

• The parameters for SendMessage should be IntPtr or uint to match the Win32 API signature more closely.

public static extern int SendMessage(int hWnd, int hMsg, int wParam, int lParam);

src/modules/launcher/Wox.Plugin/Common/Win32/NativeMethods.cs:700

• [nitpick] The field 'spare3' in SystemPowerCapabilities struct is private and unused. Consider clarifying its purpose or removing it if not needed.

private readonly byte[] spare3;

[jaimecbernardo]

This fix never seemed to work for every case. On my team it worked in some computers but not anothers. It needs further tests / investigation in the future to figure out why it doesn't work for some cases. Putting a Blocked right now but leaving it open for future reference.

[zadjii-msft]

@donlaci do we have any idea what the cause of the behavior mentioned in #28370 (review) is?

Should we be attempting something like Open-Shell/Open-Shell-Menu@db0e768 instead?

(I know that this PR is a few years stale now, but I'd love to get the backlog cleared out here)

[donlaci]

@donlaci do we have any idea what the cause of the behavior mentioned in #28370 (review) is?

Should we be attempting something like Open-Shell/Open-Shell-Menu@db0e768 instead?

(I know that this PR is a few years stale now, but I'd love to get the backlog cleared out here)

@zadjii-msft Yes, the open shell code looks promising. It is definitely worth to try,