FAST System User Guide and Notes

System Features and Design Notes

1. System User Information

• FAST system adopts single-user mode to pursue ultimate lightweight and security.
• Only User: root
• Restriction: The system does not support creating or switching to other user accounts.

2. Package Management

• To maintain its streamlined design and fast boot speed, the FAST system does not include traditional package managers like apt, so commands such as apt update cannot be executed.
• Pre-installed Software: The system comes with the Klipper ecosystem and commonly used tools required for daily maintenance.
• Software Requests: If you have additional software package needs, please feel free to provide feedback. We will evaluate their general applicability and consider pre-installing them in future versions.

3. File System and Persistence

• Writable Paths: To ensure the integrity of the core system, the FAST system only allows modifications to files under the /etc and /data directories.
• Restriction Notes: Other directories in the system are read-only, and any modifications made will not be saved. Please store your custom configurations and data within the two specified directories.

4. System Update Policy

The FAST system supports two update methods:

OTA Online Update (Recommended)

• Starting from V1.3.0, the FAST system supports OTA upgrades.
• Update Entry: You can access the system OTA upgrade page by visiting the host's IP address:9998 port.
• Important Reminder:
  • Before initiating a system update, please ensure that all printing tasks have been paused.
  • During the update, system services will restart. Do not perform any printing operations, as this may cause print failures or hardware instability.

Firmware Flashing Update

• Applicable Scenario: When the system fails to boot normally.
• Important Warning:
  • Backup Configuration Before Flashing: The flashing process will erase all user data. Please make sure to back up your printer system configuration in advance.
  • After flashing, you need to manually restore the backed-up configuration files.
• Flashing Method: Please refer to the official flashing tutorial and tools.

Path and Environment Differences

Firmware Generation Location

• In the FAST system, after successfully compiling the Klipper firmware, the generated firmware file is located at:

/data/klipper/out/

Configuration File Locations

• In the FAST system

Firmware Version	Klipper Configuration Path	RRF Configuration Path
Firmware Configuration Path	Loading...	Loading...

Python Environment Differences

The FAST system does not use the Python venv virtual environment recommended by the Klipper official, but instead uses a global Python environment. This results in the need to adjust all commands that require invoking Python scripts under the Klipper environment.

Core Modification: Replace ~/klippy-env/bin/python in the command with python.

Scenario Description	Standard System Command	FAST System Command
Query CANBUS UUID	Loading...	Loading...

Common Issue: When executing commands, you may encounter the following error:

-bash: ~/klippy-env/bin/python: No such file or directory

Solution: Replace the Python interpreter path in the command as shown in the table above.

Component Installation Guide

This document describes the general method for installing Klipper plugins in the FAST system.

General Installation Steps

Most Klipper plugins can be installed using the following simple steps:

1. Download the component to the /data directory

   cd /data
   git clone [plugin repository URL]

2. Copy necessary Python files to the Klipper extension directory

   cp /data/[plugin directory]/[plugin main file].py /data/klipper/klippy/extras/

3. Restart the Klipper service to apply changes

   systemctl restart klipper

Important Notes

• File Selection: Confirm the specific Python files that need to be copied according to the plugin documentation. Do not blindly copy all .py files.
• Dependency Check: Verify if the plugin has special dependency requirements before installation.
• Version Compatibility: Ensure the plugin version is compatible with your Klipper version.

Dependency Notes

Note: If you are using FlyOS_FAST-V1.3.0 or newer, the system already includes commonly used dependencies and typically does not require additional installation.

Example Installation of Common Components

Beacon 3D Probe

cd /data && git clone https://github.com/beacon3d/beacon_klipper.git
cp /data/beacon_klipper/beacon.py /data/klipper/klippy/extras/

IDM or Scanner

cd /data && git clone https://gitee.com/NBTP/IDM.git
cp /data/IDM/idm.py /data/klipper/klippy/extras/
cp /data/IDM/scanner.py /data/klipper/klippy/extras/

Cartographer 3D

cd /data && git clone https://github.com/Cartographer3D/cartographer-klipper.git
cp /data/cartographer-klipper/idm.py /data/klipper/klippy/extras/
cp /data/cartographer-klipper/scanner.py /data/klipper/klippy/extras/
cp /data/cartographer-klipper/cartographer.py /data/klipper/klippy/extras/

Notes

1. Installation Location: All custom components should be installed under the /data directory.
2. File Confirmation: Confirm the file's purpose before copying to avoid overwriting important files.
3. Service Restart: After installation, the Klipper service needs to be restarted to take effect.
4. Troubleshooting: If issues occur after installation, please check whether the copied files are correct.

Frequently Asked Questions

1. What should I do if I cannot access fly-tools (port 9999) via browser?

• The FAST system is a highly integrated core operating environment and does not come pre-installed with the fly-tools web utility by default, so port 9999 will have no service response. This is by design.

2. ⚠️ Important: Notes on System Component Updates

• Klipper, Moonraker, and others in the FAST system are customized versions and differ from official community versions.

• [Core Principle] Do not manually update via command line or other unofficial channels, as this will break system optimizations and cause compatibility issues or functional malfunctions.
• [Correct Method] All component updates must be done through the following official methods:
  • Use the system's built-in OTA online update feature.
  • Or re-flash the latest system image.

3. What should I pay attention to during OTA updates?

1. Configuration File Safety

• OTA updates are specially designed to not overwrite or modify your personal configuration files.

2. Notes During the Update Process

• Ensure stable power supply to the device during the update.
• Unexpected power loss may result in update failure, potentially requiring a full system reflash.

3. Custom Code Handling

• If you have modified Klipper configuration files or installed custom plugins,
• The update will automatically skip related files to ensure your modifications are preserved.

4. Important Reminder: Firmware Update

• After each OTA update, you must manually compile the Klipper firmware and re-flash the microcontroller firmware.