Guide d'utilisation et consignes de sécurité du système FAST

Caractéristiques et conception du système

1. Description des utilisateurs du système

• Le système FAST adopte un mode mono-utilisateur afin de garantir une légèreté et une sécurité maximales.
• Utilisateur unique : root
• Restriction : Le système ne permet pas la création ou le changement vers d'autres comptes utilisateurs.

2. Gestion des paquets logiciels

• Afin de conserver la simplicité et assurer un démarrage rapide, le système FAST n'intègre pas de gestionnaire de paquets traditionnel tel que apt, il n'est donc pas possible d'exécuter des commandes comme apt update.
• Logiciels préinstallés : Le système inclut nativement l'écosystème Klipper ainsi que les outils courants nécessaires à la maintenance.
• Demandes logicielles : Si vous avez besoin d'ajouter des paquets supplémentaires, veuillez nous faire part de votre demande. Nous évaluerons leur utilité générale et envisagerons de les intégrer dans les versions futures.

3. Système de fichiers et persistance

• Chemins modifiables : Afin de garantir l'intégrité du système, FAST n'autorise les modifications que dans les répertoires /etc et /data.
• Restrictions : Les autres répertoires du système sont en lecture seule, toute modification effectuée ailleurs ne sera pas conservée. Veuillez stocker vos configurations personnalisées et données dans les deux répertoires mentionnés ci-dessus.

4. Stratégie de mise à jour du système

Le système FAST prend en charge deux méthodes de mise à jour :

Mise à jour OTA en ligne (recommandé)

• À partir de la version V1.3.0, le système FAST supporte les mises à jour OTA.
• Point d'entrée : Vous pouvez accéder à la page de mise à jour OTA via le port IP de l'hôte:9998.
• Avertissements importants :
  • Avant de lancer une mise à jour, veuillez vous assurer que toutes les impressions sont suspendues.
  • Les services système redémarreront pendant la mise à jour, veuillez ne pas effectuer d'impression, cela pourrait entraîner des échecs d'impression ou un dysfonnement du matériel.

Mise à jour par reflashage

• Cas d'utilisation : Lorsque le système ne démarre plus correctement.
• Avertissement important :
  • Sauvegardez vos paramètres avant le reflashage : Ce processus effacera toutes les données utilisateur, veuillez sauvegarder vos paramètres du système d'impression.
  • Après le reflashage, vous devrez restaurer manuellement vos paramètres sauvegardés.
• Procédure : Veuillez consulter le tutoriel et les outils officiels de reflashage.

Chemins et différences environnementales

Emplacement de génération du firmware

• Après une compilation réussie du firmware Klipper dans le système FAST, le fichier firmware généré se trouve à l'emplacement suivant :

/data/klipper/out/

Emplacement des fichiers de configuration

• Dans le système FAST

Version du firmware	Chemin de configuration Klipper	Chemin de configuration RRF
Chemin de configuration firmware	Loading...	Loading...

Différences d'environnement Python

Le système FAST n'utilise pas l'environnement virtuel Python venv recommandé par Klipper, mais utilise un environnement Python global. Cela implique que toutes les commandes exécutant des scripts Python dans l'environnement Klipper doivent être modifiées.

Modification essentielle : Remplacez ~/klippy-env/bin/python par python dans les commandes.

Scénario	Commande système standard	Commande FAST
Recherche de l'UUID CANBUS	Loading...	Loading...

Problème courant : Lors de l'exécution d'une commande, vous pouvez rencontrer l'erreur suivante :

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

Solution : Remplacez le chemin de l'interpréteur Python dans la commande comme indiqué dans le tableau ci-dessus.

Guide d'installation des composants

Ce document présente la méthode générale pour installer des plugins Klipper dans le système FAST.

Étapes d'installation générales

La plupart des plugins Klipper peuvent être installés selon les étapes simples suivantes :

1. Télécharger le composant dans le répertoire /data

   cd /data
   git clone [adresse du dépôt du plugin]

2. Copier les fichiers Python nécessaires dans le répertoire d'extensions Klipper

   cp /data/[répertoire du plugin]/[fichier principal du plugin].py /data/klipper/klippy/extras/

3. Redémarrer le service Klipper pour que les modifications prennent effet

   systemctl restart klipper

Points importants

• Choix des fichiers : Vérifiez dans la documentation du plugin quels fichiers Python doivent être copiés, ne copiez pas aveuglément tous les fichiers .py
• Vérification des dépendances : Assurez-vous que le plugin ne nécessite pas de dépendances spécifiques avant l'installation
• Compatibilité des versions : Vérifiez que la version du plugin est compatible avec celle de votre Klipper

Informations sur les dépendances

Remarque : Si vous utilisez FlyOS_FAST-V1.3.0 ou une version ultérieure, les dépendances courantes sont déjà intégrées au système, aucun paquet supplémentaire n'est généralement nécessaire.

Exemples d'installation de composants courants

Sonde Beacon 3D

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

IDM ou 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/

Remarques importantes

1. Emplacement d'installation : Tous les composants personnalisés doivent être installés dans le répertoire /data
2. Vérification des fichiers : Vérifiez toujours les fichiers avant de les copier afin d'éviter d'écraser des fichiers critiques
3. Redémarrage requis : Un redémarrage du service Klipper est nécessaire pour que l'installation prenne effet
4. Dépannage : En cas de problème après l'installation, vérifiez que les fichiers copiés sont corrects

FAQ

1. Impossible d'accéder à fly-tools (port 9999) via le navigateur ?

• Le système FAST est un environnement minimaliste et intégré, fly-tools n'est pas installé par défaut, ce qui explique l'absence de réponse sur le port 9999. C'est un comportement normal.

2. ⚠️ Important : À propos des mises à jour des composants système

• Klipper, Moonraker et autres logiciels inclus dans le système FAST sont des versions personnalisées, différentes des versions officielles communautaires.

• 【Principe fondamental】Ne mettez jamais à jour manuellement via la ligne de commande ou d'autres méthodes non officielles, cela pourrait altérer les optimisations du système, provoquer des problèmes de compatibilité ou des dysfonctionnements.
• 【Méthode correcte】Toutes les mises à jour doivent être effectuées via les canaux officiels suivants :
  • Utiliser la fonction Mise à jour OTA en ligne intégrée au système.
  • Ou flasher une nouvelle image système complète.

3. Quelles précautions prendre lors d'une mise à jour OTA ?

1. Sécurité des fichiers de configuration

• La mise à jour OTA est spécialement conçue pour ne pas écraser ou modifier vos fichiers de configuration personnels.

2. Points à surveiller pendant la mise à jour

• Veillez à ce que l'alimentation de l'appareil reste stable pendant l'opération.
• Une coupure électrique pourrait entraîner un échec de la mise à jour, dans les cas graves, un reflashage complet du système sera nécessaire.

3. Gestion des codes personnalisés

• Si vous avez modifié les fichiers de configuration de Klipper ou installé des plugins personnalisés,
• Ces fichiers seront automatiquement ignorés pendant la mise à jour, vos modifications seront donc conservées.

4. Avertissement important : Mise à jour du firmware

• Après chaque mise à jour OTA, veuillez compiler manuellement le firmware Klipper et reprogrammer le microcontrôleur.