diff --git a/README.md b/README.md index 16b59fd..aaa2007 100644 --- a/README.md +++ b/README.md @@ -18,18 +18,21 @@ writes; no Nextion software was decompiled. ## Status -| Area | Coverage | -|---|---| -| `.HMI` read / write / build from scratch | complete for Basic (T) and Intelligent (P) series projects; output byte-identical to Nextion Editor 1.68.2 | -| Checksums | all three (page, project header, file table) | -| Components | all 31 types, with the Editor's own defaults | -| Readable JSON | enum names and `#rrggbb` colours, still byte-exact on the way back | -| Pictures | Basic series format complete; Intelligent compressed format not yet | -| Fonts | black/white `.zi` v6 complete, incl. generation from TrueType; anti-aliased not yet | -| Rendering | pixel-identical for text, numbers, buttons, sliders, bars, checkboxes, pictures, waveform...; radio ~95 %, QR placeholder ([docs/RENDER.md](docs/RENDER.md)) | -| `.tft` compile | research: layout mapped, partial checksum support; not usable yet | +Every percentage is a count with a stated basis, so it can be checked (details in +[docs/COVERAGE.md](docs/COVERAGE.md)). -Details and the full list of gaps: [docs/COVERAGE.md](docs/COVERAGE.md). +| Area | Coverage | Basis | +|---|---|---| +| `.HMI` read / write / build from scratch | **100 %** of everything seen | every entry type in Editor-written files round-trips byte-identical; new projects open in the Editor | +| Checksums (`.HMI`) | **100 %** (3/3) | page, project header, file table | +| Component types (read, write, create) | **100 %** (31/31) | all types in the Editor's toolbox, incl. 11 Intelligent-only | +| Display series | **40 %** (2/5) | Basic (T) and Intelligent (P) confirmed; Discovery, Enhanced, Edge not sampled | +| Picture formats | **50 %** (1/2) | raw RGB565 (Basic) done; compressed format (Intelligent) not yet | +| Font modes | **50 %** (1/2) | black/white done (incl. TrueType import); anti-aliased not yet | +| Readable attribute names in JSON | **65 %** (20/31 types) | value lists taken from the Editor for all Basic types; Intelligent-only types still raw numbers | +| Rendering, Basic components | **85 %** (17/20 pixel-exact) | gauge ~99.5 %, radio ~95 %, QR code placeholder | +| Rendering, all components | **55 %** (17/31 pixel-exact) | Intelligent-only components not rendered yet | +| `.tft` compilation | **31 %** (2.5/8 milestones) | layout mapped, layout table decoded, trailer checksum (same-length edits only); not usable yet | ## Compatibility diff --git a/docs/COVERAGE.md b/docs/COVERAGE.md index f2e4a74..e859824 100644 --- a/docs/COVERAGE.md +++ b/docs/COVERAGE.md @@ -19,6 +19,20 @@ byte for byte, or a file written by nxhmi was opened in the Editor and showed th | New projects from scratch | `project.new_project(model)` for 12 Basic/Intelligent models; the generated demo is byte-identical to the Editor's re-save | | Compiling `.tft` firmware | **research only** -- not possible yet | +## How the percentages in the README are counted + +- **Display series**: 5 series in the Editor's model dialog (Basic, Discovery, Enhanced, + Intelligent, Edge); a series counts once its series byte and model ids are confirmed. +- **Picture formats**: `N.i` format byte 0 (raw) and 4 (compressed). +- **Font modes**: glyph mode black/white and anti-aliased. +- **Readable names**: component types whose attribute notes (value lists) were read from the Editor. +- **Rendering**: a component type counts as covered when every test case of it is pixel-identical + to the Editor canvas (name tags and selection outline excluded). Invisible types (timer, + variable, hotspot, touch cap) count when they draw nothing, like the Editor. +- **`.tft` milestones** (8): layout map; layout table; trailer checksum (half: same-length only); + the three header checksums; compiled page/component format; event-code tokens; pictures and fonts + in the TFT; a builder that produces a file the display accepts. + ## Covered in detail ### File container and integrity