Lunar Documentation

repository·master·Indexed 25 days ago

A macOS application for advanced control of external and built-in monitors via DDC/CI protocol. Features include adaptive brightness (sensor, sync, and location-based), input management, screen orientation control, and 'BlackOut' mode. Includes the ddcctl CLI tool for managing brightness, contrast, volume, and input sources, as well as a comprehensive Lunar CLI for remote control, EDID reading, and low-level CoreDisplay and DisplayServices method access.

Tokens: 19K
Snippets: 35
Records: 288
Agent score: 91%

What's inside Lunar

Overview of Lunar Features
master
Lunar provides advanced control over external and built-in displays using the DDC protocol to change hardware brightness directly. Key features include:
- Adaptive Brightness: Supports sensor-based (external sensor), sync-based (MacBook/iMac built-in sensor), and location-based (sunrise/sunset) adjustments.
- Brightness Control: Supports 1000-to-1600 nits for XDR/HDR displays and "Subzero" dimming (below 0%) for low-light environments.
- Input Management: Switch monitor inputs via dropdown or up to 3 input-specific hotkeys.
- Screen Orientation: Change orientation via the menu bar or hotkeys (Ctrl+0/9/8/7 mapped to 0°/90°/180°/270° for the display with the cursor on it).
- App Presets: Configure specific brightness levels for different activities (e.g., design work, movies).
- BlackOut: Selectively turn off monitors while maintaining USB-C charging, monitor audio, USB hub functionality, and built-in keyboard/trackpad access.
- Hidden Resolutions: Access additional resolutions via the Display Settings menu.
https://github.com/alin23/lunar/blob/master/README.md
Use ESP8266 sensor boards with Lunar
master
Lunar now supports ESP8266 sensor boards. Additionally, for light sensors, the system implements auto-gain and adaptive integration time to improve sensor performance.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/4.7.0.md
Monitor brightness and contrast lock status
master
The UI now indicates when brightness or contrast is locked. Additionally, the software ensures brightness does not remain locked when using non-DDC controls.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/5.6.7.md
DDC support for M2 Pro/Max
master
Lunar v5.9.5 and later supports DDC (Display Data Channel) for both Thunderbolt/DP and HDMI connections on Apple M2 Pro and M2 Max chips.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/5.9.5.md
Improve contrast on Apple displays
master
Lunar 5.6.4a4 includes improved sensible defaults for contrast settings specifically optimized for Apple displays to ensure better visual clarity out of the box.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/5.6.4a4.md
Use macOS Shortcuts to control Lunar
master
Lunar supports macOS Shortcuts, allowing you to automate screen controls and display configurations. You can use Shortcuts to:
- Control brightness and volume of a screen.
- Change Lunar adaptive modes and apply global presets.
- Exclusive Shortcut Actions:
  Swap monitors.
  Mirror any combination of screens.
  Arrange screens in various layouts.
  Change resolution and frame rate.
  Change presets (e.g., Design & Print or Photography) using hotkeys.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/5.9.0.md
Plan for Lunar v7 migration
master
Lunar v7 is a complete rewrite of the brightness control engine and UI. Note the following upcoming changes for the v7 release (expected September-October):
- Minimum OS: Support for macOS versions older than 14.0 will be dropped.
- Architecture: Support for Intel-based Macs will be dropped.
If your workflow relies on Intel Macs or older macOS versions, you should plan your migration strategy accordingly.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/6.11.0.md
Stream logs in real time for troubleshooting
master
Lunar now supports real-time log streaming, allowing developers to monitor logs as they occur to facilitate more efficient troubleshooting of the application and its interactions with display hardware.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/5.1.2.md
Install Lunar CLI from the command line
master
You can install the Lunar CLI directly from the Lunar application binary using the following command:
```
/Applications/Lunar.app/Contents/MacOS/Lunar install-cli
```
https://github.com/alin23/lunar/blob/master/ReleaseNotes/5.4.0.md
Use Clock Mode to schedule brightness and contrast
master
Lunar's Clock Mode allows you to schedule brightness and contrast presets based on specific times or astronomical events such as sunset, sunrise, or noon.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/4.9.5.md
Use Auto BlackOut OSD
master
When using the Auto BlackOut feature, an On-Screen Display (OSD) will appear to allow the system to settle screen configuration. You can press the esc key to cancel the Auto BlackOut process.
https://github.com/alin23/lunar/blob/master/ReleaseNotes/5.6.0.md
Integrate Lunar with MediaMate
master
Lunar supports integration with MediaMate. You can use the lunar listen CLI command to receive real-time updates for brightness, contrast, and volume changes.
```
lunar listen
```
https://github.com/alin23/lunar/blob/master/ReleaseNotes/6.1.3.md