Repository navigation
setup
Ce guide s'adresse aux développeurs qui souhaitent une configuration personnalisée ou comprendre les détails techniques.
💡 Débutants : Utilisez plutôt le guide de démarrage rapide
📦 Installation automatique (recommandée)
git clone [URL_DU_PROJET]
cd Ornithoptere
./install.sh # ← Solution tout-en-un📖 Guide complet : quickstart
🛠️ Installation développeur (plus de contrôle)
git clone [URL_DU_PROJET]
cd Ornithoptere
./scripts/setup-precommit.sh # Installation environnement dev seulementCe projet utilise pre-commit pour vérifier automatiquement votre code avant chaque commit :
- ✨ Formatage automatique (Black, isort)
- 🔍 Vérification du style (flake8)
- 🧪 Exécution des tests (pytest)
Installation manuelle de pre-commit
# Créer l'environnement virtuel
python3 -m venv .venv
source .venv/bin/activate
# Installer les dépendances
pip install -r requirements-dev.txt
# Installer les hooks pre-commit
pre-commit install🔧 Dépannage pre-commit
Problèmes courants :
-
❌ "Command not found: pre-commit"
source .venv/bin/activate -
❌ Commit échoue avec "files were modified" C'est normal ! Pre-commit a formaté votre code :
git add . git commit -m "Votre message"
-
❌ Tests qui échouent
./scripts/run-tests.sh # Voir les erreurs # Corriger les erreurs puis recommiter
Commandes utiles :
# Tester tous les hooks
pre-commit run --all-files
# Tester un hook spécifique
pre-commit run black
pre-commit run pytest
# En urgence (non recommandé)
git commit --no-verifyConsultez le guide de dépannage détaillé pour plus d'aide.
📦 Dépendances système requises
sudo apt update
sudo apt install tmux python3-venv screen
pip install mpfshell
⚠️ Sipipn'est pas installé :sudo apt install python3-pip
🖥️ Utiliser screen pour se connecter à l'ESP32
Lister les ports disponibles :
ls /dev/ttyUSB*Se connecter à l'ESP32 :
screen /dev/ttyUSB0 115200Raccourcis utiles dans screen :
| Action | Raccourci |
|---|---|
| Quitter screen |
Ctrl + A, puis K, puis Y
|
| Détacher |
Ctrl + A, puis D
|
| Revenir | screen -r |
🪟 Utiliser tmux pour surveiller plusieurs ESP
Lancer tmux :
tmuxDiviser l'écran :
| Action | Raccourci |
|---|---|
| Split horizontal (haut/bas) |
Ctrl + B, puis "
|
| Split vertical (gauche/droite) |
Ctrl + B, puis %
|
| Naviguer entre panneaux |
Ctrl + B, puis flèches |
| Activer la souris | tmux set -g mouse on |
Mise en page recommandée :
+-------------------------+-------------------------+
| Terminal série USB0 | Terminal série USB1 |
| (réception) | (émission) |
+--------------------------------------------------+
| Terminal libre pour git, mpfshell, etc. |
+--------------------------------------------------+
Raccourcis tmux :
| Action | Raccourci |
|---|---|
| Détacher |
Ctrl + B, puis D
|
| Rejoindre | tmux attach |
| Fermer panneau |
exit ou Ctrl + D
|
Nouveau ! Vous pouvez maintenant développer et tester sans ESP32 grâce au mode simulation.
📖 Voir le guide complet : Mode simulation PC
Avantages :
- ✅ Testez votre code sans hardware
- ✅ Débug plus facile avec messages visibles
- ✅ Développement plus rapide
- Documentation technique du projet
- Documentation des scripts
- Liste des dépendances - Liste complète pour réinstallation
- Mode simulation PC - Guide détaillé
- MicroPython REPL docs
- tmux Cheat Sheet
- screen User Guide