FAST System User Guide and Notes

System Features and Design Notes

1. System User Description

• 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 compactness and fast booting, the FAST system does not integrate traditional package managers such as apt, therefore commands like apt update cannot be executed.
• Pre-installed Software: The system has built-in Klipper ecosystem and commonly used tools required for daily maintenance.
• Software Requirements: If you have additional software package needs, please feel free to provide feedback. We will evaluate their universality 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 Note: Other directories in the system are read-only, and any modifications will not be saved. Please store your custom configurations and data in the two specified directories mentioned above.

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 are paused.
  • During the update, system services will restart. Do not perform any printing operations, otherwise it may cause print failure or hardware malfunction.

Flashing Update

• Applicable Scenario: When the system cannot boot normally.
• Important Warning:
  • Backup Configuration Before Flashing: The flashing process will erase all user data. Please 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 Klipper officially, but instead uses a global Python environment. This leads to the necessity of adjusting all Python script commands that need to call the Klipper environment.

Core Modification: Replace ~/klippy-env/bin/python in commands 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 through the following simple steps:

1. Download component to /data directory

   cd /data
   git clone [plugin repository URL]

2. Copy necessary Python files to Klipper extension directory

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

3. Restart Klipper service to take effect

   systemctl restart klipper

Important Notes

• File Selection: Please confirm the specific Python files to copy based on the plugin documentation. Do not blindly copy all .py files.
• Dependency Check: Check 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 later versions, the system has built-in common dependencies, so additional installations are usually not required.

Common Component Installation Examples

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 purpose before copying to avoid overwriting important files.
3. Service Restart: The Klipper service needs to be restarted after installation to take effect.
4. Troubleshooting: If issues occur after installation, check whether the copied files are correct.

Frequently Asked Questions

1. Why can't I access the fly-tools on port 9999?

The FAST system, as a core runtime environment, does not pre-install the fly-tools web utility by default.

2. Why doesn't the system provide one-click web updates for Klipper and other components?

• Reason: Klipper, Moonraker, and other core components pre-installed in the FAST system are customized versions with in-depth optimization and secondary development, which differ from the upstream official versions.
• Recommendation:
  • We strongly advise against manually updating these components via the command line, as this may lead to system instability, functional anomalies, or invalidation of optimizations.
  • All functional updates and security patches for core components can only be performed using OTA or by re-flashing the latest image.