imac_idle.md

iMac Idle Script for Ubuntu

This script is optional when you whish to have your backlight turn of after 60 seconds of idle time and it is only working together with the script documented in the Readme.md. The screen turns back on on keystroke.

Script: imac_idle.py

import os
import time
from pynput import mouse, keyboard
import subprocess
import logging

# Configure logging
logging.basicConfig(
    #level=logging.DEBUG,
    level=logging.OFF,
    format='%(asctime)s - %(levelname)s - %(message)s'
)

# Adjustable idle timeout (in seconds)
IDLE_TIMEOUT = 60


last_activity_time = time.time()

def reset_timer(*args):
    """Reset the idle timer on any activity."""
    global last_activity_time
    last_activity_time = time.time()
    logging.debug(f"Activity detected - Timer reset at {last_activity_time}")

def check_idle_time():
    """Monitor idle time and adjust brightness."""
    global last_activity_time
    logging.info("Starting idle time monitoring")
    while True:
        idle_time = time.time() - last_activity_time
        logging.debug(f"Current idle time: {idle_time:.2f} seconds")
        
        if idle_time > IDLE_TIMEOUT:
            logging.info(f"Idle timeout ({IDLE_TIMEOUT}s) reached. Turning off display...")
            try:
                result = subprocess.run(
                    ["/usr/local/bin/imacdisplay.py", "-s", "0", "-z"],
                    capture_output=True,
                    text=True
                )
                logging.debug(f"Display off command result: {result.returncode}")
                if result.stderr:
                    logging.error(f"Error turning off display: {result.stderr}")
            except Exception as e:
                logging.error(f"Failed to execute display off command: {str(e)}")

            while idle_time > IDLE_TIMEOUT:
                idle_time = time.time() - last_activity_time
                logging.debug(f"Waiting for activity... Current idle time: {idle_time:.2f}")
                time.sleep(1)  # Wait until user activity is detected

            logging.info("Activity detected after idle. Restoring brightness...")
            try:
                result = subprocess.run(
                    ["/usr/local/bin/imacdisplay.py", "-s", "50"],
                    capture_output=True,
                    text=True
                )
                logging.debug(f"Restore brightness command result: {result.returncode}")
                if result.stderr:
                    logging.error(f"Error restoring brightness: {result.stderr}")
            except Exception as e:
                logging.error(f"Failed to execute restore brightness command: {str(e)}")
        
        time.sleep(1)

# Start mouse and keyboard listeners
mouse_listener = mouse.Listener(
    #on_move=reset_timer, on_click=reset_timer, on_scroll=reset_timer
)
keyboard_listener = keyboard.Listener(on_press=reset_timer)

mouse_listener.start()
keyboard_listener.start()

# Run idle time checker
check_idle_time()

Installation Requirements

1. Install Python and pynput

Ensure Python is installed:

sudo apt update
sudo apt install python3 python3-pip

Install the required pynput library:

pip3 install pynput --user

2. Adjust imacdisplay.py Minimum Brightness

Edit your existing /usr/local/bin/imacdisplay.py script to allow a minimum brightness of 0. Locate the line in the script that enforces the minimum brightness (e.g., min_brightness = 5) and change it to:

min_brightness = 0

Save the changes.

3. Save the Script

Save the above imac_idle.py script to a suitable location, e.g., /usr/local/bin/imac_idle.py. Ensure it is executable:

sudo chmod +x /usr/local/bin/imac_idle.py

Automating Script at Startup

Option 1: Systemd Service (Recommended)

1. Create a Systemd Service File

   sudo nano /etc/systemd/system/imac_idle.service

   Add the following content:

   [Unit]
   Description=iMac Idle Backlight Script
   After=multi-user.target
   
   [Service]
   ExecStart=/usr/bin/python3 /usr/local/bin/imac_idle.py
   Restart=always
   User=your-username
   
   [Install]
   WantedBy=multi-user.target

   Replace your-username with your Ubuntu username.

2. Enable and Start the Service

   sudo systemctl daemon-reload
   sudo systemctl enable imac_idle.service
   sudo systemctl start imac_idle.service

3. Check Service Status Verify that the service is running:

   sudo systemctl status imac_idle.service

Option 2: Add to Startup Applications (GUI)

1. Open the Startup Applications tool:

   gnome-session-properties

   If unavailable, install it:

   sudo apt install gnome-startup-applications

2. Click Add and configure:

   • Name: iMac Idle Script
   • Command: python3 /usr/local/bin/imac_idle.py
   • Comment: (Optional) A brief description.

3. Save and close the tool.

Testing the Script

Run the script manually to ensure it works as expected:

python3 /usr/local/bin/imac_idle.py

Notes

• Make sure the imacdisplay.py script works as intended with the adjusted brightness levels.
• Test the idle timeout and brightness restoration functionality to verify proper operation.