Skip to main content

FAST System User Guide and Precautions

System Features and Design Description​

1. System User Description​

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

2. Software Package Management​

  • The FAST system does not integrate traditional package managers like apt to maintain simplicity and fast startup, so commands like apt update cannot be executed.
  • Preset Software: The system has built-in tools commonly needed for the Klipper ecosystem and daily maintenance.
  • Software Needs: If you have additional software package requirements, please feel free to provide feedback. We will evaluate their general applicability and consider including them in future versions.

3. File System and Persistence​

  • Modifiable Paths: To ensure the integrity of the system core, the FAST system only allows modifying files in the /etc and /data directories.
  • Restriction Note: All other system directories are read-only, and any modifications will not be saved. Please store your custom configurations and data within the two specified directories.

4. System Update Strategy​

The FAST system supports two update methods:

  • Starting from V1.3.0, the FAST system supports OTA upgrades.
  • Update Entry: You can access the system OTA update page by navigating to the host's IP address:9998 port.
  • Important Reminders:
    • Before initiating a system update, please ensure all print jobs have been paused.
    • System services will restart during the update process. Do not perform any printing operations, otherwise, it may cause print failures or hardware loss of control.

Flash Update​

  • Applicable Scenario: When the system fails to start normally.
  • Important Warning:
    • Back up configuration before flashing: The flashing process will erase all user data. Please be sure to back up the printer system configuration beforehand.
    • After flashing is complete, 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 VersionKlipper Config PathRRF Config Path
Firmware Config Path
Loading...
Loading...

Python Environment Differences​

The FAST system does not use the Python venv virtual environment recommended by Klipper's official documentation; instead, it uses a global Python environment. This means all Python script commands that need to call the Klipper environment must be adjusted.

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

Scenario DescriptionStandard System CommandFAST 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 by following these simple steps:

  1. Download the component to the /data directory

    cd /data
    git clone [Plugin repository URL]

  2. Copy the 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: Please confirm the specific Python files to copy based on the plugin documentation. Do not blindly copy all .py files.
  • Dependency Check: Before installation, confirm whether the plugin has any special dependency requirements.
  • 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 a later version, the system has built-in common dependencies, so additional installation is 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/

Precautions​

  1. Installation Location: Please install all custom components uniformly under the /data directory.
  2. File Confirmation: Confirm the file's purpose before copying to avoid overwriting important files.
  3. Service Restart: After installation, you must restart the Klipper service for the changes to take effect.
  4. Troubleshooting: If an error occurs after installation, please check if the copied files are correct.

Frequently Asked Questions​

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

  • The FAST system is a highly integrated core operating environment. The fly-tools web tool is not pre-installed by default, so port 9999 does not have a service responding. This is normal by design.

2. ⚠️ Important: Note on System Component Updates​

  • Klipper, Moonraker, and other components within the FAST system are customized versions and differ from the official community versions.
  • 【Core Principle】Do not manually update via command line or other unofficial channels. Doing so will damage system optimizations, leading to compatibility issues and functional anomalies.
  • 【Correct Method】All component updates must be performed through the following official channels:
    • Use the system's built-in OTA Online Update function.
    • Or reflash the complete latest system image.

3. What should I pay attention to during an OTA update?​

1. Configuration File Safety

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

2. Update Process Precautions

  • Ensure stable power supply to the device during the update.
  • An unexpected power outage will cause the update to fail, potentially requiring a system reflash.

3. Custom Code Handling

  • If you have modified Klipper configuration files or installed custom plugins,
  • The OTA update will automatically skip relevant files, ensuring your modifications are preserved.

4. Important Reminder: Firmware Update

  • After each OTA update, you must manually compile the Klipper firmware, then reflash the MCU firmware.
Loading...