Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/curtisalexander/stay-awake-odin
Keep a Windows machine awake
https://github.com/curtisalexander/stay-awake-odin
cli odin win32 windows
Last synced: 15 days ago
JSON representation
Keep a Windows machine awake
- Host: GitHub
- URL: https://github.com/curtisalexander/stay-awake-odin
- Owner: curtisalexander
- License: apache-2.0
- Created: 2024-10-25T15:41:13.000Z (25 days ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:52:25.000Z (21 days ago)
- Last Synced: 2024-10-29T21:19:20.656Z (21 days ago)
- Topics: cli, odin, win32, windows
- Language: Odin
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/curtisalexander/stay-awake-odin/actions/workflows/ci.yml)
# stay-awake-odin
Keep a Windows machine awake
## Get
Executable binaries for Windows may be found at the [Releases](https://github.com/curtisalexander/stay-awake-odin/releases) page.
## Usage
The executable `stay-awake.exe` is intended to be run in a terminal in order to keep one's Windows machine awake.
There are two modes one may choose from:
- **System** [Default] → the machine will not go to sleep but the display could turn off
- **Display** → the machine will not go to sleep and the display will remain on
### System
The simplest use case is to run the executable without any switches.
```pwsh
stay-awake.exe
```
This will prevent the machine from going to sleep and will await the user pressing the `Enter` key within the terminal before resetting the machine state.
### Display
To keep the machine awake and prevent the display from turning off, utilize the `-display` switch.
```pwsh
stay-awake.exe -display
```
This will prevent the machine from going to sleep (while also keeping the display on) and will await the user pressing the `Enter` key within the terminal before resetting the machine state.
> :memo: As noted in the [Win32 documentation](https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setthreadexecutionstate), use of the `SetThreadExecutionState` function (which is the Win32 function called by `stay-awake.exe`) does **_not_** prevent one from putting their computer to sleep by either closing the lid on their laptop or pressing the power button. In addition, the screen saver may still execute.
### Help
Result of running `stay-awake.exe -help`
```
Usage:
stay-awake.exe [-display]
Flags:
-display | Keep display on
```
## Testing
In order to test, open PowerShell with elevated (admin) privileges. After executing the program, run the following.
```pwsh
powercfg -requests
```
## Compile
First, ensure [Odin](https://odin-lang.org/) has been [installed](https://odin-lang.org/docs/install/) and is available on one's [`PATH`](https://duckduckgo.com/?q=add+to+path+windows&ia=web). Clone this repository and then run the [build.bat](build.bat) file.
```
git clone https://github.com/curtisalexander/stay-awake-odin.git
cd stay-awake-odin
.\build.bat
```
The resulting executable will be `stay-awake.exe`.
## GitHub Actions
Below is the rough `git tag` dance to delete and/or add tags to [trigger GitHub Actions](https://github.com/curtisalexander/stay-awake-odin/blob/main/.github/workflows/ci.yml#L7-L10).
```sh
# delete local tag
git tag --delete v0.1.0
# delete remote tag
git push origin --delete v0.1.0
# add and commit local changes
git add .
git commit -m "commit msg"
# push local changes to remote
git push
# add local tag
git tag -a v0.1.0 -m "v0.1.0"
# push local tag to remote
git push origin --tags
```
## Win32 Docs
Application utilizes [SetThreadExecutionState](https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setthreadexecutionstate) from the [Win32 API](https://docs.microsoft.com/en-us/windows/win32/).
## Prior Implementations
- [`C#`](https://github.com/curtisalexander/stay-awake-cs)
- [`PowerShell`](https://github.com/curtisalexander/stay-awake-ps)
- [`Rust`](https://github.com/curtisalexander/stay-awake-rs)
- Loads `kernel32.dll` and performs a [transmute](https://doc.rust-lang.org/stable/std/mem/fn.transmute.html) to get the function [SetThreadExecutionState](https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setthreadexecutionstate)
- [`Rust`](https://github.com/curtisalexander/stay-awake2)
- Makes use of the [windows](https://crates.io/crates/windows) crate rather than [transmute](https://doc.rust-lang.org/stable/std/mem/fn.transmute.html) as is done in [stay-awake-rs](https://github.com/curtisalexander/stay-awake-rs)
## Alternate Tools
- [Microsoft PowerToys](https://docs.microsoft.com/en-us/windows/powertoys/) includes the [Awake](https://docs.microsoft.com/en-us/windows/powertoys/awake) utility
- It also utilizes [SetThreadExectionState](https://github.com/microsoft/PowerToys/blob/main/src/modules/awake/Awake/Core/Manager.cs#L108) to keep a Windows machine awake