Skip to content

Latest commit

 

History

History
31 lines (29 loc) · 3.45 KB

README.md

File metadata and controls

31 lines (29 loc) · 3.45 KB

EmbSIM documentation

Where What
Component library Named parts, categories, source status, model limits and executable fixtures
Interactive library Explorer, next named batch, electrical models, four circuit examples and regression commands
Arrange your workspace Global controls, panel resizing/folding and compact-window navigation
Visual Benchmark v0.1 The redesign: review, design system, default workspaces, settings, English and French, verification and limits
Workspace layout Responsive navigation, constrained panel resizing and saved preferences
Bench loading Optional renderer loading, recovery and measured production bundle sizes
Named package geometry Reviewed SOT-23/SOT-223 bodies, terminal identity and mechanical representation limits
Manufacturer source review Reviewed PDF revisions, package facts and remaining qualification gaps
STATUS.md What is implemented and with what evidence: the only support matrix
coverage.md Each MCU's peripherals and whether the engine models them (generated by tools/catalog/coverage.py)
Visual workbench benchmark Competitor evidence, current 3D bench audit and proposed visual quality gates
Live schematic workbench Live symbols/controls, PWM exposure, differential observations and remaining completion gates
Proteus schematic survey 83 documented capture/simulation capabilities, source-backed gaps and proposed live-schematic acceptance circuits
gallery/ Screenshots of the workbench at each milestone
architecture/ Vision, system architecture, engines, MCU runtime, workbench, decision records, roadmap, open questions, reuse assessment
specs/ SPEC-001 to SPEC-014: the contracts
requirements/ Numbered requirements with verification methods
engineering/ Repository workflow, required checks, coding standard, evidence rules; what each milestone built (M0, M1, M2, M3, M4, M5)
Timing fidelity The audit of the simulator's timing, the accuracy model each target is held to, the plan, and what is validated
Bench instruments The Logic 8, the PPK2 and the DS1054Z: wiring them, their front panels docked or floating, what each measures
Physical bench 3D inspection, named wiring, keyboard construction, recovery and geometry limits
user/ Getting started, firmware (run, build, debug), the command line, CI, diagnostics codes; the Python client
CODING-STANDARD.md Rules every C file follows

Reading order for a new contributor: STATUS, architecture 01 and 02, the specification for the area you touch, its requirements group, the coding standard.