jimmac/Luminance

Luminance

A simple GTK application to control brightness of displays including external displays supporting DDC/CI

Install from AUR (Arch Linux):

yay -S luminance

Install deb package (Debian and Ubuntu based distros):

Latest deb release is available on the releases page https://github.com/sidevesh/Luminance/releases

Install rpm package (Fedora, OpenSUSE and other rpm based distros):

Latest rpm release is available on the releases page https://github.com/sidevesh/Luminance/releases

Install from source

Dependencies

ddcutil library package (typically libddcutil or libddcutil-dev if not already installed with ddcutil)
GTK 3.0

Steps

Firstly, ensure that all the dependencies are installed:

Arch Linux:

pacman -S --needed ddcutil gtk3

Ubuntu-based distros (credit @aidengilmartin):

sudo apt install libgtk3-dev gcc
sudo add-apt-repository ppa:rockowitz/ddcutil # add ddcutil repo
sudo apt install ddcutil libddcutil-dev

Fedora:

sudo dnf install ddcutil libddcutil libddcutil-devel gtk3-devel gcc

Ensure that your user has access to the i2c devices: https://www.ddcutil.com/i2c_permissions/

Clone this repo along with its submodules:

git clone --recurse-submodules https://github.com/sidevesh/Luminance.git

Change into the Luminance directory and execute build.sh to build this application:
```
cd Luminance
./build.sh
```
This should result in a binary that you can execute to contol the brightness:
```
./build/app
```
To install this binary for all users execute 'install.sh' as root:
```
sudo ./install.sh
```
You should now be able to find Luminance in your list of apps
- Installing the application is necessary for it to work because this using gsettings to store preferences and will need the schema files to be installed. You can read the install.sh script and copy the schema files yourself if you don't want to do all the install steps.

Usage

Start the application normally or you can also use the app via cli interface:

Usage: com.sidevesh.Luminance [OPTIONS]
An application to control brightness of displays including external displays supporting DDC/CI

Options:
  -l, --list-displays                         List displays and their brightness
  -g, --get-percentage [DISPLAY NUMBER]       Get the brightness percentage of a display
  -s, --set-brightness [DISPLAY NUMBER]       Set the brightness of a display to a percentage value
  -i, --increase-brightness [DISPLAY NUMBER]  Increase the brightness of a display by a percentage value
  -d, --decrease-brightness [DISPLAY NUMBER]  Decrease the brightness of a display by a percentage value
                                              If DISPLAY NUMBER is not provided, for --set-brightness, --increase-brightness and --decrease-brightness options, the brightness of all displays will be changed
  -p  --percentage [PERCENTAGE]               Percentage value to set the brightness to in case of --set-brightness option or to increase or decrease the brightness by in case of --increase-brightness or --decrease-brightness option
  -o, --show-osd                              Show OSD popup when brightness is changed for specified environment:
                                                g: GNOME, experimental, only works with https://extensions.gnome.org/extension/5952/eval-gjs/ extension installed
  -h, --help                                  Show help information

When no arguments are provided, the application starts in GUI mode.

Note for AUR publishers

Switch the arch submodule push url to the ssh url before pushing to AUR for the first time:

cd arch
git remote set-url --push origin ssh://aur@aur.archlinux.org/luminance.git

License

Distributed under the GNU General Public License v3.0. See LICENSE.txt for more information.

Contact

Swapnil Devesh - @sid_devesh - me@sidevesh.com

Project Link: https://github.com/sidevesh/Luminance

Acknowledgments

@ahshabbir : for ddcbc-api and ddcbc-gtk: https://github.com/ahshabbir/ddcbc-api
@rockowitz : for ddcutil c api: https://github.com/rockowitz/ddcutil

jimmac / Luminance