screen-brightness-control 0.3.1

A Python tool to control monitor brightness on Windows and Linux

screen_brightness_control

A Python tool for controlling the brightness of your monitor. Supports Windows and most flavours of Linux.

Installation

Pip:

• Open a terminal and run pip3 install screen-brightness-control

Github:

• Clone/download the repository by running git clone https://github.com/Crozzers/screen_brightness_control
• Enter the folder it was cloned into with cd screen_brightness_control
• Install using pip3 install .

Note:

This library relies on the Light repo to function on Linux. If you have not already got that installed then you will need to follow these steps to install it.

Usage

You can call this module from your command line or use it as a python library (see the documentation section below).

python -m screen_brightness_control --help
> usage: __main__.py [-h] [-s SET] [-g] [-f FADE]
> 
> optional arguments:
>   -h, --help            show this help message and exit
>   -s SET, --set SET     set the brightness to this value
>   -g, --get             get the current screen brightness
>   -f FADE, --fade FADE  fade the brightness to this value
python -m screen_brightness_control -g
> 100
python -m screen_brightness_control -s 50

Documentation

ScreenBrightnessError(Exception)

Summary:

Raised by set_brightness and get_brightness when the brightness cannot be set or retrieved
Used as a unifying class for the multiple error types to make it easier to handle exceptions

get_brightness(max_value=False, verbose_error=False, **kwargs)

Summary:

Returns the current screen brightness as a percentage by default. If you're on Windows it may return a list of values if you have multiple, brightness adjustable monitors.
Raises ScreenBrightnessError upon failure

Arguments:

• max_value - deprecated kwarg. Always returns 100
• verbose_error - a boolean value to control how much detail any error messages should contain
• kwargs - absorbs older, removed kwargs without raising an error

Usage:

import screen_brightness_control as sbc
try:
    current_brightness = sbc.get_brightness()
except ScreenBrightnessError as err:
    print(err)

set_brightness(brightness_level, force=False, verbose_error=False, **kwargs)

Summary:

Sets the brightness to brightness_level. If brightness_level is a string and contains "+" or "-" then that value is added to/subtracted from the current brightness. Raises ScreenBrightnessError upon failure

Arguments:

• brightness_level - the level to set the brightness to. Can either be an integer or a string.
• force (Linux only) - if set to False then the brightness is never set to less than 1 because on Linux this often turns the screen off. If set to True then it will bypass this check
• verbose_error - a boolean value to control how much detail any error messages should contain
• kwargs - absorbs older, removed kwargs without raising an error

Usage:

import screen_brightness_control as sbc

#set brightness to 50%
sbc.set_brightness(50)

#set brightness to 0%
sbc.set_brightness(0, force=True)

#increase brightness by 25%
sbc.set_brightness('+25')

#decrease brightness by 30%
sbc.set_brightness('-30')

fade_brightness(finish, start=None, interval=0.01, increment=1, blocking=True, verbose_error=False)

Summary:

Fades the brightness from start to finish in steps of increment, pausing for interval seconds between each step. If it runs in the main thread it will return the final brightness upon success, ScreenBrightnessError upon failure. Otherwise it returns the thread object that the process is running in

Arguments:

• finish - The brightness value to fade to
• start - The value to start from. If not specified it defaults to the current brightness
• interval - The time interval between each step in brightness
• increment - The amount to change the brightness by each step in percent.
• blocking - If set to False it fades the brightness in a new thread
• verbose_error - Controls the amount of detail any error messages will contain

Usage:

import screen_brightness_control as sbc

#fade brightness from the current brightness to 50%
sbc.fade_brightness(50)

#fade the brightness from 25% to 75%
sbc.fade_brightness(75, start=25)

#fade the brightness from the current value to 100% in steps of 10%
sbc.fade_brightness(100, increment=10)

#fade the brightness from 100% to 90% with time intervals of 0.1 seconds
sbc.fade_brightness(90, start=100, interval=0.1)

#fade the brightness to 100% in a new thread
sbc.fade_brightness(100, blocking=False)

License

This software is licensed under the MIT license

FAQ

Why do I always get ScreenBrightnessError on Linux?

Why this happens:

The way brightness is adjusted on Linux is the program tries to run shell commands to adjust the brightness. The programs it attempts to call are "light" and "xbacklight". If neither of these programs can be called a ScreenBrightnessError is raised

How to fix it:

Install light (recommended) or xbacklight using your system package manager:

• Arch: sudo pacman -S light-git or sudo pacman -S xorg-xbacklight
• Debian/Ubuntu: Light install instructions or sudo apt install xbacklight
• Fedora: sudo dnf install light or sudo dnf install xbacklight

I call set_brightness() and nothing happens on Linux

Why this happens:

Light requires root access to run, which is usually provided when you manually install it using you package manager.

How to fix it:

Install Light by following these steps. Make sure to run the install as sudo

When I call get_brightness() the returned value isn't what I set it to (Windows)

Not all monitors can set the brightness for every value between 0 and 100. Most of them have a number of 'levels' that they can set them to. You can likely see this if you open your display settings and very slowly move the brightness slider.
You can find out your brightness 'levels' by running the following python code:

import wmi
monitor = wmi.WMI(namespace='wmi').MonitorBrightness[0]
#the number of levels the monitor can be set to
print(monitor.Levels)
#the actual brightness values your monitor can be set to
print(monitor.Level)

Things to note:

• If you encounter any issues or bugs with this software please do not hesitate to raise an issue.
• It is unlikely that this project will support MAC in the forseeable future for 3 reasons.
  1. I do not own a (working) MAC.
  2. I do not intend to buy a MAC
  3. From what I have found it is even less straight-forward to adjust the screen brightness from python on MAC
• If you own a MAC an you happen to know how to adjust the brightness in python then feel free to contribute