nc_program_manager/.paul/STATE.md
dtrentin f55d0b313b docs(12-docs-cli): complete CLI reference in README — all 16 args + 12 error codes
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-18 22:37:58 +02:00

7.3 KiB

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.3 complete — all phases done

Current Position

Milestone: v0.3 Code Quality — COMPLETE Phase: 12 of 12 (docs-cli) — Complete Plan: 12-01 complete Status: All milestones complete Last activity: 2026-05-18 — Phase 12 (docs-cli) complete

Progress:

  • Milestone v0.1: [██████████] 100% (complete)
  • Milestone v0.2: [██████████] 100% (complete)
  • Milestone v0.3: [██████████] 100% (complete)
  • Phase 11 (refactor): [██████████] 100% (complete)
  • Phase 12 (docs-cli): [██████████] 100% (complete)

Loop Position

PLAN ──▶ APPLY ──▶ UNIFY
  ✓        ✓        ✓     [Phase 12 complete — v0.3 milestone complete]

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.csPrintErrors(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

Deferred Issues

  • Heidenhain: ReadActiveProgramAsync / SelectMainProgram not implemented
  • Siemens: same as Heidenhain
  • Build + integration not verifiable on Linux (fwlib32 Windows-only)
  • MachineFingerprint WMI + full license flow — needs real Windows hardware test
  • private.key.xml owned by root — run sudo chown $USER ~/Documents/mine/c#/LicenseGenerator/private.key.xml

Blockers/Concerns

None — all milestones complete.

Git State

Last commit: bd17ea4 — feat(11-refactor): extract ArgParser, fix error handling, remove dead code LicenseGenerator repo: commit 2ef68dd — feat: initial LicenseGenerator Branch: main (pushed)

Session Continuity

Last session: 2026-05-18 Stopped at: v0.3 complete — all phases done Next action: No planned phases. Start new milestone or ship. Resume file: .paul/ROADMAP.md


STATE.md — Updated after every significant action