From 2be70fb06d44ca9ce1eb87cbb253cc68c5a31894 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Metrich?= Date: Tue, 16 Jul 2024 18:36:07 +0200 Subject: [PATCH 1/3] First step reorg --- content/index.rst | 7 +- content/introduction.md | 83 ------------------ content/introduction.rst | 87 +++++++++++++++++++ content/mk2pvrouter.rst | 13 +++ content/{ => mono}/assemblage_mono.md | 0 content/{ => mono}/boitier-mono.rst | 0 content/{ => mono}/carte-mere-mono-A.rst | 0 content/{ => mono}/carte-mere-mono-B.rst | 0 content/{ => mono}/carte-mere-mono-C.rst | 0 content/{ => mono}/carte-mere-mono-D.rst | 0 content/{ => mono}/carte-mere-mono-E.rst | 0 content/{ => mono}/carte-mere-mono-commun.rst | 0 .../{ => mono}/carte-mere-mono-inventaire.rst | 0 .../{ => mono}/carte-mere-mono-soudure.rst | 0 .../{ => mono}/carte-mere-mono-synthese.rst | 0 .../carte-mere-mono-test-afficheur.rst | 0 .../{ => mono}/carte-mere-mono-test-elec.rst | 0 content/{ => mono}/carte-mere-mono-tests.rst | 0 content/{ => mono}/carte-mere-mono.rst | 0 content/{ => mono}/carte-sortie-mono.rst | 0 .../{ => mono}/carte-sortie-relais-mono.rst | 0 content/{ => mono}/dissipateur-mono.rst | 0 content/{ => mono}/etalonnage-mono.md | 0 .../test-logiciel-mono-requirements.rst | 0 content/{ => mono}/test-logiciel-mono.rst | 0 content/{ => mono}/test-mono-mesures.rst | 0 content/{ => tri}/assemblage_tri.md | 0 content/{ => tri}/boitier-tri.rst | 0 content/{ => tri}/carte-mere-tri.md | 0 content/{ => tri}/carte-sortie-relais-tri.rst | 0 content/{ => tri}/carte-sortie-tri.rst | 0 content/{ => tri}/dissipateur-tri.rst | 0 content/{ => tri}/etalonnage-tri.md | 0 content/{ => tri}/test-logiciel-tri.rst | 0 34 files changed, 103 insertions(+), 87 deletions(-) delete mode 100644 content/introduction.md create mode 100644 content/introduction.rst create mode 100644 content/mk2pvrouter.rst rename content/{ => mono}/assemblage_mono.md (100%) rename content/{ => mono}/boitier-mono.rst (100%) rename content/{ => mono}/carte-mere-mono-A.rst (100%) rename content/{ => mono}/carte-mere-mono-B.rst (100%) rename content/{ => mono}/carte-mere-mono-C.rst (100%) rename content/{ => mono}/carte-mere-mono-D.rst (100%) rename content/{ => mono}/carte-mere-mono-E.rst (100%) rename content/{ => mono}/carte-mere-mono-commun.rst (100%) rename content/{ => mono}/carte-mere-mono-inventaire.rst (100%) rename content/{ => mono}/carte-mere-mono-soudure.rst (100%) rename content/{ => mono}/carte-mere-mono-synthese.rst (100%) rename content/{ => mono}/carte-mere-mono-test-afficheur.rst (100%) rename content/{ => mono}/carte-mere-mono-test-elec.rst (100%) rename content/{ => mono}/carte-mere-mono-tests.rst (100%) rename content/{ => mono}/carte-mere-mono.rst (100%) rename content/{ => mono}/carte-sortie-mono.rst (100%) rename content/{ => mono}/carte-sortie-relais-mono.rst (100%) rename content/{ => mono}/dissipateur-mono.rst (100%) rename content/{ => mono}/etalonnage-mono.md (100%) rename content/{ => mono}/test-logiciel-mono-requirements.rst (100%) rename content/{ => mono}/test-logiciel-mono.rst (100%) rename content/{ => mono}/test-mono-mesures.rst (100%) rename content/{ => tri}/assemblage_tri.md (100%) rename content/{ => tri}/boitier-tri.rst (100%) rename content/{ => tri}/carte-mere-tri.md (100%) rename content/{ => tri}/carte-sortie-relais-tri.rst (100%) rename content/{ => tri}/carte-sortie-tri.rst (100%) rename content/{ => tri}/dissipateur-tri.rst (100%) rename content/{ => tri}/etalonnage-tri.md (100%) rename content/{ => tri}/test-logiciel-tri.rst (100%) diff --git a/content/index.rst b/content/index.rst index dc269ea4..17d34cce 100644 --- a/content/index.rst +++ b/content/index.rst @@ -1,10 +1,9 @@ .. _mk2pvrouter: -************************************************ Bienvenue dans la documentation du Mk2PVRouter ! -************************************************ +================================================ -| Le MK2 PV Router est l’accessoire indispensable lorsque l’on souhaite optimiser son autoconsommation. +| Le MK2 PV Router est l’accessoire indispensable lorsque l’on souhaite optimiser son autoconsommation. | | Particulièrement adapté à l’alimentation de résistances (chauffe-eau, radiateur, sol chauffant) du fait de son alimentation à puissance variable, il saura orienter votre surplus vers le ou les équipements raccordés. | @@ -46,7 +45,7 @@ Bienvenue dans la documentation du Mk2PVRouter ! .. toctree:: :hidden: - introduction.md + introduction .. toctree:: :maxdepth: 3 diff --git a/content/introduction.md b/content/introduction.md deleted file mode 100644 index 73f1d4fc..00000000 --- a/content/introduction.md +++ /dev/null @@ -1,83 +0,0 @@ -(introduction)= - -# Introduction - -Cette documentation est applicable à toutes les versions du Mk2PVRouter, qu'elles soient monophasées ou triphasées.
-La majorité des informations sont pertinentes pour les deux versions.
-Chaque version a son propre chapitre. - ---- -## Contenu du kit - -Dans le kit, vous trouverez : -- le circuit imprimé ({term}`PCB`) de la carte-mère -- un ou plusieurs circuits imprimés pour chaque sortie -- des composants électroniques (résistances, condensateurs, …).
- Attention, certains sont sensibles à l'électricité statique, il faut donc les manipuler avec soin. -- un boîtier -- des câbles - ---- -## Étapes d'assemblage - -L'assemblage complet va nécessiter plusieurs étapes : -- soudure et tests de la carte-mère -- soudure et tests de la ou les cartes de sortie -- perçage du boîtier -- perçage du ou des dissipateurs thermiques -- montage des circuits soudés dans le boîtier -- confection des câbles -- câblage -- étalonnage -- programmation finale - ---- -## Recommandations pour les étapes de soudure - -Les composants nécessaires sont très variés. Certains sont passifs (comme les résistances), tandis que d'autres sont actifs (comme l'AtMega328P).
-Tous ces composants sont généralement sensibles à l'électricité statique.
-Il est donc important de les manipuler avec soin et, si possible, de se mettre à la terre pour éviter toute décharge électrostatique. - -Certains composants sont polarisés (comme les diodes et certains condensateurs), tandis que d'autres ne le sont pas (comme les résistances et certains condensateurs). Il est donc crucial de faire attention à l'orientation des composants AVANT de les souder. L'orientation est généralement indiquée directement sur la carte mère. - -Les composants varient également en taille, allant de quelques millimètres à plusieurs centimètres (dans le cas des transformateurs). - -Pour des raisons pratiques, il est recommandé de procéder à la soudure en suivant un ordre précis basé sur la taille des composants. - -Ainsi, l'ordre de soudure recommandé est le suivant : -1. Résistances et diodes, et éventuellement les ponts -2. Supports IC1 et IC2 (et éventuellement IC3, IC4 selon le kit) (ne pas insérer les circuits intégrés dans les supports à ce stade) -3. Condensateurs non polarisés "orange", oscillateur -4. Pont·s de diodes -5. Tous les connecteurs SIL noirs et le connecteur d'affichage, le cas échéant -6. Condensateurs polarisés (noirs ou bleus) -7. Le socle pour l'antenne, le cas échéant -8. Les gros connecteurs "haute tension" -9. Les porte-fusibles -10. Les régulateurs de tension -11. Enfin, les transformateurs - -Suivre cette séquence précise permet d'éviter de tordre les pattes des composants ou d'avoir à utiliser de l'adhésif, entre autres. - ---- -## Matériels nécessaires - -- fer à souder -- fil de soudure -- pince coupante -- pince à sertir les cosses ou pince multifonction -- tournevis cruciforme -- clé plate ou douille de **5,5** -- clé plate de **10** -- clé six pans de **2** et **2,5** -- une perceuse à colonne si possible, sinon n'importe quelle perceuse. -- foret métal de **3 mm** -- foret métal de **4 mm** -- foret (bois ou métal) de **8 mm** -- foret (bois ou métal) ou fraise de **20 mm** -- fraise de **35 mm** -- colle thermofusible -- gaine thermorétractable -- multimètre (au minimum voltmètre et ohmmètre) - -Certains matériels sont optionnels (fraise de 35, colle, gaine). Cependant, ils faciliteront certaines étapes et permettront de réaliser un travail plus soigné et bien fini. \ No newline at end of file diff --git a/content/introduction.rst b/content/introduction.rst new file mode 100644 index 00000000..bb20c7ee --- /dev/null +++ b/content/introduction.rst @@ -0,0 +1,87 @@ +.. _introduction: + +Introduction +============ + +| Cette documentation est applicable à toutes les versions du Mk2PVRouter, qu'elles soient monophasées ou triphasées. +| La majorité des informations sont pertinentes pour les deux versions. +| Chaque version a son propre chapitre. + +Contenu du kit +-------------- + +Dans le kit, vous trouverez : + +* le circuit imprimé ({term}`PCB`) de la carte-mère +* un ou plusieurs circuits imprimés pour chaque sortie +* des composants électroniques (résistances, condensateurs, …). + Attention, certains sont sensibles à l'électricité statique, il faut donc les manipuler avec soin. +* un boîtier +* des câbles + + +Étapes d'assemblage +------------------- + +L'assemblage complet va nécessiter plusieurs étapes : + +* soudure et tests de la carte-mère +* soudure et tests de la ou les cartes de sortie +* perçage du boîtier +* perçage du ou des dissipateurs thermiques +* montage des circuits soudés dans le boîtier +* confection des câbles +* câblage +* étalonnage +* programmation finale + +Recommandations pour les étapes de soudure +------------------------------------------ + +| Les composants nécessaires sont très variés. Certains sont passifs (comme les résistances), tandis que d'autres sont actifs (comme l'AtMega328P). +| Tous ces composants sont généralement sensibles à l'électricité statique. +| Il est donc important de les manipuler avec soin et, si possible, de se mettre à la terre pour éviter toute décharge électrostatique. + +Certains composants sont polarisés (comme les diodes et certains condensateurs), tandis que d'autres ne le sont pas (comme les résistances et certains condensateurs). Il est donc crucial de faire attention à l'orientation des composants AVANT de les souder. L'orientation est généralement indiquée directement sur la carte mère. + +Les composants varient également en taille, allant de quelques millimètres à plusieurs centimètres (dans le cas des transformateurs). + +Pour des raisons pratiques, il est recommandé de procéder à la soudure en suivant un ordre précis basé sur la taille des composants. + +Ainsi, l'ordre de soudure recommandé est le suivant : +#. Résistances et diodes, et éventuellement les ponts +#. Supports IC1 et IC2 (et éventuellement IC3, IC4 selon le kit) (ne pas insérer les circuits intégrés dans les supports à ce stade) +#. Condensateurs non polarisés "orange", oscillateur +#. Pont·s de diodes +#. Tous les connecteurs SIL noirs et le connecteur d'affichage, le cas échéant +#. Condensateurs polarisés (noirs ou bleus) +#. Le socle pour l'antenne, le cas échéant +#. Les gros connecteurs "haute tension" +#. Les porte-fusibles +#. Les régulateurs de tension +#. Enfin, les transformateurs + +Suivre cette séquence précise permet d'éviter de tordre les pattes des composants ou d'avoir à utiliser de l'adhésif, entre autres. + +Matériels/outils nécessaires +---------------------------- + +* fer à souder +* fil de soudure +* pince coupante +* pince à sertir les cosses ou pince multifonction +* tournevis cruciforme +* clé plate ou douille de **5,5** +* clé plate de **10** +* clé six pans de **2** et **2,5** +* une perceuse à colonne si possible, sinon n'importe quelle perceuse. +* foret métal de **3 mm** +* foret métal de **4 mm** +* foret (bois ou métal) de **8 mm** +* foret (bois ou métal) ou fraise de **20 mm** +* fraise de **35 mm** +* colle thermofusible +* gaine thermorétractable +* multimètre (au minimum voltmètre et ohmmètre) + +Certains matériels sont optionnels (fraise de 35, colle, gaine). Cependant, ils faciliteront certaines étapes et permettront de réaliser un travail plus soigné et bien fini. \ No newline at end of file diff --git a/content/mk2pvrouter.rst b/content/mk2pvrouter.rst new file mode 100644 index 00000000..3c5b0aaa --- /dev/null +++ b/content/mk2pvrouter.rst @@ -0,0 +1,13 @@ +.. _mk2pvrouter: + +Qu'est-ce qu'un routeur ? +========================= + +| Le régulateur de puissance ou **routeur solaire** permet d'optimiser l'autoconsommation de votre installation Photovoltaïque. +| Il détecte l'excédent d'électricité produit par vos panneaux photovoltaïques, et l'utilise pour alimenter différents appareils électriques. +| Un routeur solaire peut activer ces différents appareils comme la résistance de votre chauffe-eau, la station de recharge de votre voiture, la pompe à chaleur… + +| Le MK2 PV Router est l’accessoire indispensable lorsque l’on souhaite optimiser son autoconsommation. +| +| Particulièrement adapté à l’alimentation de résistances (chauffe-eau, radiateur, sol chauffant) du fait de son alimentation à puissance variable, il saura orienter votre surplus vers le ou les équipements raccordés. +| \ No newline at end of file diff --git a/content/assemblage_mono.md b/content/mono/assemblage_mono.md similarity index 100% rename from content/assemblage_mono.md rename to content/mono/assemblage_mono.md diff --git a/content/boitier-mono.rst b/content/mono/boitier-mono.rst similarity index 100% rename from content/boitier-mono.rst rename to content/mono/boitier-mono.rst diff --git a/content/carte-mere-mono-A.rst b/content/mono/carte-mere-mono-A.rst similarity index 100% rename from content/carte-mere-mono-A.rst rename to content/mono/carte-mere-mono-A.rst diff --git a/content/carte-mere-mono-B.rst b/content/mono/carte-mere-mono-B.rst similarity index 100% rename from content/carte-mere-mono-B.rst rename to content/mono/carte-mere-mono-B.rst diff --git a/content/carte-mere-mono-C.rst b/content/mono/carte-mere-mono-C.rst similarity index 100% rename from content/carte-mere-mono-C.rst rename to content/mono/carte-mere-mono-C.rst diff --git a/content/carte-mere-mono-D.rst b/content/mono/carte-mere-mono-D.rst similarity index 100% rename from content/carte-mere-mono-D.rst rename to content/mono/carte-mere-mono-D.rst diff --git a/content/carte-mere-mono-E.rst b/content/mono/carte-mere-mono-E.rst similarity index 100% rename from content/carte-mere-mono-E.rst rename to content/mono/carte-mere-mono-E.rst diff --git a/content/carte-mere-mono-commun.rst b/content/mono/carte-mere-mono-commun.rst similarity index 100% rename from content/carte-mere-mono-commun.rst rename to content/mono/carte-mere-mono-commun.rst diff --git a/content/carte-mere-mono-inventaire.rst b/content/mono/carte-mere-mono-inventaire.rst similarity index 100% rename from content/carte-mere-mono-inventaire.rst rename to content/mono/carte-mere-mono-inventaire.rst diff --git a/content/carte-mere-mono-soudure.rst b/content/mono/carte-mere-mono-soudure.rst similarity index 100% rename from content/carte-mere-mono-soudure.rst rename to content/mono/carte-mere-mono-soudure.rst diff --git a/content/carte-mere-mono-synthese.rst b/content/mono/carte-mere-mono-synthese.rst similarity index 100% rename from content/carte-mere-mono-synthese.rst rename to content/mono/carte-mere-mono-synthese.rst diff --git a/content/carte-mere-mono-test-afficheur.rst b/content/mono/carte-mere-mono-test-afficheur.rst similarity index 100% rename from content/carte-mere-mono-test-afficheur.rst rename to content/mono/carte-mere-mono-test-afficheur.rst diff --git a/content/carte-mere-mono-test-elec.rst b/content/mono/carte-mere-mono-test-elec.rst similarity index 100% rename from content/carte-mere-mono-test-elec.rst rename to content/mono/carte-mere-mono-test-elec.rst diff --git a/content/carte-mere-mono-tests.rst b/content/mono/carte-mere-mono-tests.rst similarity index 100% rename from content/carte-mere-mono-tests.rst rename to content/mono/carte-mere-mono-tests.rst diff --git a/content/carte-mere-mono.rst b/content/mono/carte-mere-mono.rst similarity index 100% rename from content/carte-mere-mono.rst rename to content/mono/carte-mere-mono.rst diff --git a/content/carte-sortie-mono.rst b/content/mono/carte-sortie-mono.rst similarity index 100% rename from content/carte-sortie-mono.rst rename to content/mono/carte-sortie-mono.rst diff --git a/content/carte-sortie-relais-mono.rst b/content/mono/carte-sortie-relais-mono.rst similarity index 100% rename from content/carte-sortie-relais-mono.rst rename to content/mono/carte-sortie-relais-mono.rst diff --git a/content/dissipateur-mono.rst b/content/mono/dissipateur-mono.rst similarity index 100% rename from content/dissipateur-mono.rst rename to content/mono/dissipateur-mono.rst diff --git a/content/etalonnage-mono.md b/content/mono/etalonnage-mono.md similarity index 100% rename from content/etalonnage-mono.md rename to content/mono/etalonnage-mono.md diff --git a/content/test-logiciel-mono-requirements.rst b/content/mono/test-logiciel-mono-requirements.rst similarity index 100% rename from content/test-logiciel-mono-requirements.rst rename to content/mono/test-logiciel-mono-requirements.rst diff --git a/content/test-logiciel-mono.rst b/content/mono/test-logiciel-mono.rst similarity index 100% rename from content/test-logiciel-mono.rst rename to content/mono/test-logiciel-mono.rst diff --git a/content/test-mono-mesures.rst b/content/mono/test-mono-mesures.rst similarity index 100% rename from content/test-mono-mesures.rst rename to content/mono/test-mono-mesures.rst diff --git a/content/assemblage_tri.md b/content/tri/assemblage_tri.md similarity index 100% rename from content/assemblage_tri.md rename to content/tri/assemblage_tri.md diff --git a/content/boitier-tri.rst b/content/tri/boitier-tri.rst similarity index 100% rename from content/boitier-tri.rst rename to content/tri/boitier-tri.rst diff --git a/content/carte-mere-tri.md b/content/tri/carte-mere-tri.md similarity index 100% rename from content/carte-mere-tri.md rename to content/tri/carte-mere-tri.md diff --git a/content/carte-sortie-relais-tri.rst b/content/tri/carte-sortie-relais-tri.rst similarity index 100% rename from content/carte-sortie-relais-tri.rst rename to content/tri/carte-sortie-relais-tri.rst diff --git a/content/carte-sortie-tri.rst b/content/tri/carte-sortie-tri.rst similarity index 100% rename from content/carte-sortie-tri.rst rename to content/tri/carte-sortie-tri.rst diff --git a/content/dissipateur-tri.rst b/content/tri/dissipateur-tri.rst similarity index 100% rename from content/dissipateur-tri.rst rename to content/tri/dissipateur-tri.rst diff --git a/content/etalonnage-tri.md b/content/tri/etalonnage-tri.md similarity index 100% rename from content/etalonnage-tri.md rename to content/tri/etalonnage-tri.md diff --git a/content/test-logiciel-tri.rst b/content/tri/test-logiciel-tri.rst similarity index 100% rename from content/test-logiciel-tri.rst rename to content/tri/test-logiciel-tri.rst From bab60af644487d80373ff13ddfee5aaed8d77a7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Metrich?= Date: Tue, 16 Jul 2024 18:40:04 +0200 Subject: [PATCH 2/3] build only on main --- .github/workflows/documentation.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 2308223d..cce0e853 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -1,7 +1,12 @@ # From: https://github.com/rkdarst/sphinx-actions-test/blob/master/.github/workflows/sphinx-build.yml name: Sphinx -on: [push, pull_request, workflow_dispatch] + push: + branches: [ main ] + pull_request: + branches: [ main ] + workflow_dispatch: + branches: [ main ] # If these SPHINXOPTS are enabled, then be strict about the builds and # fail on any warnings From e777edd608688bd3f8df622756528e1e03c4fe99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Metrich?= Date: Tue, 16 Jul 2024 18:45:07 +0200 Subject: [PATCH 3/3] Fix yaml --- .github/workflows/documentation.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index cce0e853..51273468 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -1,12 +1,14 @@ # From: https://github.com/rkdarst/sphinx-actions-test/blob/master/.github/workflows/sphinx-build.yml name: Sphinx +# Controls when the action will run. Triggers the workflow on push or pull request +# events but only for the main branch +on: push: branches: [ main ] pull_request: branches: [ main ] workflow_dispatch: - branches: [ main ] # If these SPHINXOPTS are enabled, then be strict about the builds and # fail on any warnings