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 ultimate lightweight design and security.
  • Sole User: root
  • Restriction: The system does not support creating or switching to other user accounts.

2. Software Package Management​

  • To maintain a minimal footprint and fast boot times, the FAST system does not include traditional package managers like apt. Therefore, commands such as apt update cannot be executed.
  • Pre-installed Software: The system comes pre-loaded with the Klipper ecosystem and common 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. Filesystem and Persistence​

  • Writable Paths: To ensure the integrity of the system core, the FAST system only allows modifications to files within the /etc and /data directories.
  • Restriction Details: All other system directories are read-only. Any modifications made outside /etc and /data will not be saved. Please store your custom configurations and data within the two specified directories mentioned above.

4. System Update Strategy​

The FAST system supports two update methods:

  • Starting from V1.3.0, the FAST system supports OTA updates.
  • Update Portal: You can access the system OTA update page by visiting IP Address:9998 on the host computer.
  • Important Reminders:
    • Before initiating a system update, ensure all print jobs are paused.
    • System services will restart during the update process. Do not perform any printing operations, as this may cause print failures or hardware malfunctions.

Flashing Update​

  • Applicable Scenario: When the system cannot boot normally.
  • Critical Warning:
    • Backup Configuration Before Flashing: The flashing process will erase all user data. You must back up your 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 tutorials and tools provided.

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 official documentation. Instead, it employs a global Python environment. This necessitates adjustments to all commands that need to invoke Python scripts within the Klipper environment.

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

Scenario DescriptionStandard System CommandFAST System Command
Query CANBUS UUID
Loading...
Loading...

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

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

Solution: As shown in the table above, replace the Python interpreter path in the command.

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 address]

  2. Copy necessary Python files to the Klipper extensions directory

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

  3. Restart the Klipper service to take effect

    systemctl restart klipper

Important Notes​

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

Dependency Note​

Note: If you are using FlyOS_FAST-V1.3.0 or a newer version, the system already includes common dependencies, and usually no additional installation is 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: Install all custom components uniformly under the /data directory.
  2. File Verification: Confirm the purpose of files before copying to avoid overwriting important files.
  3. Service Restart: The Klipper service must be restarted after installation for changes to take effect.
  4. Troubleshooting: If abnormalities occur after installation, check if the copied files are correct.

Frequently Asked Questions​

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

  • The FAST system is a highly integrated core runtime environment. The fly-tools web utility is not pre-installed by default, hence there is no service responding on port 9999. This is by design.

2. ⚠️ Important: Regarding System Component Updates​

  • Klipper, Moonraker, and other components within the FAST system are customized versions and differ from the community official releases.
  • 【Core Principle】Do not manually update via command line or other unofficial channels, as this will break system optimizations, leading to compatibility issues and functional abnormalities.
  • 【Correct Method】All component updates must be performed through the following official channels:
    • Use the built-in OTA Online Update feature.
    • Or re-flash the complete latest system image.

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

1. Configuration File Safety

  • The OTA update is specially designed and will not overwrite or modify your personal configuration files.

2. Update Process Precautions

  • Ensure stable power supply to the device during the update.
  • A power failure during the update will cause it to fail, potentially requiring a system re-flash in severe cases.

3. Handling Custom Code

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

4. Important Reminder: Firmware Update

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