Add project README and usage documentation
This commit is contained in:
PandemiK committed
1 parent
4926ac0c78
commit
bdbf4d9fcb
1 file changed
+135
@@ -0,0 +1,135 @@
|
|||||||
|
# 3ch-led-driver
|
||||||
|
|
||||||
|
Driver LED trois canaux basé sur un ESP32-C6 et piloté par ESPHome.
|
||||||
|
|
||||||
|
Le module permet de commander trois charges LED indépendantes par PWM, avec une intégration possible dans Home Assistant via l'API ESPHome. Le premier flash et l'alimentation de l'ESP32-C6 peuvent être réalisés par USB-C.
|
||||||
|
|
||||||
|
> **Important :** les limites publiées dans ce document sont les spécifications d'utilisation du projet. Respecter simultanément la limite de 4 A par canal et la limite totale de 10 A.
|
||||||
|
|
||||||
|
## Statut du projet
|
||||||
|
|
||||||
|
La carte, le firmware ESPHome, le boîtier et les fichiers de production sont présents dans ce dépôt. La révision matérielle et la compatibilité exacte entre toutes les variantes de fichiers doivent être vérifiées avant une production en série.
|
||||||
|
|
||||||
|
## Caractéristiques principales
|
||||||
|
|
||||||
|
- trois sorties LED indépendantes ;
|
||||||
|
- commande PWM par ESP32-C6 ;
|
||||||
|
- alimentation principale de 5 à 48 V DC ;
|
||||||
|
- alimentation et programmation de l'ESP32-C6 par USB-C 5 V ;
|
||||||
|
- intégration ESPHome et Home Assistant ;
|
||||||
|
- mise à jour OTA après la première configuration réseau ;
|
||||||
|
- boîtier imprimable en 3D.
|
||||||
|
|
||||||
|
## Spécifications électriques
|
||||||
|
|
||||||
|
| Paramètre | Valeur |
|
||||||
|
|---|---:|
|
||||||
|
| Alimentation principale | 5 à 48 V DC |
|
||||||
|
| Nombre de canaux | 3 |
|
||||||
|
| Courant maximal par canal | 4 A |
|
||||||
|
| Courant total maximal | 10 A |
|
||||||
|
| Alimentation USB-C | 5 V DC |
|
||||||
|
| Fonction USB-C | alimentation de la logique et programmation de l'ESP32-C6 |
|
||||||
|
|
||||||
|
La limite totale est indépendante de la limite par canal. La combinaison 4 A + 4 A + 4 A, soit 12 A, n'est donc pas autorisée.
|
||||||
|
|
||||||
|
Les conditions de validation des courants maximaux — durée, température ambiante, facteur de marche PWM, câblage et refroidissement — doivent être précisées avant une utilisation industrielle ou une production en série.
|
||||||
|
|
||||||
|
## Correspondance des canaux
|
||||||
|
|
||||||
|
La configuration ESPHome actuelle utilise les broches suivantes :
|
||||||
|
|
||||||
|
| Canal | GPIO ESP32-C6 | Nom ESPHome |
|
||||||
|
|---|---:|---|
|
||||||
|
| Channel 1 | GPIO19 | Channel 1 |
|
||||||
|
| Channel 2 | GPIO20 | Channel 2 |
|
||||||
|
| Channel 3 | GPIO21 | Channel 3 |
|
||||||
|
|
||||||
|
La correspondance des broches GPIO est définie dans [`esphome/3ch-led-1.2-esphome.yaml`](esphome/3ch-led-1.2-esphome.yaml).
|
||||||
|
|
||||||
|
## Alimentation et USB-C
|
||||||
|
|
||||||
|
L'entrée principale accepte une tension continue de 5 à 48 V et doit être raccordée en respectant la polarité indiquée sur la carte.
|
||||||
|
|
||||||
|
Le connecteur USB-C peut être utilisé pour alimenter la logique en 5 V et programmer l'ESP32-C6. Il est recommandé d'effectuer le premier flash sans charge LED connectée, puis de tester les canaux progressivement.
|
||||||
|
|
||||||
|
La documentation électrique doit encore confirmer si l'entrée principale et l'USB-C peuvent être raccordées simultanément. En l'absence de validation spécifique, ne pas connecter les deux sources d'alimentation en même temps.
|
||||||
|
|
||||||
|
## Mise en service rapide
|
||||||
|
|
||||||
|
1. Consulter [`docs/quick-start.md`](docs/quick-start.md).
|
||||||
|
2. Programmer l'ESP32-C6 par USB-C avec la configuration ESPHome.
|
||||||
|
3. Alimenter la carte sans charge LED connectée.
|
||||||
|
4. Configurer le réseau Wi-Fi via le point d'accès de secours si nécessaire.
|
||||||
|
5. Ajouter le périphérique dans ESPHome ou Home Assistant.
|
||||||
|
6. Tester les trois canaux séparément avec une charge limitée.
|
||||||
|
7. Augmenter progressivement la charge sans dépasser 4 A par canal ni 10 A au total.
|
||||||
|
|
||||||
|
## Firmware ESPHome
|
||||||
|
|
||||||
|
La configuration se trouve dans [`esphome/3ch-led-1.2-esphome.yaml`](esphome/3ch-led-1.2-esphome.yaml).
|
||||||
|
|
||||||
|
Elle active notamment :
|
||||||
|
|
||||||
|
- ESP-IDF sur ESP32-C6 ;
|
||||||
|
- l'API ESPHome ;
|
||||||
|
- l'OTA ;
|
||||||
|
- le serveur web ;
|
||||||
|
- le portail captif ;
|
||||||
|
- trois sorties PWM LEDC.
|
||||||
|
|
||||||
|
La version exacte d'ESPHome utilisée pour la dernière compilation validée doit être ajoutée à la documentation de versionnement. La configuration utilise actuellement `version: latest` pour le framework, ce qui peut rendre une reconstruction future différente.
|
||||||
|
|
||||||
|
## Matériel et fabrication
|
||||||
|
|
||||||
|
- Schéma principal : [`led-driver_v1.0/led-driver_v1.0.kicad_sch`](led-driver_v1.0/led-driver_v1.0.kicad_sch)
|
||||||
|
- PCB KiCad : [`led-driver_v1.0/led-driver_v1.0.kicad_pcb`](led-driver_v1.0/led-driver_v1.0.kicad_pcb)
|
||||||
|
- BOM de production : [`led-driver_v1.0/production/bom.csv`](led-driver_v1.0/production/bom.csv)
|
||||||
|
- Fichiers de production : [`led-driver_v1.0/production/`](led-driver_v1.0/production/)
|
||||||
|
- Modèles 3D de la carte : [`led-driver_v1.0/`](led-driver_v1.0/)
|
||||||
|
- Modèles du boîtier : [`box/`](box/)
|
||||||
|
|
||||||
|
Voir [`docs/pinout.md`](docs/pinout.md) pour le brochage et [`docs/manufacturing.md`](docs/manufacturing.md) pour la fabrication et les contrôles.
|
||||||
|
|
||||||
|
## Organisation du dépôt
|
||||||
|
|
||||||
|
```text
|
||||||
|
.
|
||||||
|
├── README.md
|
||||||
|
├── docs/
|
||||||
|
│ ├── manufacturing.md
|
||||||
|
│ ├── pinout.md
|
||||||
|
│ └── quick-start.md
|
||||||
|
├── esphome/
|
||||||
|
│ └── 3ch-led-1.2-esphome.yaml
|
||||||
|
├── led-driver_v1.0/
|
||||||
|
│ ├── schéma et PCB KiCad
|
||||||
|
│ ├── fichiers de production
|
||||||
|
│ └── modèles 3D
|
||||||
|
└── box/
|
||||||
|
└── modèles du boîtier
|
||||||
|
```
|
||||||
|
|
||||||
|
## Versions
|
||||||
|
|
||||||
|
Les noms actuels mélangent plusieurs références (`led-driver_v1.0`, `3ch-led-1.2-esphome.yaml` et des modèles `v1.2`). Avant une release, publier une matrice de compatibilité entre :
|
||||||
|
|
||||||
|
- la révision du PCB ;
|
||||||
|
- la configuration ESPHome ;
|
||||||
|
- le boîtier ;
|
||||||
|
- les fichiers de production ;
|
||||||
|
- les limites électriques validées.
|
||||||
|
|
||||||
|
## Licence
|
||||||
|
|
||||||
|
Aucune licence n'est actuellement déclarée dans le dépôt. Ajouter une licence logicielle, matérielle et/ou de modèles 3D avant une diffusion publique ou une réutilisation par des tiers.
|
||||||
|
|
||||||
|
## Points restant à valider
|
||||||
|
|
||||||
|
- courant continu ou courant de pointe pour les limites 4 A et 10 A ;
|
||||||
|
- conditions thermiques associées à ces limites ;
|
||||||
|
- brochage détaillé et polarité de tous les connecteurs ;
|
||||||
|
- possibilité de brancher simultanément l'alimentation 5–48 V et l'USB-C ;
|
||||||
|
- procédure de test après assemblage ;
|
||||||
|
- version ESPHome/ESP-IDF de référence ;
|
||||||
|
- compatibilité exacte entre la carte de production et `esp32-c6-devkitc-1`.
|
||||||
Reference in new issue
Block a user