Skip to content

docs: configurateur du firmware triphasé - #157

Open
FredM67 wants to merge 10 commits into
mainfrom
feat/configurateur
Open

FredM67 wants to merge 10 commits into
mainfrom
feat/configurateur

Conversation

@FredM67

@FredM67 FredM67 commented Oct 2, 2026 •

Copy link
Copy Markdown
Owner

What

Publishes the firmware configurator of the 3-phase router at https://fredm67.github.io/Mk2PVRouter/configurateur/ and documents it.

The configurator's code and tests stay in the firmware repository (FredM67/PVRouter-3-phase#183, configurator/). There, a CI check fails a firmware PR that changes config.h until the configurator follows. This site only publishes it, from the 3-phase submodule, so the online version always matches the documented firmware.

Changes

  • content/conf.py: a build-finished hook copies 3-phase/configurator/*.{html,css,js} into configurateur/ of the HTML output. If the submodule has no configurator yet, it logs a warning and skips the copy, so the build never breaks.
  • New page firmware/configurateur-triphase.rst (in the « Logiciel & Étalonnage » menu): what the configurator does, how to use it, the mk2Wifi YAML and its fail-safe controls.
  • Links to it from:
    • the 3-phase firmware configuration step (firmware-triphase.inc.rst);
    • the mk2Wifi installation page;
    • the Home Assistant note in principe-fonctionnement.rst, which also keeps the gist link.
  • documentation.yaml: the 3-phase submodule (and .gitmodules) are no longer in paths-ignore, so bumping the submodule republishes the configurator.

Merge order

  1. Merge feat: configurator web page for the router, remote units and mk2Wifi PVRouter-3-phase#183 into dev, then dev into main.
  2. Bump the 3-phase submodule here to that main, in this PR or right after it.

Merged before the bump, nothing breaks: the build warns that it found no configurator, but the new page links to a URL that doesn't exist yet.

Tested locally

  • sphinx-build -b dirhtml with the submodule on the configurator branch: configurateur/ holds the page, and the new page renders.
  • No new warning. The ones left are local only: renders from the hardware submodule not checked out, and drawio not installed.

🤖 Generated with Claude Code

Also fixed

firmware-triphase.inc.rst described settings the 3-phase firmware does not have: OLD_PCB (1-phase only) is replaced by PCB_VERSION (FredM67/PVRouter-3-phase#184). The load map, startup priorities, temperature sensing (TEMP_SENSOR_PRESENT, temperatureSensing, no address scan in the firmware) and the file tree now match the current config.h.

firmware-monophase.inc.rst had the same stale examples (file tree, physicalPin_dump_load, dumpLoad_startup_sequence, TEMP_ENABLED, sensor_list): now as in the 1-phase config.h (its OLD_PCB part was right). common/moniteur-serie.inc.rst no longer says the router lists the probe addresses: it points to the OneWire DS18x20_Temperature example. Temperature sensing only builds on the 1-phase firmware once FredM67/PVRouter-1-phase#21 is merged.

The configurator of the 3-phase firmware lives with its firmware (3-phase/configurator, tested
there against the shipped config files). It is published here, from the submodule, at
/configurateur/: the online version always matches the documented firmware.

- conf.py copies the page (html, css, js) into the HTML output after the build, and warns if
  the submodule has no configurator yet;
- new page firmware/configurateur-triphase, linked from the 3-phase firmware configuration,
  the mk2Wifi installation and the Home Assistant note;
- the Sphinx workflow no longer ignores the 3-phase submodule, so a bump republishes it.

Co-Authored-By: Claude <noreply@anthropic.com>
FredM67 and others added 9 commits October 2, 2026 16:40
PCB_VERSION instead of OLD_PCB (which only exists in the 1-phase
firmware), the load map, the startup priorities, temperature sensing
and the file tree, as in the current config.h.

Co-Authored-By: Claude <noreply@anthropic.com>
Neither firmware scans for probes or has TEMP_ENABLED any more: read
the addresses with the OneWire library's DS18x20_Temperature example.

Co-Authored-By: Claude <noreply@anthropic.com>
The load map, the startup priorities, temperature sensing and the file
tree, as in the current 1-phase config.h.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant