PyMonCtl 0.1.0

Cross-Platform toolkit to get info on and control monitors connected

PyMonCtl

Cross-Platform module which provides a set of features to get info on and control monitors.

External tools/extensions/APIs used:

• Linux:
  • Xlib's randr extension
  • xrandr command-line tool
  • xset command-line tool
• Windows:
  • VCP MCCS API interface
• macOS:
  • pmset command-line tool

My most sincere thanks and appreciation to the University of Utah Student Computing Labs for their awesome work on the display_manager_lib module, for sharing it so generously, and most especially for allowing to be integrated into PyMonCtl

General Functions

Functions to get monitor instances, get info and manage monitors plugged to the system.

General features:
getAllMonitors
getAllMonitorsDict
getMonitorsCount
getPrimary
findMonitor
findMonitorInfo
arrangeMonitors
getMousePos

Monitor Class

Class to access all methods and functions to get info and control a given monitor plugged to the system.

This class is not meant to be directly instantiated. Instead, use convenience functions like getAllMonitors(), getPrimary() or findMonitor(x, y).

To instantiate it, you need to pass the monitor handle (OS-dependent). It can raise ValueError exception in case the provided handle is not valid.

	Windows	Linux	macOS
size	X	X	X
workarea	X	X	X
position	X	X	X
setPosition	X	X	X
box	X	X	X
rect	X	X	X
scale	X	X	X
setScale	X	X	X
dpi	X	X	X
orientation	X	X	X
setOrientation	X	X	X (1)
frequency	X	X	X
colordepth	X	X	X
brightness	X (2)	X	X (1)
setBrightness	X (2)	X	X (1)
contrast	X (2)	X (3)	X (3)
setContrast	X (2)	X (3)	X (3)
mode	X	X	X
setMode	X	X	X
defaultMode	X	X	X
setDefaultMode	X	X	X
allModes	X	X	X
isPrimary	X	X	X
setPrimary	X	X	X
turnOn	X	X
turnOff	X (4)	X
suspend	X (4)	X (5)	X (5)
isOn	X	X	X
attach	X	X
detach	X	X
isAttached	X	X	X

(1) Thru display_manager_lib from University of Utah - Marriott Library - Apple Infrastructure (thank you, guys!).

(2) If monitor has no VCP MCCS support, these methods won't likely work.

(3) It doesn't exactly returns / changes contrast, but gamma values.

(4) If monitor has no VCP MCCS support, it can not be addressed separately, so ALL monitors will be turned off / suspended. To address a specific monitor, try using turnOff() / turnOn() / detach() / attach() methods.

(5) It will suspend ALL monitors.

WARNING: Most of these properties may return ''None'' in case the value can not be obtained

Keep Monitors info updated

These features include a watchdog, running in a separate Thread, which will allow you to keep monitors information updated and define hooks and its callbacks to be notified when monitors are plugged/unplugged or their properties change.

watchdog methods:
enableUpdate
disableUpdate
isUpdateEnabled
updateInterval

Notice this is a module-level information, completely independent (though related to and used by) window objects. Also notice that the information provided by getMonitors() method will be static unless the watchdog is enabled, or invoked with forceUpdate=True.

Enable this only if you need to keep track of monitor-related events like changing its resolution, position, or if monitors can be dynamically plugged or unplugged in a multi-monitor setup. If you need monitors info updated at a given moment, but not continuously updated, just invoke getMonitors(True/False) at your convenience.

If enabled, it will activate a separate thread which will periodically update the list of monitors and their properties (see getMonitors() function).

If disabled, the information on the monitors connected to the system will be static as it was when PyMonCtl module was initially loaded (changes produced afterwards will not be returned by getMonitors()).

By default, the monitors info will be checked (and updated) every 0.3 seconds. Adjust this value to your needs, but take into account higher values will take longer to detect and notify changes; whilst lower values will consume more CPU.

Get notifications on Monitors changes

When enabling the watchdog using enableUpdate(), it is possible to define callbacks to be invoked in case the number of connected monitors or their properties change. The information passed to the callbacks is:

• Names of the monitors which have changed (as a list of strings)
• All monitors info, as returned by getMonitors()

To access monitors properties, use monitor name as dictionary key

monitorCountChange: callback to invoke when a monitor is plugged or unplugged
                    Passes the list of monitors that produced the event and the info on all monitors (see getMonitors())

monitorPropsChange: callback to invoke if a monitor changes its properties (e.g. position or resolution)
                    Passes the list of monitors that produced the event and the info on all monitors (see getMonitors())

Example:

import pymonctl as pmc
import time

def countChanged(names, screensInfo):
    print("MONITOR PLUGGED/UNPLUGGED:", names)
    for name in names:
        print("MONITORS INFO:", screensInfo[name])

def propsChanged(names, screensInfo):
    print("MONITOR CHANGED:", names)
    for name in names:
        print("MONITORS INFO:", screensInfo[name])

pmc.enableUpdate(monitorCountChanged=countChanged, monitorPropsChanged=propsChanged)
print("Plug/Unplug monitors, or change monitor properties while running")
print("Press Ctl-C to Quit")
while True:
    try:
        time.sleep(1)
    except KeyboardInterrupt:
        break
pmc.disableUpdate()

INSTALL

To install this module on your system, you can use pip:

pip install pymonctl

or

python3 -m pip install pymonctl

Alternatively, you can download the wheel file (.whl) available in the Download page and the dist folder, and run this (don't forget to replace 'x.x.xx' with proper version number):

pip install PyMonCtl-x.x.xx-py3-none-any.whl

You may want to add --force-reinstall option to be sure you are installing the right dependencies version.

Then, you can use it on your own projects just importing it:

import pymonctl

SUPPORT

In case you have a problem, comments or suggestions, do not hesitate to open issues on the project homepage

USING THIS CODE

If you want to use this code or contribute, you can either:

• Create a fork of the repository, or
• Download the repository, uncompress, and open it on your IDE of choice (e.g. PyCharm)

Be sure you install all dependencies described on docs/requirements.txt by using pip

python3 -m pip install -r requirements.txt

TEST

To test this module on your own system, cd to tests folder and run:

python3 test_pymonctl.py