Guide d'utilisation et remarques sur le système FAST

Caractéristiques et Conception du Système

1. Description des Utilisateurs du Système

• FAST adopte un mode mono-utilisateur afin d'atteindre une extrême légèreté et sécurité.
• 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 maintenir sa simplicité et rapidité au démarrage, le système FAST n'intègre pas de gestionnaire de paquets traditionnels comme apt, il n'est donc pas possible d'exécuter des commandes telles que apt update.
• Logiciels préinstallés : Le système inclut nativement l'écosystème Klipper ainsi que les outils courants nécessaires à la maintenance.
• Demande de logiciels : Si vous avez des besoins spécifiques en termes de paquets logiciels supplémentaires, veuillez nous faire part de vos demandes. 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 ne permet la modification que des fichiers situés dans les répertoires /etc et /data.
• Restrictions : Les autres répertoires du système sont en lecture seule, toutes modifications effectuées ailleurs ne seront pas conservées. 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

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'accès : Vous pouvez accéder à la page de mise à jour OTA via le port 9998 de l'adresse IP de la machine hôte.
• Important :
  • Avant de lancer une mise à jour, veuillez vous assurer que toutes les impressions sont suspendues.
  • Pendant la mise à jour, les services système redémarreront, veuillez ne pas lancer d'impression, cela pourrait entraîner des échecs d'impression ou une perte de contrôle du matériel.

Mise à Jour par Rechargement du Système (Flashage)

• Cas d'utilisation : Lorsque le système ne démarre plus correctement.
• Avertissement important :
  • Sauvegardez vos paramètres avant le flashage : Le processus de flash effacera toutes les données utilisateur. Veuillez sauvegarder vos paramètres système avant de procéder.
  • Après le flashage, vous devrez restaurer manuellement vos fichiers de configuration sauvegardés.
• Procédure : Veuillez vous référer aux tutoriels et outils officiels fournis.

Différences de Chemins et Environnement

Emplacement de Génération du Firmware

• Après une compilation réussie du firmware Klipper dans le système FAST, le fichier 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 un environnement Python global. Cela implique que toutes les commandes exécutant des scripts Python dans l'environnement Klipper doivent être adaptées.

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

Scénario	Commande 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 décrit la méthode générale pour installer des plugins Klipper dans le système FAST.

Étapes Générales d'Installation

La plupart des plugins Klipper peuvent être installés en suivant ces étapes simples :

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/[dossier_plugin]/[fichier_princpal].py /data/klipper/klippy/extras/

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

   systemctl restart klipper

Remarques Importantes

• Choix des fichiers : Vérifiez selon la documentation du plugin les fichiers Python spécifiques à copier, ne copiez pas tous les fichiers .py aveuglément
• Vérification des dépendances : Assurez-vous que le plugin ne nécessite pas de dépendances particulières 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

Note : Si vous utilisez la version FlyOS_FAST-V1.3.0 ou ultérieure, les dépendances courantes sont déjà intégrées, il n’est généralement pas nécessaire d’installer des dépendances supplémentaires.

Exemples d'Installation de Composants Courants

Beacon 3D Sonde

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 : Veuillez installer tous les composants personnalisés sous le répertoire /data
2. Vérification des fichiers : Vérifiez bien l'utilisation des fichiers avant de les copier pour éviter d'écraser des fichiers importants
3. Redémarrage du service : Vous devez redémarrer le service Klipper après l'installation pour que les modifications prennent 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 via le navigateur (Port 9999) ?

• Le système FAST est un environnement central hautement intégré, l'outil web fly-tools n'est pas préinstallé par défaut, le port 9999 ne répondra donc à aucun service. Ceci est un design normal.

2. ⚠️ Important : Informations sur les mises à jour des composants système

• Klipper, Moonraker et autres composants dans le système FAST sont des versions personnalisées, différentes des versions officielles de la communauté.

• 【Règle essentielle】Ne mettez jamais à jour manuellement via des commandes ou des canaux non officiels, cela pourrait compromettre les optimisations du système et entraîner des problèmes de compatibilité ou de fonctionnement.
• 【Procédure 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 reflasher l'ensemble du système avec la dernière image système disponible.

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

• Veuillez maintenir une alimentation stable pendant la mise à jour
• Une coupure inattendue d'alimentation pourrait entraîner un échec de la mise à jour, nécessitant dans les cas graves un reflashage complet du système

3. Gestion des codes personnalisés

• Si vous avez modifié les fichiers de configuration Klipper ou installé des plugins personnalisés
• La mise à jour OTA ignorera automatiquement ces fichiers pour préserver vos modifications

4. Important : Mise à jour du Firmware

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