Skip to content

Repository hygiene: one name for SIMUT, introduced as a universal monitor; the READMEs' stale counts - #329

Merged
angeloINTJ merged 4 commits into
mainfrom
chore/repo-hygiene-2026-11-07
Nov 7, 2026
Merged

angeloINTJ merged 4 commits into
mainfrom
chore/repo-hygiene-2026-11-07

Conversation

@angeloINTJ

Copy link
Copy Markdown
Owner

What

  • One name. The expansion of the acronym is Sistema Integrado de Monitoramento Universal e Telemetria everywhere: 124 source headers (@project), the login page's tagline (it lacked Integrado), the site's <title>/og:title and its Spanish dictionary (a third expansion, Monitorización), docs/_config.yml. The English and Spanish READMEs mark their expansions as glosses of a Portuguese name. tools/tft_ui/host/LangPackIndex_antes_B2b.h keeps the English: it is a byte-for-byte reference copy whose header says never to edit it.
  • Universal. The READMEs (three languages), the site, both manuals, the product manual's chapter 1, FEATURES, CONTRIBUTING and SECURITY introduce SIMUT as a universal monitor — a slot has no fixed quantity, a sensor type is a driver plus a channel-table row, the direction is more drivers and slots that actuate — and say that no image drives an output yet. The Ângulo's boot subtitle "Temperature and humidity monitor" becomes "Universal monitoring and telemetry" (new UA_TXT, hash b928c806 in both packs).
  • Stale counts in the READMEs. Eleven native suites (not ten / eight), the eleven firmware images in the environments table (four were missing), "six of the eleven" required images, the alpha's live LCD view (v2.14.0), the manual's 245 figures / 10 pending.
  • Changelog entry in both languages.

Measured

All eleven images built from zero through the pio shim against 6c8fff6 plus this change, -Werror holding, no warning from src/: used +8 B on pico_w_release (1,025,556 → 1,025,564), pico_w_test, pico_w_test_https, pico_w_asserts, pico_wire, pico_wiretft and pico2_w_original, .bin +8 B each (the ten bytes of Integrado in the login page's gzip); pico_w_alpha, pico_w_air, pico2_w_release and pico_wiretft_angulo unchanged in used and .bin. Budgets, .bin records and the OTA headroom table updated; check_flash_budget.py passes on the eleven and --table agrees.

The source-header rename is comment-only: git diff -U0 of those 124 files has no changed line outside * @project. The manual's generator reproduced the committed HTML byte for byte before the edit (instrument check), and the regenerated HTML differs from it in chapter 1's two paragraphs only.

Gates run locally: test_webui_minify 49/49, check_lang_packs, check_ui_texts, check_angulo (93 documents), check_readme_numbers, tft_ui/test_textos 105/105.

Not checked

Not run on a board: the Ângulo's boot subtitle and the login tagline were not seen on the Pico 2 W or the Pico W.

Done outside the diff (maintainer's decision, 2026-11-07)

Issues #118 and #57 closed with the reason in a comment; the ten remote branches merged since v2.14.0 and twenty clean worktrees of merged work removed (shas in scratchpad/higiene_20261107/); the GitHub description and topics now say what the README says.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Uy7K2qG2dULk2EBnwkCyZS

Ângelo Moisés Alves and others added 3 commits November 7, 2026 11:23
… and the Angulo's boot subtitle

The acronym stands for the Portuguese phrase, Sistema Integrado de
Monitoramento Universal e Telemetria, and the login page's own comment says
it is not translated. 124 file headers under src/, test/ and tools/ said
"@project SIMUT — Integrated Universal Monitoring and Telemetry System" while
46 said the Portuguese; all say the Portuguese now. The one left is
tools/tft_ui/host/LangPackIndex_antes_B2b.h, a byte-for-byte reference copy
whose header says never to edit it. The diff of those files is the @project
line and nothing else (git diff -U0, every changed line starts with " * @project").

The login page's tagline read "Sistema de Monitoramento Universal e
Telemetria", without "Integrado". The Angulo's boot screen said "Temperature
and humidity monitor" under the mark; it says "Universal monitoring and
telemetry" (UA_TXT, hash b928c806 in both packs, inserted in hash order:
"Monitoramento universal e telemetria", "Monitoreo universal y telemetria"),
because SIMUT is a universal monitor and the subtitle named the two quantities
its first drivers happen to read.

Flash, all eleven images built from zero through the pio shim of 2026-10-28
against 6c8fff6 plus this change, -Werror holding, no warning from src/:
used +8 B on pico_w_release (1,025,556 -> 1,025,564), pico_w_test,
pico_w_test_https, pico_w_asserts, pico_wire, pico_wiretft and
pico2_w_original, and the .bin of each +8 B (the ten bytes of "Integrado" in
the login page's gzip); pico_w_alpha, pico_w_air, pico2_w_release and
pico_wiretft_angulo equal in used and in .bin, the two Angulo images'
alignment absorbing the subtitle's two extra characters. The seven budgets,
the five .bin records and the OTA headroom table (PLANO_STABLE.md 3.1) are
updated; check_flash_budget.py passes on all eleven and --table agrees.
Gates run here: test_webui_minify (49/49), check_lang_packs, check_ui_texts,
tft_ui/test_textos (105/105). Not run on a board.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Uy7K2qG2dULk2EBnwkCyZS
… READMEs, the site, the manuals, FEATURES, CONTRIBUTING and SECURITY

Everywhere a reader first meets the system it was a temperature, humidity and
pressure meter. It is built to be universal: a slot has no fixed quantity, a
sensor type is a driver under src/sensors/ plus a row in the channel table,
three drivers ship and the table already has a row for luminosity none of
them fills, and the direction is more drivers and slots that actuate as well
as read. No image drives an output yet, and every text says so.

The three READMEs: the tagline, the overview (a new paragraph, "Universal is
the direction, not a feature"), "SIMUT is for you if", the hardware table
(Pico W, Pico 2 W and the Wire), the features (three drivers in an open
table; the alpha's live LCD view of v2.14.0), the project structure (net/,
ui/, the sensor host), the environments table (the eleven images, not seven;
eleven native suites, not eight), "How SIMUT is developed" (eleven suites,
six of the eleven images) and the product manual's row (245 figures, 10
pending, 2026-11-06). The architecture diagram names the Pico 2 W and the
Wire and the driver rule, every line still 60 columns in the three files.
The English and Spanish READMEs mark their expansions of the acronym as
glosses of a Portuguese name.

The site: <title> and og:title carry the name; the Spanish dictionary carried
a third expansion ("Monitorización"), the meta title and the colophon carry
the name now; the hero no longer says "Temperature monitoring"; "The
direction" section states the direction, in the three languages.
docs/_config.yml the same. The manuals' "What SIMUT is" (EN, pt-BR); the
product manual's chapter 1 ("Ainda não aciona equipamentos"), regenerated
with build_manual.py plus the row-class step, which reproduced the committed
HTML byte for byte before the edit and differs from it in those two
paragraphs after it. FEATURES (the channel table), CONTRIBUTING (a driver for
a part the firmware does not read yet is the contribution most wanted) and
SECURITY's context, in their languages.

Gates run here: check_angulo (93 documents), check_readme_numbers (883 cases
in 11 suites, 98.2 %, 170 codes, 63 routes in all three READMEs).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Uy7K2qG2dULk2EBnwkCyZS
@github-actions github-actions Bot added documentation Improvements or additions to documentation display Display, TFT, touchscreen, and themes i18n Internationalization and translations tools Build tools, scripts, and developer tooling security Security, authentication, and threat model code Firmware source changes (src/, WebUI.h) labels Nov 7, 2026
…, the figures' origin, the gloss lines, and the record of the direction

The review of this branch (contexto limpo, 2026-11-07) found four things to
correct and two to record:

- docs/_manual/cap11a-angulo.md still described the Angulo's boot screen with
  the subtitle this branch replaces; it says the new one, and what the screen
  said until today. The HTML is regenerated: the diff against the previous
  commit is chapter 1's paragraph and chapter 11A's, nothing else.
  tools/tft_ui/plano/PlanoTelasPainel.cpp and tools/tft_ui/ESPEC_UI_A.md keep
  the old subtitle: they are the record of the plan the driver was built
  from, not the product.
- "any quantity a driver is written for" contradicted the code: the channel
  table has CH_COUNT 4 of MAX_SENSOR_CHANNELS 8 (src/sensors/SensorChannels.h),
  channelMask is a uint8_t, and raising the ceiling is a flash-schema change.
  Chapter 1, the three READMEs (overview, hardware table, the diagram line)
  and FEATURES say "four of the eight rows", and that a sensor type is a
  driver and an entry in the type table while a new quantity is a row.
- "245 figures taken on the bench" was false for chapter 11A's 43 frames and
  the LCD's 17, drawn on the host (tools/tft_ui/manual_frames.py): the
  READMEs say "figures, screens and diagrams".
- "One name" was not uniform: 39 src/ headers, WebUI.h and platformio.ini kept
  an English gloss line under the Portuguese one. Removed; the diff of those
  files is that line and nothing else. The gloss lives in the READMEs.
- The direction (more drivers, slots that actuate) is the maintainer's,
  stated on 2026-11-07 for this change; the changelog records it and says no
  text promises a release or a date.
- The changelog's ".bin +8 B" for pico_w_test and pico_w_test_https, which
  have no record, now cites the journal's last sizes for them.

Verified: tools/tft_ui/test_idiomas.py 121 checks, 0 failed (the new
subtitle fits its box in the three languages). The eleven images rebuilt
from zero after these edits: 11 of 11 equal to the first build in used and
.bin (the edits are comments); the new subtitle is in the two Angulo .bin and
the old one is not; the tagline with "Integrado" is in the login page of
pico2_w_release as in pico_w_release's. check_angulo, check_readme_numbers,
test_manual_diagramas (884), test_webui_minify (49), check_lang_packs,
check_ui_texts and check_flash_budget (11 images, --table) pass.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Uy7K2qG2dULk2EBnwkCyZS
@angeloINTJ
angeloINTJ merged commit 124f031 into main Nov 7, 2026
15 checks passed
@angeloINTJ
angeloINTJ deleted the chore/repo-hygiene-2026-11-07 branch November 7, 2026 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code Firmware source changes (src/, WebUI.h) display Display, TFT, touchscreen, and themes documentation Improvements or additions to documentation i18n Internationalization and translations security Security, authentication, and threat model tools Build tools, scripts, and developer tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant