Shared interface design - experimental
EasyEDA Interfaces
Experimental dataclasses used by EasyEDA import and review workflows.
EasyEdaSchematicImportPolicy
Rationale
Schematic import behavior needs explicit pin and text policy.
Purpose
Configures EasyEDA-to-Altium schematic conversion.
Test Requirements
EasyEDA schematic tests must cover pin electrical and text policy.
Working Definition
Working when generated SchLib output follows selected policy.
EasyEdaSchematicImportResult
Rationale
Import callers need generated library and report references.
Purpose
Reports schematic import outputs.
Test Requirements
CLI tests must verify SchLib report and preview output.
Working Definition
Working when callers can locate generated schematic artifacts.
EasyEdaSchematicMappingReport
Rationale
EasyEDA schematic conversion needs transparent mapping diagnostics.
Purpose
Records converted and unsupported schematic features.
Test Requirements
CLI tests must verify report generation.
Working Definition
Working when unsupported source features are reported instead of hidden.
EasyEdaFootprintImportPolicy
Rationale
Footprint import needs explicit scale and geometry policy.
Purpose
Configures EasyEDA-to-Altium footprint conversion.
Test Requirements
Footprint tests must cover pads, holes, slots, curves, and previews.
Working Definition
Working when generated PcbLib geometry follows selected policy.
EasyEda3DModelPlacement
Rationale
Attaching the EasyEDA 3D model needs the STEP payload plus its EasyEDA placement (origin, z offset, rotation) carried into the footprint builder, which already owns the EasyEDA-to-Altium coordinate transform.
Purpose
Carries the downloaded STEP bytes and raw EasyEDA placement so the footprint builder can embed the model and attach it as a 3D body at the transformed location. After the attach, the builder measures how far the placed model bounds drifted from the footprint origin and reports a binary verdict (ok or needs_checking) so wrongly imported model geometry is flagged for manual review; detection only, the placement is never altered.
Test Requirements
Footprint import tests must cover that a placement attaches a 3D body at the transformed origin, that omitting it adds no body, that a model whose bounds land significantly far from the origin is flagged needs_checking with a report warning, and that unverifiable STEP bounds report ok with checked=false instead of guessing.
Working Definition
Working when the generated PcbLib footprint carries the embedded STEP model as a component body at the mapped placement and the report carries the binary placement verdict with its distance metrics.
EasyEdaFootprintImportResult
Rationale
Footprint import callers need generated library and report references.
Purpose
Reports footprint import outputs.
Test Requirements
CLI tests must verify PcbLib report and preview output.
Working Definition
Working when callers can locate generated footprint artifacts.
EasyEdaFootprintMappingReport
Rationale
Footprint conversion needs transparent mapping diagnostics.
Purpose
Records converted and unsupported footprint features.
Test Requirements
Footprint tests must verify report generation and unsupported handling.
Working Definition
Working when unsupported source geometry is reported instead of hidden.
EasyEdaPreviewArtifacts
Rationale
Preview generation emits multiple related files.
Purpose
Groups EasyEDA and Altium preview artifact paths.
Test Requirements
Preview tests must confirm SVG files are written.
Working Definition
Working when review and import commands can reference all preview files.
EasyEdaReviewRow
Rationale
Review reports need one row model per schematic case.
Purpose
Stores schematic review row data and preview snippets.
Test Requirements
Review tests must generate multi-case HTML and SVG output.
Working Definition
Working when rows render consistently in review artifacts.
EasyEdaFootprintReviewRow
Rationale
Review reports need one row model per footprint case.
Purpose
Stores footprint review row data and preview snippets.
Test Requirements
Footprint review tests must generate multi-case HTML and SVG output.
Working Definition
Working when rows render consistently in footprint review artifacts.
EasyEdaReviewArtifacts
Rationale
Review generation emits a related artifact set.
Purpose
Groups review HTML, SVG, and supporting output paths.
Test Requirements
Review tests must verify both HTML and SVG artifacts.
Working Definition
Working when callers can locate generated review outputs.