Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ All notable changes to SIMUT firmware.

## Unreleased

**SIMUT has one name, and says what it is.** The expansion of the acronym is *Sistema Integrado de Monitoramento Universal e Telemetria* in every language: the Portuguese phrase is what the letters stand for, and it is not translated, as the login page's own comment has said since the wordmark went in. The site's `<title>`, the site's Spanish dictionary, 124 source headers and the login page's tagline did not follow that rule; they do now. And the system is introduced as what it is built to be, a universal monitor: the READMEs, the site, the manuals, FEATURES, CONTRIBUTING, SECURITY and the Ângulo's boot screen no longer present SIMUT as a temperature-and-humidity meter. No behaviour changes.

- **The name.** 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 (`tools/tft_ui/host/LangPackIndex_antes_B2b.h`, a byte-for-byte reference copy whose header says never to edit it, keeps the English), and the English gloss line that 39 `src/` headers, `WebUI.h` and `platformio.ini` carried under the Portuguese one is gone: one name, glossed only where a reader first meets it, in the READMEs. The login page's tagline read "Sistema de Monitoramento Universal e Telemetria", without *Integrado*. The site's `<title>` and `og:title` carried the English expansion, and its Spanish dictionary a third one, *Monitorización*; both carry the name now, `docs/_config.yml` too, and the English and Spanish READMEs mark their expansions as glosses of a Portuguese name.
- **Universal.** In the three READMEs the tagline, the overview, "SIMUT is for you if", the hardware table, the features and the project structure say that a slot has no fixed quantity, that a sensor type is a driver and an entry in the type table and a new quantity a row in the channel table (four of the eight it has room for are used: `CH_COUNT` 4, `MAX_SENSOR_CHANNELS` 8 in `src/sensors/SensorChannels.h`), that three drivers ship and the table already has a row for luminosity that none of them fills, that the direction is more drivers and slots that actuate as well as read, and that no image drives an output yet. That direction is the maintainer's, stated on 2026-11-07 for this change; no text promises a release or a date for it. The architecture diagram names the Pico 2 W and the Wire. The site's hero no longer says "Temperature monitoring", and its *The direction* section states the direction; the manuals' "What SIMUT is", the product manual's chapter 1 ("Ainda não aciona equipamentos", regenerated: the HTML differs from the committed one in those two paragraphs only), FEATURES, CONTRIBUTING (a driver for a part the firmware does not read yet is the contribution most wanted) and SECURITY's context say the same.
- **The Ângulo's boot screen** said "Temperature and humidity monitor" under the mark; it says "Universal monitoring and telemetry" (`UA_TXT`, hash `b928c806` in both packs: "Monitoramento universal e telemetria", "Monitoreo universal y telemetría"); `tools/tft_ui/test_idiomas.py`, which holds the Ângulo's texts to their boxes in the three languages, passes (121 checks). The product manual's chapter 11A says the new subtitle, and what the screen said until today. `tools/tft_ui/plano/PlanoTelasPainel.cpp` and `tools/tft_ui/ESPEC_UI_A.md` keep the old one: they are the record of the plan the driver was built from, not the product. Not seen on a board.
- **Numbers the READMEs had wrong.** Eleven native suites, not ten (the project structure) nor eight (the environments table); the environments table lists the eleven firmware images, not seven (`pico2_w_original`, `pico_wire`, `pico_wiretft` and `pico_wiretft_angulo` join it); the "six firmware images" among the required checks are six of the eleven; the alpha's live LCD view (`GET /api/lcd`, v2.14.0) is in the features; the product manual's row says 245 figures, screens and diagrams (chapter 11A's 43 and the LCD's 17 are drawn on the host, not captured), 10 pending (2026-11-06).
- **Flash.** All eleven images built from zero through the pio shim against 6c8fff60 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 (`pico_w_test` and `pico_w_test_https`, exempt from the record, against the journal's last sizes for them, 1,040,660 and 1,042,652 B), for 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 equality is alignment, not an unchanged image: the new subtitle is in the two Ângulo `.bin` and the old one is not, and the tagline with *Integrado* is in the login page of `pico2_w_release` as in `pico_w_release`'s. Built twice, the second time after the review's comment-only edits: 11 of 11 equal in `used` and in `.bin`. The seven budgets, the five `.bin` records and the OTA headroom table are updated. Not run on a board.
- **The repository.** Issues #118 (the Air without mDNS, by the decision the issue itself offered) and #57 (the README's header: the wordmark, since 2026-08-18) closed; the ten remote branches merged since v2.14.0 and twenty clean worktrees of merged work removed; the GitHub description and topics say what the README says.

**The manual's Sumário lands on the chapter it names.** Tapping or clicking an entry of the table of contents of `docs/MANUAL.pt-BR.html` stopped short of its chapter, often by thousands of pixels. The 207 screenshots went into the page without a width and a height, so each one was 0 px tall until it decoded: the smooth scroll aimed at where the chapter was, the figures it passed on the way decoded and grew, and the chapter moved down the page while the scroll ended where it had aimed. On a phone the panel's 117 figures and the LCD's 17 stayed 0 px tall even with the size, because the rule for screens under 600 px gave them a width of 100 % of a frame that is as wide as what it holds. `tools/build_manual.py` now writes each PNG's width and height on its `<img>`, and that rule keeps those figures at their width in px, fitted to the column by the `max-width` they already had.

- Measured in Chrome through Playwright, a fresh page for each of the 35 entries, read when the scroll had rested for 1.5 s: before, 31 entries ended more than 1 px short, as a Pixel 7 by up to 23,672 px (chapter 13, on the published page) and at 1280 × 800 by up to 50,574 px (chapter 18), each by what its chapter had moved down; after, all 35 within 1 px on both. Chapters 1 to 4, with no screenshot above them, were already right.
Expand Down
9 changes: 9 additions & 0 deletions CHANGELOG.pt-BR.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ Todas as mudanças notáveis do firmware SIMUT.

## Não lançado

**O SIMUT tem um nome só, e diz o que é.** A expansão da sigla é *Sistema Integrado de Monitoramento Universal e Telemetria* em todos os idiomas: a frase em português é o que as letras significam, e não se traduz, como o comentário da própria página de login diz desde que o wordmark entrou. O `<title>` do site, o dicionário espanhol do site, 124 cabeçalhos de código e a legenda da página de login não seguiam essa regra; agora seguem. E o sistema é apresentado como aquilo para que foi feito, um monitor universal: os READMEs, o site, os manuais, o FEATURES, o CONTRIBUTING, o SECURITY e a tela de boot do Ângulo não apresentam mais o SIMUT como um medidor de temperatura e umidade. Nenhum comportamento muda.

- **O nome.** 124 cabeçalhos de arquivo em `src/`, `test/` e `tools/` diziam `@project SIMUT — Integrated Universal Monitoring and Telemetry System` enquanto 46 diziam o português; todos dizem o português agora (o `tools/tft_ui/host/LangPackIndex_antes_B2b.h`, uma cópia de referência byte a byte cujo cabeçalho manda nunca editá-la, mantém o inglês), e a linha de glosa em inglês que 39 cabeçalhos de `src/`, o `WebUI.h` e o `platformio.ini` levavam sob a linha em português saiu: um nome só, glosado apenas onde o leitor o encontra pela primeira vez, nos READMEs. A legenda da página de login dizia "Sistema de Monitoramento Universal e Telemetria", sem *Integrado*. O `<title>` e o `og:title` do site levavam a expansão em inglês, e o dicionário espanhol dele uma terceira, *Monitorización*; os dois levam o nome agora, o `docs/_config.yml` também, e os READMEs em inglês e em espanhol marcam as expansões deles como glosas de um nome em português.
- **Universal.** Nos três READMEs, a legenda, a visão geral, o "O SIMUT é para você se", a tabela de hardware, os recursos e a estrutura do projeto dizem que um slot não tem grandeza fixa, que um tipo de sensor é um driver e uma entrada na tabela de tipos e uma grandeza nova uma linha na tabela de canais (quatro das oito que ela comporta estão em uso: `CH_COUNT` 4, `MAX_SENSOR_CHANNELS` 8 em `src/sensors/SensorChannels.h`), que três drivers embarcam e a tabela já tem uma linha para luminosidade que nenhum deles preenche, que a direção é mais drivers e slots que acionam além de ler, e que nenhuma imagem aciona uma saída ainda. Essa direção é do mantenedor, declarada em 07/11/2026 para esta mudança; nenhum texto promete release ou data para ela. O diagrama de arquitetura nomeia o Pico 2 W e o Wire. O herói do site não diz mais "Monitoramento de temperatura", e a seção *A direção* dele enuncia a direção; o "O que é o SIMUT" dos manuais, o capítulo 1 do manual do produto ("Ainda não aciona equipamentos", regenerado: o HTML difere do commitado só nesses dois parágrafos), o FEATURES, o CONTRIBUTING (um driver para uma peça que o firmware ainda não lê é a contribuição mais desejada) e o contexto do SECURITY dizem o mesmo.
- **A tela de boot do Ângulo** dizia "Temperature and humidity monitor" sob a marca; diz "Universal monitoring and telemetry" (`UA_TXT`, hash `b928c806` nos dois pacotes: "Monitoramento universal e telemetria", "Monitoreo universal y telemetría"); o `tools/tft_ui/test_idiomas.py`, que prende os textos do Ângulo às suas caixas nos três idiomas, passa (121 checagens). O capítulo 11A do manual do produto diz o subtítulo novo, e o que a tela dizia até hoje. O `tools/tft_ui/plano/PlanoTelasPainel.cpp` e o `tools/tft_ui/ESPEC_UI_A.md` mantêm o antigo: são o registro do plano de que o driver nasceu, não o produto. Não vista numa placa.
- **Números que os READMEs tinham errados.** Onze suítes nativas, não dez (a estrutura do projeto) nem oito (a tabela de ambientes); a tabela de ambientes lista as onze imagens de firmware, não sete (entram `pico2_w_original`, `pico_wire`, `pico_wiretft` e `pico_wiretft_angulo`); as "seis imagens de firmware" entre os checks obrigatórios são seis das onze; a visualização ao vivo do LCD da alpha (`GET /api/lcd`, v2.14.0) está nos recursos; a linha do manual do produto diz 245 figuras, entre telas e diagramas (as 43 do capítulo 11A e as 17 do LCD são desenhadas no host, não capturadas), 10 pendentes (06/11/2026).
- **Flash.** As onze imagens compiladas do zero pelo shim do pio contra 6c8fff60 mais esta mudança, com o `-Werror` valendo e nenhum aviso de `src/`: `used` +8 B em `pico_w_release` (1.025.556 → 1.025.564), `pico_w_test`, `pico_w_test_https`, `pico_w_asserts`, `pico_wire`, `pico_wiretft` e `pico2_w_original`, e o `.bin` de cada uma +8 B (`pico_w_test` e `pico_w_test_https`, isentas do registro, contra os últimos tamanhos delas no diário, 1.040.660 e 1.042.652 B), pelos dez bytes de *Integrado* no gzip da página de login; `pico_w_alpha`, `pico_w_air`, `pico2_w_release` e `pico_wiretft_angulo` iguais em `used` e em `.bin`. A igualdade é alinhamento, não imagem sem mudança: o subtítulo novo está nos dois `.bin` Ângulo e o antigo não, e a legenda com *Integrado* está na página de login do `pico2_w_release` como na do `pico_w_release`. Compiladas duas vezes, a segunda depois das edições só de comentário da revisão: 11 de 11 iguais em `used` e em `.bin`. Os sete orçamentos, os cinco registros de `.bin` e a tabela da folga de OTA estão atualizados. Não rodado numa placa.
- **O repositório.** As issues #118 (o Air sem mDNS, pela decisão que a própria issue oferecia) e #57 (o cabeçalho do README: o wordmark, desde 18/08/2026) fechadas; os dez ramos remotos mergeados desde a v2.14.0 e vinte worktrees limpas de trabalho mergeado removidos; a descrição e os tópicos do GitHub dizem o que o README diz.

**O Sumário do manual leva ao capítulo que nomeia.** Tocar ou clicar numa entrada do sumário do `docs/MANUAL.pt-BR.html` parava antes do capítulo, muitas vezes milhares de pixels antes. As 207 capturas entravam na página sem largura e altura, e cada uma tinha 0 px de altura até ser decodificada: a rolagem suave mirava onde o capítulo estava, as figuras do caminho decodificavam e cresciam, e o capítulo descia na página enquanto a rolagem terminava onde tinha mirado. No celular, as 117 figuras do painel e as 17 do LCD continuavam com 0 px de altura mesmo com o tamanho, porque a regra das telas de menos de 600 px dava a elas largura de 100 % de uma moldura que tem a largura do que contém. O `tools/build_manual.py` agora escreve a largura e a altura de cada PNG na sua `<img>`, e essa regra mantém essas figuras na largura em px, ajustadas à coluna pelo `max-width` que já tinham.

- Medido no Chrome pelo Playwright, uma página nova para cada uma das 35 entradas, lida quando a rolagem ficava 1,5 s parada: antes, 31 entradas paravam mais de 1 px antes do capítulo, como um Pixel 7 até 23.672 px antes (capítulo 13, na página publicada) e em 1280 × 800 até 50.574 px (capítulo 18), cada uma o quanto o seu capítulo tinha descido; depois, as 35 a menos de 1 px nas duas. Os capítulos 1 a 4, sem captura acima deles, já acertavam.
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.es-ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[English](CONTRIBUTING.md) | [Português](CONTRIBUTING.pt-BR.md) | **Español**

¡Gracias por tu interés en contribuir! SIMUT es un firmware IoT de código abierto para la Raspberry Pi Pico W. Así es como puedes ayudar.
¡Gracias por tu interés en contribuir! SIMUT — Sistema Integrado de Monitoramento Universal e Telemetria — es un firmware de código abierto de monitoreo y telemetría para la Raspberry Pi Pico W y la Pico 2 W. Está hecho para ser universal: un tipo de sensor es un driver en `src/sensors/`, y un driver para una pieza que el firmware aún no lee es la contribución que más quiere ([docs/adding-a-new-sensor.md](docs/adding-a-new-sensor.md), en inglés). Así es como puedes ayudar.

## Antes de empezar

Expand All @@ -15,7 +15,7 @@ Busca los issues etiquetados como [`good first issue`](https://github.com/angelo

| Habilidad | Ejemplos de issues |
|-------|---------------|
| C/C++ embedded | Pruebas de HistoryCodec, pruebas del analizador CLI, fuzz testing |
| C/C++ embedded | Un driver de sensor para una pieza nueva, pruebas de HistoryCodec, pruebas del analizador CLI, fuzz testing |
| Python / DevOps | Entorno de desarrollo Docker, integración continua (CI) con cppcheck, pre-commit hooks |
| Documentación / i18n | Mejoras de documentación, insignias de validación social |
| Diseño | Nuevo tema de color integrado |
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**English** | [Português](CONTRIBUTING.pt-BR.md) | [Español](CONTRIBUTING.es-ES.md)

Thanks for your interest in contributing! SIMUT is an open-source IoT firmware for the Raspberry Pi Pico W. Here's how you can help.
Thanks for your interest in contributing! SIMUT — Sistema Integrado de Monitoramento Universal e Telemetria — is open-source monitoring and telemetry firmware for the Raspberry Pi Pico W and Pico 2 W. It is meant to be universal: a sensor type is a driver under `src/sensors/`, and a driver for a part the firmware does not read yet is the contribution it most wants ([docs/adding-a-new-sensor.md](docs/adding-a-new-sensor.md)). Here's how you can help.

## Before You Start

Expand All @@ -15,7 +15,7 @@ Look for issues labeled [`good first issue`](https://github.com/angeloINTJ/simut

| Skill | Example issues |
|-------|---------------|
| C/C++ embedded | HistoryCodec tests, CLI parser tests, fuzz testing |
| C/C++ embedded | A sensor driver for a new part, HistoryCodec tests, CLI parser tests, fuzz testing |
| Python / DevOps | Docker dev environment, cppcheck CI, pre-commit hooks |
| Documentation / i18n | Documentation improvements, social proof badges |
| Design | New built-in color theme |
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.pt-BR.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[English](CONTRIBUTING.md) | **Português** | [Español](CONTRIBUTING.es-ES.md)

Obrigado pelo interesse em contribuir! O SIMUT é um firmware IoT open-source para Raspberry Pi Pico W. Veja como ajudar.
Obrigado pelo interesse em contribuir! O SIMUT — Sistema Integrado de Monitoramento Universal e Telemetria — é um firmware open-source de monitoramento e telemetria para o Raspberry Pi Pico W e o Pico 2 W. Ele foi feito para ser universal: um tipo de sensor é um driver em `src/sensors/`, e um driver para uma peça que o firmware ainda não lê é a contribuição que ele mais quer ([docs/adding-a-new-sensor.md](docs/adding-a-new-sensor.md), em inglês). Veja como ajudar.

## Antes de Começar

Expand All @@ -15,7 +15,7 @@ Procure issues com a label [`good first issue`](https://github.com/angeloINTJ/si

| Habilidade | Exemplos de issues |
|------------|-------------------|
| C/C++ embarcado | Testes do HistoryCodec, testes do CLI parser, fuzz testing |
| C/C++ embarcado | Um driver de sensor para uma peça nova, testes do HistoryCodec, testes do CLI parser, fuzz testing |
| Python / DevOps | Ambiente Docker, cppcheck CI, pre-commit hooks |
| Documentação / i18n | Melhorias de documentação, badges de prova social |
| Design | Novo tema de cores integrado |
Expand Down
Loading
Loading