From 2e232d82a863c18f5859a6469e8433aff5401fcc Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 28 Aug 2026 01:45:47 +0000 Subject: [PATCH] Remove all MoTeC references from code comments and docs Reword every mention of MoTeC (the brand, Dash Manager, C125, CAN Inspector) in source comments, README, DESIGN.md, FIRMWARE-NOTES.md, help pages, and .gitignore to neutral phrasing, keeping each sentence's technical meaning intact. Comment/doc-only change; no code behavior affected. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_011jEf8kyshzNwufqcGtfat7 --- docs/validation-report.md | 4 ++-- firmware/include/protocol.h | 6 +++--- gui/.gitignore | 2 +- gui/DESIGN.md | 15 +++++++-------- gui/FIRMWARE-NOTES.md | 2 +- gui/README.md | 12 ++++++------ gui/help/pages/validation-report.html | 6 +++--- gui/src/main.cpp | 2 +- gui/src/model/access_keys.h | 2 +- gui/src/model/channel.h | 2 +- gui/src/model/comms_types.h | 2 +- gui/src/model/config_report.cpp | 2 +- gui/src/model/config_report.h | 2 +- gui/src/model/secure_file.h | 4 ++-- gui/src/protocol/asc_log.h | 6 +++--- gui/src/ui/access_passwords_dialog.h | 4 ++-- gui/src/ui/communications_dialog.cpp | 4 ++-- gui/src/ui/config_summary_dialog.h | 2 +- gui/src/ui/counters_dialog.h | 1 - gui/src/ui/edit_channel_dialog.cpp | 2 +- gui/src/ui/main_window.cpp | 5 ++--- gui/src/ui/main_window.h | 2 +- gui/src/ui/math_dialog.cpp | 2 +- gui/src/ui/section_editor_dialog.cpp | 6 +++--- gui/src/ui/timers_dialog.cpp | 2 +- gui/src/ui/timers_dialog.h | 2 +- gui/test/test_roundtrip.cpp | 2 +- 27 files changed, 50 insertions(+), 53 deletions(-) diff --git a/docs/validation-report.md b/docs/validation-report.md index 84f24f7..2550494 100644 --- a/docs/validation-report.md +++ b/docs/validation-report.md @@ -1,6 +1,6 @@ # Validation & the Config Summary -The firmware validates almost nothing, so the application is the safety layer. Two File-menu commands report on the open document: **Check Channels** runs the validation rules and lists every finding with a severity, and **Config Summary…** produces a printable MoTeC-style Channel Summary Report of everything the configuration defines. +The firmware validates almost nothing, so the application is the safety layer. Two File-menu commands report on the open document: **Check Channels** runs the validation rules and lists every finding with a severity, and **Config Summary…** produces a printable Channel Summary Report of everything the configuration defines. ## Check Channels @@ -53,7 +53,7 @@ A message marked **Hidden** or **Protect Communication** withholds its detail fr ## Config Summary… -To produce a report of the whole configuration, choose File → Config Summary…. The window shows a column-aligned Channel Summary Report in the style of the MoTeC tools, with these sections: +To produce a report of the whole configuration, choose File → Config Summary…. The window shows a column-aligned Channel Summary Report with these sections: - **Summary Information** — file name, title, date, application version, and whether the document has unsaved changes. - **Configuration Comments** — the document's comment text. - **CAN Bus Setup** — per-bus mode, bit rate, FD data rate and termination. diff --git a/firmware/include/protocol.h b/firmware/include/protocol.h index 742fd67..8a7d083 100644 --- a/firmware/include/protocol.h +++ b/firmware/include/protocol.h @@ -41,7 +41,7 @@ * documented on MathConfig below. * * v19 replaces the single configuration password with THREE per-function access - * keys, mirroring MoTeC's "Online > Set Access Passwords": one for sending a + * keys, exposed in the GUI as "Online > Set Access Passwords": one for sending a * configuration, one for getting one back, one for revealing and editing * protected communications. Each is a 4-byte key the host folds out of a typed * password (PBKDF2, fixed application salt) and proves by challenge-response; @@ -147,7 +147,7 @@ * alongside the config it names. (v7 also moved the config tables into a * flash-resident image so they no longer occupy RAM — that is internal to the * firmware and does not change the wire format.) - * v6 adds a Constants table (0x14/0x15): a MoTeC-style calculation that writes + * v6 adds a Constants table (0x14/0x15): a calculation that writes * a fixed value to a generated channel every evaluation pass. Each entry names * a destination signal slot and the constant float; the engine applies them * before math so downstream calculations see them. @@ -161,7 +161,7 @@ * message has not been received within that timeout (0 = feature off). * v3 unifies receive and transmit into ONE message table (direction is a flag * on each message; transmit messages carry a period), and adds up/down - * counters (0x10/0x11) and timers (0x12/0x13) as MoTeC-style calculations. + * counters (0x10/0x11) and timers (0x12/0x13) as calculations. * v2 added CONTROL_CAN / STREAM_VALUES and framed all device output (telemetry * + logs); those are unchanged. * diff --git a/gui/.gitignore b/gui/.gitignore index 1e1cb6c..d68b3e4 100644 --- a/gui/.gitignore +++ b/gui/.gitignore @@ -18,5 +18,5 @@ __pycache__/ .claude/ CMakeLists.txt.user -# Proprietary-tool exports kept locally as fixtures (MoTeC log etc.) +# Proprietary-tool exports kept locally as fixtures reference files/ diff --git a/gui/DESIGN.md b/gui/DESIGN.md index 346a328..92a9709 100644 --- a/gui/DESIGN.md +++ b/gui/DESIGN.md @@ -1,9 +1,8 @@ # CAN Triple Device Manager — Design A Qt 6 (C++/Widgets) desktop application for configuring the CAN Triple gateway -(STM32G473CBT6, 3× CAN) over the ST-Link virtual COM port. Layout and -navigation deliberately mirror **MoTeC C125 Dash Manager** (verified against -the real application, v6.51, on this machine). +(STM32G473CBT6, 3× CAN) over the ST-Link virtual COM port, with a classic +dash-manager layout and navigation. ## 1. Serial link (as implemented by the firmware in `../src`) @@ -485,8 +484,8 @@ rather than its extension, so a `.ct3s` can never be parsed as JSON. door, no copy held anywhere. A lost password is a lost configuration, and the save dialog says so before the fact. -This mirrors MoTeC's "Hide setup information" / "Require access password for use" -pair on a locked comms template, for the same reasons. +This is the classic "Hide setup information" / "Require access password for use" +pairing on a locked comms template, for the same reasons. **File layout** — all multi-byte integers LITTLE-ENDIAN. @@ -877,7 +876,7 @@ that password either, which is the trade its author made. - **File**: New, Open…, Save, Save As…, **Save Secure Config…** (the binary `.ct3s`), Check Channels (live validation report with unused-channel cleanup), - Config Summary… (MoTeC-style Channel Summary Report via + Config Summary… (Channel Summary Report via `src/model/config_report.*` — usage analysis incl. incomplete/unused channels, print / PDF / text export), Reveal / Conceal Protected Communications, recent files, Exit. Document = one config file: `*.ct3` indented JSON by @@ -1238,7 +1237,7 @@ that password either, which is the trade its author made. Configuration, Monitor Channels **F3** (live grid from value stream), CAN Viewer (raw frame monitor + inject-frame form; buffers up to 10M frames and exports them as a Vector ASCII `.asc` log via "Save to File…" — classic - frames as the MoTeC-style line, CAN FD frames as Vector `CANFD` lines carrying + frames as standard lines, CAN FD frames as Vector `CANFD` lines carrying real BRS and ESI), Load Device Config from Flash, Clear Device Config, Device Status, **Upload Configuration…**, **Set Access Passwords…** and **Fleet Identity…**. All three need a connection: the uploader has a device to check @@ -1261,7 +1260,7 @@ that password either, which is the trade its author made. - **Tools → Connection Settings…** — COM port list (ST-Link VCP highlighted), baud (default 7,372,800), Connect/Disconnect. -## 3. Channel & scaling model (MoTeC semantics, mapped to firmware) +## 3. Channel & scaling model (mapped to firmware) **Signal record.** `CanSignalConfig` is **64 bytes** and `MAX_SIGNALS` is **1000**. The history is worth knowing, because the record has been both ways: diff --git a/gui/FIRMWARE-NOTES.md b/gui/FIRMWARE-NOTES.md index 818b3ae..6a5cce0 100644 --- a/gui/FIRMWARE-NOTES.md +++ b/gui/FIRMWARE-NOTES.md @@ -44,7 +44,7 @@ firmware unlocks a cleaner protocol; none block basic use. 3. **No periodic transmit composer.** The routing engine can receive, parse, route, and inject, but there is no engine that *composes* frames from - signal values and transmits them cyclically — MoTeC-style "Transmit + signal values and transmits them cyclically — "Transmit Message" sections have nothing to run on. Suggest a `TransmitMessageConfig` table (can_id, bus, rate, signal packing list) serviced from `events_100Hz`/`events_50Hz`. *GUI behavior: transmit sections can be diff --git a/gui/README.md b/gui/README.md index c8e0afb..2cbaded 100644 --- a/gui/README.md +++ b/gui/README.md @@ -1,8 +1,8 @@ # CAN Triple Device Manager A Windows desktop configurator for the [CAN Triple](https://github.com/mitchdetailed/CAN_Triple) -gateway (STM32G473CBT6, 3× CAN), styled after **MoTeC C125 Dash Manager** — -same layout and navigation for communications, messages, and channels. +gateway (STM32G473CBT6, 3× CAN), with a classic dash-manager layout and +navigation for communications, messages, and channels. Talks to the device over the ST-Link virtual COM port (USART1, PB6/PB7, 7,372,800 baud — ST-Link **V3** required for that rate). Built and released @@ -62,7 +62,7 @@ rules, 8 integrators, and Counters**, **Constants**, and **Tables** grid editors, each mapping onto the matching firmware table. A constant is a custom channel carrying a fixed value the firmware writes every evaluation pass. **Tables** are - MoTeC-style lookups — 8× 2x16 (one axis, up to 16 sites) and 8× **8x8** + lookup tables — 8× 2x16 (one axis, up to 16 sites) and 8× **8x8** (X + Y axes, up to 8 sites each, 64 cells) — with each axis Interpolated or Discrete (centered); the looked-up value drives a generated output channel. - **Online** — Send Configuration (F5, chunked + read-back verified, applies @@ -73,7 +73,7 @@ rules, 8 integrators, and Passwords…** and **Fleet Identity…**. Get also reads the buses' modes, rates and termination back off the device via `CMD_READ_CAN_SETUP`, so the document reflects what the buses are actually running, not an assumption. -- **Online → Set Access Passwords…** — MoTeC-style function passwords held +- **Online → Set Access Passwords…** — function passwords held **in the device**: Send a Configuration, Get a Configuration, and **Protected Comms with four slots** (any slot opens, so one unit can accept sealed configurations from several suppliers; only Slot 1 also updates the open @@ -139,7 +139,7 @@ rules, 8 integrators, and and when); the firmware validates almost nothing, so the GUI enforces the rules (see `FIRMWARE-NOTES.md`). Also lists **unused channels** (orphans left after removing messages) and offers **Remove Unused Channels** cleanup. -- **File → Config Summary…** — MoTeC-style Channel Summary Report: summary +- **File → Config Summary…** — Channel Summary Report: summary info, comments, bus setup, used channels, channels by function (per-message Generates/From and Uses/For tables with the DBC extraction detail, compound Id[n] groups, calculations), incomplete channels, unused channels — with @@ -201,7 +201,7 @@ Firmware: `pio run` (and `pio run -t upload`) inside `firmware/` — see ## Documents -- `DESIGN.md` — UI inventory, protocol spec, MoTeC→firmware mapping rules. +- `DESIGN.md` — UI inventory, protocol spec, UI→firmware mapping rules. - `FIRMWARE-NOTES.md` — firmware findings the GUI works around (flash sizing, unimplemented commands, Motorola extraction, UART burst limits…), with suggested fixes. diff --git a/gui/help/pages/validation-report.html b/gui/help/pages/validation-report.html index 8debc7f..cb9be95 100644 --- a/gui/help/pages/validation-report.html +++ b/gui/help/pages/validation-report.html @@ -11,7 +11,7 @@

Validation & the Config Summary

The firmware validates almost nothing, so the application is the safety layer. Two File-menu commands report on the open document: Check Channels runs the validation rules and lists every finding with a -severity, and Config Summary… produces a printable MoTeC-style Channel +severity, and Config Summary… produces a printable Channel Summary Report of everything the configuration defines.

Check Channels

@@ -138,8 +138,8 @@

Marked messages in the report

Config Summary…

To produce a report of the whole configuration, choose File → Config -Summary…. The window shows a column-aligned Channel Summary Report in the -style of the MoTeC tools, with these sections:

+Summary…. The window shows a column-aligned Channel Summary Report +with these sections: