Klipper Auto Power Off

A Klipper module that automatically powers off your 3D printer after a completed print, once it has cooled down and remained idle for a specified period of time.

Features

• Automatically shut down your printer after completed prints
• Configurable idle timeout (default: 10 minutes)
• Configurable temperature threshold (default: 40°C)
• Integration with both Fluidd and Mainsail for easy control via UI
• Status monitoring for hotend and bed temperatures
• Manual control with GCODE commands
• Works with any GPIO-controlled power device
• Available in English and French
• Compatible with all Moonraker power device types (GPIO, TP-Link Smartplug, Tasmota, Shelly, etc.)
• Web interface focused: LCD menus have been removed for simplicity

Documentation

For a better understanding of how Auto Power Off works internally, check out the sequence diagrams that illustrate the various shutdown processes and component interactions.

Requirements

• Klipper with a properly configured power GPIO control
• Fluidd or Mainsail (for UI integration)
• A 3D printer with a power control setup

Support Development

If you find this module useful, consider buying me a coffee to support further development!

Your support is greatly appreciated and helps keep this project maintained and improved!

Available Commands

The module provides the following GCODE commands:

• AUTO_POWEROFF ON - Globally enable the function
• AUTO_POWEROFF OFF - Globally disable the function
• AUTO_POWEROFF START - Manually start the timer
• AUTO_POWEROFF CANCEL - Cancel the current timer
• AUTO_POWEROFF NOW - Immediately power off the printer
• AUTO_POWEROFF STATUS - Display detailed status
• AUTO_POWEROFF DIAGNOSTIC VALUE=1 - Enable diagnostic mode (0 to disable)
• AUTO_POWEROFF RESET - Force reset of the module's internal state
• AUTO_POWEROFF DRYRUN VALUE=1 - Enable dry run mode (0 to disable)

Key Features

The module offers several advanced features:

• Intelligent Power Management: Powers off only when temperatures are safe and printer is idle
• Multi-UI Integration: Full integration with both Fluidd and Mainsail interfaces
• Network Device Support: Works with various network-connected power devices
• Diagnostics & Troubleshooting: Diagnostic mode for detailed logs and operation tracing
• Moonraker Integration: Leverages Moonraker's power control API for better compatibility
• Type-Safe Implementation: Robust error handling with structured exception hierarchy
• Multilingual Support: Full English and French language support
• Seamless Updates: Integrates with Moonraker's update manager for easy updates

For a detailed list of changes between versions, please refer to the CHANGELOG.md file.

Installation

Automatic Installation (Recommended)

1. Download the installation script:

   wget -O install.sh https://raw.githubusercontent.com/JayceeB1/klipper-auto-power-off/main/scripts/install.sh

2. Make it executable:

   chmod +x install.sh

3. Run the script:

   # Run with default language (English)
   ./install.sh
   
   # Or specify a language
   ./install.sh --en  # English
   ./install.sh --fr  # French

4. Follow the on-screen instructions.

Manual Installation

1. Copy the auto_power_off.py script to your Klipper extras directory:

   cp src/auto_power_off.py ~/klipper/klippy/extras/

2. Copy the UI panel files based on your interface:

   For Fluidd:

   mkdir -p ~/printer_data/config/fluidd/
   # English version
   cp ui/fluidd/auto_power_off.cfg ~/printer_data/config/fluidd/
   # French version
   cp ui/fluidd/auto_power_off_fr.cfg ~/printer_data/config/fluidd/auto_power_off.cfg

   For Mainsail:

   mkdir -p ~/printer_data/config/mainsail/
   # English version
   cp ui/mainsail/auto_power_off.cfg ~/printer_data/config/mainsail/
   cp ui/mainsail/auto_power_off_panel.cfg ~/printer_data/config/mainsail/
   # French version
   cp ui/mainsail/auto_power_off_fr.cfg ~/printer_data/config/mainsail/
   cp ui/mainsail/auto_power_off_panel_fr.cfg ~/printer_data/config/mainsail/

3. Add the following to your printer.cfg file:

   [auto_power_off]
   idle_timeout: 600     # Idle time in seconds before power off (10 minutes)
   temp_threshold: 40    # Temperature threshold in °C (printer considered cool)
   power_device: psu_control  # Name of your power device (must match the [power] section)
   auto_poweroff_enabled: True  # Enable auto power off by default at startup
   
   # For Fluidd:
   [include fluidd/auto_power_off.cfg]
   
   # For Mainsail:
   [include mainsail/auto_power_off.cfg]
   

4. Add the following to your moonraker.conffile:

   [update_manager auto_power_off]
   type: git_repo
   path: ~/auto_power_off
   origin: https://github.com/JayceeB1/Klipper-Auto-Power-Off.git
   primary_branch: main
   install_script: scripts/install.sh
   

5. Restart Klipper:

   sudo systemctl restart klipper

Auto-Update with Moonraker

Auto Power Off now supports automatic updates through Moonraker's update manager system. This allows you to update the module directly from the Fluidd or Mainsail interface, just like other components of your 3D printer firmware.

Automatic Setup During Installation

When running the installation script, you'll be prompted to add the update manager configuration to your moonraker.conf file. This setup:

1. Creates a local Git repository for the module files
2. Adds the update manager configuration to moonraker.conf
3. Configures the repository to track updates from the main project

Troubleshooting Update Manager Issues

If you encounter issues with the auto-update functionality showing errors like "Failed to detect repo url" or "Invalid path", follow these steps:

1. Run the installation script again:

   wget -O install.sh https://raw.githubusercontent.com/JayceeB1/klipper-auto-power-off/main/scripts/install.sh
   chmod +x install.sh
   ./install.sh

2. Choose "y" when asked about adding update manager configuration

3. The improved script will clean up old configurations and properly set up the git repository

Manual Setup for Existing Installations

If you have an existing installation and want to add update manager support:

1. Run the installation script again:

   wget -O install.sh https://raw.githubusercontent.com/JayceeB1/klipper-auto-power-off/main/scripts/install.sh
   chmod +x install.sh
   ./install.sh

2. Choose "y" when asked about adding update manager configuration

3. You can specify a custom path for the local repository if needed

Update Manager Configuration

The following configuration (or similar) will be added to your moonraker.conf:

[update_manager auto_power_off]
type: git_repo
path: ~/auto_power_off    # This path may vary according to your installation
origin: https://github.com/JayceeB1/Klipper-Auto-Power-Off.git
primary_branch: main
install_script: scripts/install.sh

Note: The installation script will detect or prompt you for the appropriate path for your system. The path may vary based on your user account and preferences (e.g., /home/username/auto_power_off). The script will ensure the correct path is used in your configuration.

Updating via Fluidd/Mainsail

Once configured, you can update Auto Power Off directly from the Fluidd or Mainsail interface:

1. Go to the "Machine" or "System" tab
2. Look for "Auto Power Off" in the update section
3. Click "Update" when a new version is available

Updates will be applied automatically and Klipper will be restarted to load the updated module.

Configuration

The following parameters can be configured in the [auto_power_off] section:

Parameter	Default	Description
idle_timeout	600	Time in seconds to wait before powering off (after print completed)
temp_threshold	40	Temperature in °C below which it's safe to power off. By default, monitors both the hotend and heated bed, and uses the highest temperature for comparison
monitor_hotend	True	Monitor hotend temperature for power off
monitor_bed	True	Monitor heated bed temperature for power off
monitor_chamber	False	Monitor chamber temperature for power off (if available)
power_device	psu_control	Name of your power device (must match the [power] section)
auto_poweroff_enabled	False	Enable auto power off by default at startup
language	auto	Language for messages: 'en' for English, 'fr' for French, 'auto' for auto-detection
moonraker_integration	True	Enable integration with Moonraker's power control
moonraker_url	http://localhost:7125	URL for Moonraker API
diagnostic_mode	False	Enable detailed logging for troubleshooting power off issues
power_off_retries	3	Number of retry attempts when using Moonraker API
power_off_retry_delay	2	Delay in seconds between retry attempts
dry_run_mode	False	Simulate power off without actually powering off the printer (for testing)
network_device	False	Indicate if the power device is on the network
device_address	None	IP address or hostname of the network device
network_test_attempts	3	Number of attempts to test network device connectivity
network_test_interval	1.0	Interval in seconds between network connectivity test attempts

Uninstallation

To completely uninstall the Auto Power Off module, an uninstallation script is now available:

Automatic Uninstallation

1. Download the uninstallation script:

   wget -O uninstall.sh https://raw.githubusercontent.com/JayceeB1/Klipper-Auto-Power-Off/main/scripts/uninstall.sh

2. Make it executable:

   chmod +x uninstall.sh

3. Run the script:

   # Run with default language (English)
   ./uninstall.sh
   
   # Or specify a language
   ./uninstall.sh --en  # English
   ./uninstall.sh --fr  # French

4. Follow the on-screen instructions.

The script will automatically perform the following actions:

• Remove the Python module and translation files
• Remove the UI configuration files for Fluidd and Mainsail
• Clean up modifications in printer.cfg
• Remove the update manager configuration in moonraker.conf
• Remove the local Git repository created for updates
• Create backups of all modified configuration files

Advanced Options

• --force: Run the uninstallation without asking for confirmation
• --fr or --en: Specify the language for messages (French or English)

Manual Uninstallation

If you prefer to uninstall manually, follow these steps:

1. Remove the Python module:

   rm ~/klipper/klippy/extras/auto_power_off.py
   rm -r ~/klipper/klippy/extras/auto_power_off_langs

2. Remove the configuration files:

   # For Fluidd
   rm ~/printer_data/config/fluidd/auto_power_off*.cfg
   
   # For Mainsail
   rm ~/printer_data/config/mainsail/auto_power_off*.cfg
   rm ~/printer_data/config/mainsail/auto_power_off_panel*.cfg

3. Edit your printer.cfg file to remove the sections related to Auto Power Off.

4. Edit your moonraker.conf file to remove the [update_manager auto_power_off] section.

5. Remove the local Git repository (usually ~/auto_power_off).

6. Restart Klipper and Moonraker:

   sudo systemctl restart klipper
   sudo systemctl restart moonraker

Troubleshooting

Common Problems and Solutions

Module State Reset

If your power device has been manually turned back on after an automatic power off and you encounter issues with subsequent power off commands, you can use the AUTO_POWEROFF RESET command to force a reset of the module's internal state:

AUTO_POWEROFF RESET

This is particularly useful when:

• The module fails to detect that the printer has been manually powered back on
• Commands like AUTO_POWEROFF NOW no longer work after a manual power-on
• The system is in an inconsistent state after a network or communication interruption

Update Manager Issues

If you see errors like "Failed to detect repo url" or "Invalid path" in your update manager:

1. Download and run the improved installation script
2. Choose "y" when asked to update Moonraker configuration
3. The script will properly set up the git repository and fix configuration issues

CURL-based implementation

The Auto Power Off module uses the CURL command for communication with the Moonraker API instead of Python libraries like requests or urllib. This improves compatibility and reliability, avoiding external dependency issues.

If you have problems communicating with Moonraker, check that the CURL command is available on your system:

which curl

If CURL is not installed, you can install it with:

sudo apt-get install curl

Testing with Dry Run Mode

To safely test the auto power off functionality without actually powering off your printer:

1. Enable dry run mode in your configuration: dry_run_mode: True
2. Or use the GCODE command: AUTO_POWEROFF DRYRUN VALUE=1
3. This will simulate power off and log all actions without actually powering off the printer

Detailed Device Capability Diagnostics

To understand what capabilities your power device has:

1. Enable diagnostic mode: AUTO_POWEROFF DIAGNOSTIC VALUE=1
2. Check logs with: tail -f /tmp/klippy.log | grep -i auto_power_off
3. The logs will show what methods are available for your device
4. This helps troubleshoot why power off might not be working

For Developers

Code Structure

The refactored code now uses a more maintainable architecture:

• Structured exception hierarchy for better error handling
• Type annotations for improved IDE support and code safety
• Enumerations for states and methods for better code structure
• Clear separation of concerns in the codebase

Contributing

Before submitting pull requests, make sure to:

1. Follow the type-safe coding style
2. Maintain backward compatibility
3. Update documentation for any new features
4. Test changes with various configurations

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

Acknowledgements

• Inspired by OctoPrint's PSU Control plugin
• Thanks to the Klipper, Fluidd, and Mainsail development teams