https://github.com/luckman212/display-is-sleeping
Utility to report display sleep/wake status on macOS
https://github.com/luckman212/display-is-sleeping
displays macos shell-scripting sleep
Last synced: 24 days ago
JSON representation
Utility to report display sleep/wake status on macOS
- Host: GitHub
- URL: https://github.com/luckman212/display-is-sleeping
- Owner: luckman212
- Created: 2023-11-12T00:46:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-12T02:09:15.000Z (over 2 years ago)
- Last Synced: 2026-04-06T12:31:12.705Z (2 months ago)
- Topics: displays, macos, shell-scripting, sleep
- Language: Objective-C
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# display-is-sleeping
This is a small Objective-C program that will report the current sleeping/awake status of the attached displays. It makes use of the **NSWorkspace** [`ScreensDidSleep`][1] and [`ScreensDidWake`][2] Notifications, and uses a small LaunchAgent to subscribe to those events and keep the status current.
The program can be called on its own without arguments and will simply return a POSIX exit code of 0 (sleeping) or 1 (awake) to indicate the screen's status. So you can run something like:
```bash
if ! display-is-sleeping ; then echo "screen is awake!"; fi
```
or more concisely
```bash
display-is-sleeping || echo "screen is awake!"
```
### Installation (and Uninstallation)
Clone this repo (if you don't know how to do that, click the green **Code** button above, then **Download ZIP**). Once you have the bits on your disk, open a Terminal in the directory that contains the cloned files and run the command below:
```bash
./setup.sh --install
```
This will copy the binary to `/usr/local/bin` (you can use a different directory if you like, by editing the setup script and changing the `BINDIR` variable at the top). It also creates and starts up the LaunchAgent. From then on, you can use the `display-is-sleeping` command in your scripts.
To **Uninstall**, simply re-run the script, passing `--uninstall`:
```bash
./setup.sh --uninstall
```
This will unload and remove the LaunchAgent, stop any background processes and remove the command itself from wherever it was installed.
### Usage
Example use in a script
```bash
if display-is-sleeping ; then
# ...put code here to run if the screen is dark
else
# ...code to run if the screen is awake
fi
```
Get current status as a string (prints `true` or `false`)
```bash
display-is-sleeping --status
```
Please report any bugs or issues you encounter. This idea was inspired by [this AskDifferent post](https://apple.stackexchange.com/questions/466236/check-if-display-sleep-on-apple-silicon-in-bash).
[1]: https://developer.apple.com/documentation/appkit/nsworkspacescreensdidsleepnotification
[2]: https://developer.apple.com/documentation/appkit/nsworkspacescreensdidwakenotification