Files
3ch-led-driver/docs/quick-start.md
T

139 lines
5.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Mise en service rapide
Ce guide décrit la première programmation et la configuration réseau du `3ch-led-driver`.
## Pré-requis
- une carte `3ch-led-driver` assemblée ;
- un câble USB-C capable de transporter les données ;
- ESPHome installé ou l'add-on ESPHome de Home Assistant ;
- une alimentation limitée en courant pour les premiers essais ;
- aucune charge LED connectée lors du premier démarrage ;
- la configuration [`esphome/3ch-led-1.2-esphome.yaml`](../esphome/3ch-led-1.2-esphome.yaml).
La version ESPHome et la version exacte de l'environnement ESP-IDF utilisées pour la dernière compilation validée doivent être ajoutées au projet. La configuration actuelle utilise ESP-IDF pour un ESP32-C6 et `platform_version: 6.5.0`.
## 1. Vérifier l'alimentation
La carte peut être alimentée par :
- l'entrée principale : **5 à 48 V DC** ;
- l'USB-C : **5 V DC** pour la logique et la programmation.
Pour le premier flash, utiliser de préférence l'USB-C et ne pas connecter simultanément l'entrée 5–48 V tant que le comportement des deux sources n'est pas documenté.
Vérifier la polarité de l'entrée principale avant toute mise sous tension.
## 2. Préparer le firmware
Dans ESPHome, créer un nouvel appareil à partir de la configuration du dépôt ou ouvrir directement :
```text
esphome/3ch-led-1.2-esphome.yaml
```
La configuration expose trois lumières :
| Entité | GPIO |
|---|---:|
| Channel 1 | GPIO19 |
| Channel 2 | GPIO20 |
| Channel 3 | GPIO21 |
Le fichier active également l'API ESPHome, l'OTA, le serveur web et le portail captif.
## 3. Programmer par USB-C
1. Relier la carte à l'ordinateur avec un câble USB-C de données.
2. Choisir la carte ESP32-C6 détectée par ESPHome.
3. Compiler le firmware.
4. Effectuer le premier flash par USB.
5. Ouvrir les logs série et vérifier que l'ESP32-C6 démarre correctement.
6. Débrancher puis rebrancher l'USB-C si nécessaire.
La procédure exacte de passage en mode bootloader doit être complétée avec la séquence validée pour `SW1` et `SW2`.
## 4. Configurer le Wi-Fi
La configuration prévoit un point d'accès Wi-Fi de secours et un portail captif. Celui-ci doit être utilisé lorsque le module ne possède pas encore de paramètres Wi-Fi valides ou ne parvient pas à rejoindre le réseau configuré.
Procédure générale :
1. démarrer la carte ;
2. rechercher le réseau Wi-Fi de secours créé par l'ESP32-C6 ;
3. s'y connecter avec le mot de passe défini dans la configuration ;
4. ouvrir le portail captif si celui-ci ne s'affiche pas automatiquement ;
5. saisir les identifiants du réseau Wi-Fi local ;
6. attendre le redémarrage et l'obtention d'une adresse IP.
Le mot de passe du point d'accès de secours présent dans le fichier YAML est une valeur par défaut de projet. Il ne doit pas être considéré comme un secret de production.
## 5. Ajouter le périphérique à ESPHome ou Home Assistant
Après connexion au réseau, le périphérique peut être ajouté manuellement dans ESPHome ou détecté par le mécanisme d'import du dashboard.
La configuration contient actuellement :
```yaml
dashboard_import:
package_import_url: https://git.enerwize.fr/Enerwize/3ch-led-driver/esphome/3ch-led-1.2-esphome.yaml
import_full_config: false
```
L'URL d'import doit être testée depuis un dashboard ESPHome vierge et idéalement être liée à une révision ou à un tag stable. La procédure d'adoption validée doit être ajoutée ici après test.
## 6. Tester les sorties
Effectuer les tests dans l'ordre suivant :
1. laisser les charges déconnectées et vérifier que l'ESP32-C6 reste accessible ;
2. tester Channel 1 avec une charge limitée ;
3. tester Channel 2 ;
4. tester Channel 3 ;
5. vérifier l'extinction complète de chaque canal ;
6. tester plusieurs canaux à faible courant ;
7. augmenter progressivement la charge.
Respecter en permanence :
- 4 A maximum par canal ;
- 10 A maximum cumulés ;
- la tension d'entrée de 5 à 48 V DC.
Arrêter immédiatement le test en cas de surchauffe, odeur, bruit électrique inhabituel ou fonctionnement instable.
## 7. Mise à jour OTA
Une fois le Wi-Fi et l'API validés, les mises à jour peuvent être effectuées par OTA depuis ESPHome.
Avant toute mise à jour OTA :
- vérifier que l'alimentation est stable ;
- ne pas couper l'alimentation pendant l'écriture ;
- conserver une méthode de récupération par USB-C ;
- noter la version firmware actuellement installée.
## Dépannage rapide
### Aucun port USB n'apparaît
- vérifier que le câble USB-C transporte les données ;
- essayer un autre port USB ;
- vérifier la séquence de mise en bootloader avec les boutons de la carte ;
- vérifier les permissions du système hôte.
### Le point d'accès Wi-Fi n'apparaît pas
- attendre le délai de démarrage complet ;
- vérifier les logs série ;
- redémarrer la carte ;
- vérifier que le firmware chargé contient bien `wifi.ap` et `captive_portal`.
### Un canal ne commute pas
- tester sans charge ;
- vérifier la correspondance GPIO19/GPIO20/GPIO21 ;
- vérifier le câblage de J2 ;
- vérifier la polarité et la tension de la charge ;
- inspecter le transistor et les soudures correspondantes.