60ce1c9d57
Phase 15 complete (2 plans):
- 15-01: NLog 5.2.8 + nlog.config (rolling file daily/7d + console); logger fields in
FanucMachine, HeidenhainMachine, SiemensMachine, MitsubishiMachine, Lsv2Client, Program.cs;
SetState event handler catches → _log.Warn; cleanup catches annotated; ISS-003/ISS-004 closed
- 15-02: All Console.Write/WriteLine in Program.cs replaced with _log.Info (103 calls);
nlog.config console target layout=${message}, levels=Info only — Warn/Error file-only;
operator console output identical; every interaction now timestamped in log file
Milestone v0.5 Operational Quality complete.
Co-Authored-By: Claude <noreply@anthropic.com>
194 lines
9.6 KiB
Markdown
194 lines
9.6 KiB
Markdown
# Project State
|
||
|
||
## Project Reference
|
||
|
||
See: .paul/PROJECT.md (updated 2026-05-18)
|
||
|
||
**Core value:** Machinists transfer CNC programs to/from any controller without manual steps or internet
|
||
**Current focus:** v0.5 complete — all milestones shipped; ready for v0.6 planning
|
||
|
||
## Current Position
|
||
|
||
Milestone: v0.5 Operational Quality — **Complete**
|
||
Phase: 15 of 15 (logging) — Complete
|
||
Plan: 15-02 complete
|
||
Status: Milestone complete — ready for v0.6 planning
|
||
Last activity: 2026-05-18 — Phase 15 complete; v0.5 milestone complete
|
||
|
||
Progress:
|
||
- Milestone v0.1: [██████████] 100% (complete)
|
||
- Milestone v0.2: [██████████] 100% (complete)
|
||
- Milestone v0.3: [██████████] 100% (complete)
|
||
- Milestone v0.4: [██████████] 100% (complete)
|
||
- Milestone v0.5: [██████████] 100% (complete)
|
||
- Phase 15: [██████████] 100%
|
||
|
||
## Loop Position
|
||
|
||
```
|
||
PLAN ──▶ APPLY ──▶ UNIFY
|
||
✓ ✓ ✓ [Loop complete — v0.5 milestone complete]
|
||
```
|
||
|
||
## What Was Built (v0.5 Operational Quality — complete)
|
||
|
||
### Phase 15 — Logging
|
||
- `nlog.config` — rolling file target (daily, 7-day archive) + console (`levels="Info"`, `${message}` layout); `throwConfigExceptions=true`
|
||
- `packages.config` / `NcProgramManager.csproj` — NLog 5.2.8 reference + Content/CopyAlways entry
|
||
- `FanucMachine.cs`, `HeidenhainMachine.cs`, `SiemensMachine.cs`, `MitsubishiMachine.cs` — logger field + SetState catch → `_log.Warn`; Dispose catches annotated
|
||
- `Lsv2Client.cs` — logger field + Info at connect/disconnect + cleanup catch annotations
|
||
- `Program.cs` — logger field + 3× `_log.Error` in catch blocks + 103× `_log.Info` (all Console.Write/WriteLine replaced); zero Console.Write/WriteLine remain
|
||
- ISS-003 closed; ISS-004 closed
|
||
|
||
## What Was Built (v0.4 Robustness — complete)
|
||
|
||
### Phase 14 — Test Hardening
|
||
- `NcProgramManager.Tests/Integration/HardwareTestHelper.cs` — `GetIpOrSkip(string)` calls `Assert.Ignore` when env var missing; ISS-007 closed
|
||
- `HeidenhainMachineIntegrationTests.cs`, `SiemensMachineIntegrationTests.cs`, `MitsubishiMachineIntegrationTests.cs` — `Hardware_ConnectAsync_RealMachine` + `[Category("Hardware")]` added to each
|
||
- `NcProgramManager.Tests/Unit/LicenseFileTests.cs` — 4 tests covering empty, whitespace, valid base64, nonexistent path
|
||
- `LicenseValidatorTests.cs` — `Validate_EmptyFingerprint_ReturnsFalse` added; ISS-008 scaffold complete
|
||
|
||
### Phase 13 — Robustness Fixes
|
||
- `Licensing/MachineFingerprint.cs` — null guards on both WMI reads (`?.Value?.ToString() ?? string.Empty`); ISS-001 closed
|
||
- `Licensing/LicenseValidator.cs` — `SHA256CryptoServiceProvider` in `using` block inside `Validate()`; ISS-005 closed
|
||
- `Cnc/Heidenhain/Lsv2Client.cs` — `Connect()` calls `_tcp.Close()` on timeout branch to abort pending socket; ISS-006 closed
|
||
|
||
## What Was Built (v0.3 Code Quality — complete)
|
||
|
||
### Phase 11 — Refactor
|
||
- `ArgParser.cs` — static class, `Parse(string[]) → InputArgs`; all CLI regex parsing extracted from Program.cs
|
||
- `Program.cs` — no static state; `Scarica`/`Invia` take explicit `InputArgs`; `VediErrore` takes `bool debugMode`
|
||
- `Program.cs` — try/finally with `connected` flag in `Scarica` and `Invia`; connection leak fixed
|
||
- `Program.cs` — `PrintErrors(IReadOnlyList<CncError>)` helper; `CncResult.Errors` printed on every failure
|
||
- `AesCrypt.cs` — deleted (dead code, no references)
|
||
|
||
### Phase 12 — Docs CLI
|
||
- `README.md` — params table expanded from 6 → 16 entries (all CLI args documented)
|
||
- `README.md` — codici errore section: 12 error codes with causa probabile + soluzione
|
||
|
||
## What Was Built (v0.1 Multi-CN Release)
|
||
|
||
### Phase 1 — CNC Abstraction
|
||
- Namespace: `Fanuc_integration.Cnc.*` → `FanucProgramManager.Cnc.*` (29 files)
|
||
- `IFocasDialect` extended: `UploadStart`/`DownloadStart` accept `short fileType`
|
||
- `IFanucMachine` created: extends `ICncMachine` with tool offset + work zero R/W
|
||
- `CncManufacturer` enum: Fanuc, Heidenhain, Siemens, Mitsubishi
|
||
- All 29 `Cnc/**/*.cs` files added to csproj
|
||
|
||
### Phase 2 — Heidenhain LSV2
|
||
- `HeidenhainConnectionConfig` — IP, port 19000, credentials, timeout
|
||
- `Lsv2Client` — TCP framing, CRC-16/CCITT, login (SELECT+LOG_IN), ReceiveFile/SendFile
|
||
- `HeidenhainMachine : ICncMachine` — RunGuardedAsync pattern, state machine
|
||
|
||
### Phase 3 — Siemens + Mitsubishi FTP
|
||
- `SiemensConnectionConfig` / `SiemensFtpClient` / `SiemensMachine : ICncMachine`
|
||
- `MitsubishiConnectionConfig` / `MitsubishiFtpClient` / `MitsubishiMachine : ICncMachine`
|
||
|
||
### Phase 4 — Wiring
|
||
- `CncMachineFactory` — creates right `ICncMachine` from `InputArgs`
|
||
- `InputArgs` — added `manufacturer`, `username`, `password` fields
|
||
- `Program.cs` — full rewrite using `ICncMachine`; Fanuc 3-file via `IFanucMachine` cast
|
||
|
||
### Phase 5 — NC Validator
|
||
- `ValidationSeverity` / `ValidationError` / `ValidationResult` model types
|
||
- `INcProgramValidator` + `NcProgramValidator` (5 universal + per-manufacturer rules)
|
||
- Validator injected into all 4 machine classes; upload blocked on Error severity
|
||
- `NcProgramValidatorTests` — 30+ NUnit tests
|
||
|
||
### Test Infrastructure
|
||
- `NcProgramManager.Tests/` — NUnit 3.13.3 + Moq 4.18.4, .NET 4.7.2
|
||
- `FtpServerStub` + `Lsv2ServerStub` — in-process TCP stubs
|
||
- Unit + integration tests; Fanuc FOCAS tests `[Ignore]`d (Windows-only DLL)
|
||
|
||
## What Was Built (v0.2 NcProgramManager — complete)
|
||
|
||
### Phase 06 — Rename Cleanup
|
||
- Namespace: `FanucProgramManager.*` → `NcProgramManager.*` (all files)
|
||
- Project renamed, test folder renamed, dead `FANUCMachine.cs` deleted
|
||
|
||
### Phase 07 — License Core
|
||
- `IMachineFingerprint` / `ILicenseValidator` interfaces
|
||
- `MachineFingerprint` — WMI CPU/BIOS fingerprint
|
||
- `LicenseFile.TryRead` — reads `.lic` file, returns base64 signature
|
||
- `LicenseValidator.Validate` — RSA-SHA256 verify
|
||
- `LicenseValidatorTests` — 6 unit tests (testable via internal ctor injection)
|
||
|
||
### Phase 08 — License Integration
|
||
- `Program.cs` — RSA check wired at startup; `checkLicense` deleted; `license.lic` next to EXE
|
||
- `InputArgs.cs` — `-chiave=` field removed
|
||
|
||
### Phase 09 — License Generator
|
||
- `LicenseGenerator` standalone console tool (separate repo: `ssh://git@3nt-git.duckdns.org:222/davide.trentin/license-generator.git`)
|
||
- Commands: `keygen` (RSA 2048-bit pair), `fingerprint` (WMI, Windows), `sign` (RSA-SHA256 → .lic)
|
||
- Real public key embedded in `Licensing/LicenseValidator.cs` (PLACEHOLDER removed)
|
||
- `private.key.xml` at `~/Documents/mine/c#/LicenseGenerator/` (gitignored — keep secure)
|
||
|
||
### Phase 10 — README Docs
|
||
- `README.md` in NcProgramManager root — Italian, operator-facing: CLI args, license setup, examples, controllers table
|
||
- `README.md` in LicenseGenerator repo — Italian, vendor-facing: keygen first-run, 4-step license issuance workflow, commands table, security
|
||
|
||
## CLI Args (current — all 16)
|
||
- `-azione=` — action (Scarica/Invia)
|
||
- `-manufacturer=fanuc|heidenhain|siemens|mitsubishi` (default: fanuc)
|
||
- `-ip=` — CNC IP (Ethernet)
|
||
- `-porta=` — port (Ethernet)
|
||
- `-tipo=` — connection type: 3=Ethernet, 2=HSSB (Fanuc legacy)
|
||
- `-nodo=` — HSSB node (Fanuc only)
|
||
- `-username=` (Heidenhain/Siemens/Mitsubishi)
|
||
- `-password=` (Heidenhain/Siemens/Mitsubishi)
|
||
- `-pathprogramma=` — local file path (required for Invia)
|
||
- `-path=` — CNC program path; default 1 = //CNC_MEM/USER/PATH1/
|
||
- `-workzero=` — include work zero offset
|
||
- `-tooloffset=` — include tool offset
|
||
- `-commento=` — program comment
|
||
- `-compatibility` — compatibility mode flag
|
||
- `-debug=` — keep terminal open after operation
|
||
- `-help` — show help and exit
|
||
- License: place `license.lic` next to EXE (no CLI arg)
|
||
|
||
## Accumulated Context
|
||
|
||
### Decisions
|
||
- .NET 4.7.2 locked — max compatibility
|
||
- RSA asymmetric offline licensing: private key vendor-only, public key embedded in binary
|
||
- `license.lic` always at `AppDomain.CurrentDomain.BaseDirectory` — no CLI override
|
||
- `RSACryptoServiceProvider` + `SHA256CryptoServiceProvider` (not HashAlgorithmName) — .NET 4.7.2 compat
|
||
- Constructor injection pattern: internal ctor accepts key XML — testable without Windows WMI
|
||
- LicenseGenerator: standalone separate repo — vendor tool, never shipped to customers
|
||
- Heidenhain: LSV2 port 19000, needs real hardware testing
|
||
- Siemens: FTP `/_N_MPF_DIR/`, needs Sinumerik FTP option enabled on machine
|
||
- `#` = Warning in Fanuc/Mitsubishi — macro variable indicator
|
||
- NLog console target `levels="Info"`, `${message}` layout — all operator output through NLog; Warn/Error file only
|
||
- Cleanup catches: comment-only, no log — Dispose must not throw; logging infra can fail
|
||
|
||
### Deferred Issues
|
||
Tracked in `.paul/ISSUES.md` — 11 issues total; 7 closed (ISS-001, ISS-003, ISS-004, ISS-005, ISS-006, ISS-007, ISS-008 partial).
|
||
|
||
Key open items:
|
||
- ISS-002: Blocking .GetAwaiter().GetResult() — Medium, refactor
|
||
- ISS-008: Full closure needs real Windows hardware run with env vars set
|
||
- ISS-009/010: Heidenhain/Siemens ReadActiveProgram not implemented — deferred
|
||
- `private.key.xml` owned by root (external repo) — run `sudo chown $USER ~/Documents/mine/c#/LicenseGenerator/private.key.xml`
|
||
|
||
### Blockers/Concerns
|
||
None — v0.5 complete.
|
||
|
||
### Git State
|
||
Last commit: (Phase 15 commit — see below after git commit)
|
||
LicenseGenerator repo: commit `2ef68dd` — feat: initial LicenseGenerator
|
||
Branch: main
|
||
|
||
## Codebase Mapped
|
||
|
||
Date: 2026-05-18
|
||
Documents: `.paul/codebase/` (7 files — STACK, ARCHITECTURE, STRUCTURE, CONVENTIONS, TESTING, INTEGRATIONS, CONCERNS)
|
||
|
||
## Session Continuity
|
||
|
||
Last session: 2026-05-18
|
||
Stopped at: v0.5 milestone complete — Phase 15 both plans done
|
||
Next action: /paul:milestone for v0.6
|
||
Resume file: .paul/ROADMAP.md
|
||
|
||
---
|
||
*STATE.md — Updated after every significant action*
|