Skip to content

README.md

Latest commit

 

History

History
60 lines (49 loc) · 3.28 KB

README.md

File metadata and controls

60 lines (49 loc) · 3.28 KB
Raw

Documentation

Start with the row that matches the job in front of you.

Task guides

Task Use this Result
Learn what the sensor does System overview Signal chain, modulation and boundaries
Set up and run the project Getting started KiCad, simulator and complete checks
Change code, parameters or CAD Development workflow Correct source, generator and acceptance gate
Fabricate or assemble hardware V0.1 Manufacturing JLC package and review checklist
Identify a hardware or software release Versioning Independent version/tag rules
Locate and place components Interactive BOM workflow Live KiCad-synced HTML BOM
Test a physical prototype Bring-up and test Testpoint sequence and pass evidence

Engineering references

Subject Reference
RMT versus MCPWM decision ADR-001
RMT field-to-datasheet traceability RMT traceability
Model and generator relationships Executable relationships
KiCad/SPICE net contract Connectivity contract
Threshold, testpoints and daylight filter Debug and threshold policy
Power model Power budget
Optional XIAO CAN interface CAN interface
JLC/Konnect setup Konnect and JLCPCB
Diode assembly polarity JLC diode orientation
Documentation design references Reference projects

Evidence and machine-readable data

Artifact Purpose
requirements/requirements.yaml Verifiable requirement statements
Verification matrix Requirement test and evidence mapping
datasheet_values.json Extracted limits used by checks
Sources Primary-source index
zotero_links.json Zotero keys and local attachments
Interactive HTML BOM Searchable board/part placement view
Technical simulator reference Compact live-model trace definitions
Hardware V0.1 panel image Ordered CAD R4 PCB
Schematic PDF Current generated schematic
Board STEP Mechanical exchange model

Information ownership

Each fact has one owner:

  • config/system.json owns tunable values.
  • hardware/connectivity.json owns electrical topology.
  • hardware/component_catalog.json owns part and procurement metadata.
  • hardware/ir_spoke_link/layout_manifest.json owns captured layout hashes.
  • requirements/requirements.yaml owns acceptance requirements.
  • project_manifest.json owns canonical paths and revision.

Other pages explain or link these values; they must not become independent configuration sources. tools/audit_project.py checks canonical paths, relative documentation links and index coverage.