# AFC_WebPlugin

**Repository Path**: cds0564/AFC_WebPlugin

## Basic Information

- **Project Name**: AFC_WebPlugin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: Z
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-14
- **Last Updated**: 2025-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AFC Plugin for Moonraker - Installation and Configuration Guide

## Overview
The AFC Plugin integrates the Armored Filament Carousel (AFC) with Moonraker and Mainsail/Fluidd, allowing you to track the filament spools loaded into the AFC and display the relevant information directly in the web interface. This guide will walk you through the installation and configuration process for the plugin and custom Mainsail compilation.

### Prerequisites
- Moonraker installed on your 3D printer controller (e.g., a Raspberry Pi running Klipper)
- Mainsail or Fluidd for controlling and monitoring your 3D printer
- Python 3.9 or higher

## 1. Installing the Moonraker AFC Plugin

### Installation Steps
1. **Run the Installer Script**
   - Make the `install.sh` script executable and run it to install the plugin:
     ```sh
     cd ~
     git clone https://github.com/sbtoonz/AFC_WebPlugin.git
     cd AFC_WebPlugin
     chmod +x install.sh
     ./install.sh
     ```

2. **Configuration File Settings**
   - To enable the plugin, update the Moonraker configuration file (`moonraker.conf`) with the following settings if they were not automatically added:
     ```ini
     [afc_plugin]
     spoolman_enabled: true  # Set to true if Spoolman integration is enabled, false otherwise
     spoolman_ip: 192.168.1.100  # Optional, replace with the IP of your Spoolman server (default is localhost)
     spoolman_port: 7192  # Default port for Spoolman
     ```
   - Save the configuration file.

3. **Restart Moonraker**
   - Restart Moonraker to load the new plugin:
     ```sh
     sudo systemctl restart moonraker
     ```

### Moonraker Plugin Configuration Options
- **`spoolman_enabled`**: Set to `true` if you want to integrate the plugin with Spoolman to enrich the filament data.
- **`spoolman_ip`**: The IP address where Spoolman is running. Defaults to `localhost`.
- **`spoolman_port`**: The port on which Spoolman is running. Default is `7192`.

## 2. Deploying the Custom Mainsail Build for AFC Panel
To display AFC information within the Mainsail UI, choose Mainsail during the installation process. Fluidd support coming soon.

2. **Backup of Existing Mainsail**
   - During the installation, the current version of Mainsail is backed up to ensure that you can roll back if necessary.
   - **Backup Directory**: `/home/pi/mainsail.old`
   - The backup allows you to restore the previous version in case of issues with the new compilation.

3. **Restoring the Old Version**
   - If needed, restore the old version of Mainsail:
     ```sh
     sudo rm -rf /var/www/mainsail
     sudo mv /home/pi/mainsail.old /var/www/mainsail
     ```

## Troubleshooting
- **Panel Not Showing in Mainsail**: Ensure that the new version of Mainsail with the AFC panel has been properly deployed.
- **Spoolman Data Not Showing**: Confirm that the `spoolman_enabled` flag is set to `true` in the Moonraker configuration file and that the Spoolman server is reachable at the specified IP and port.

## Support
For further support, feel free to open an issue on the repository or contact the maintainer directly.