Hosam-Eldin Mostafa
582764d410
The MUM (Melexis Universal Master) adapter is the current default; the
BabyLIN SDK adapter is retained only for backward compatibility with
existing rigs.
Code:
- Emit DeprecationWarning when BabyLinInterface is instantiated and
when tests/conftest.py routes interface.type=='babylin' to it.
- Update module/class docstrings in ecu_framework/{__init__,config,
lin/__init__,lin/babylin}.py to label BabyLIN-specific fields and
paths as deprecated.
Config / scripts / pytest:
- pytest.ini: relabel the babylin marker as deprecated.
- config/{babylin.example,examples,test_config}.yaml: add deprecation
banners and field comments.
- scripts/99-babylin.rules and scripts/pi_install.sh: annotate the
udev-rule install block as legacy-only.
Documentation:
- TESTING_FRAMEWORK_GUIDE.md, docs/08_babylin_internals.md, and
vendor/README.md: prepend explicit "DEPRECATED" banners.
- docs/{README,01,02,04,05,07,09,10,12,13,14,15,18,DEVELOPER_COMMIT_
GUIDE}.md: relabel "legacy" to "deprecated" where babylin is
mentioned, present MUM as the primary path, and steer new work
toward the MUM examples.
No tests, configs, or modules were deleted; existing BabyLIN setups
keep working but now produce a clear DeprecationWarning at runtime.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
32 lines
2.1 KiB
Markdown
32 lines
2.1 KiB
Markdown
# Documentation Index
|
|
|
|
A guided tour of the ECU testing framework. Start here:
|
|
|
|
1. `01_run_sequence.md` — End-to-end run sequence and call flow
|
|
2. `02_configuration_resolution.md` — How configuration is loaded and merged
|
|
3. `03_reporting_and_metadata.md` — How test documentation becomes report metadata
|
|
4. `11_conftest_plugin_overview.md` — Custom pytest plugin: hooks, call sequence, and artifacts
|
|
5. `04_lin_interface_call_flow.md` — LIN abstraction and adapter behavior (Mock, MUM, and the deprecated BabyLIN)
|
|
6. `05_architecture_overview.md` — High-level architecture and components
|
|
7. `06_requirement_traceability.md` — Requirement markers and coverage visuals
|
|
8. `07_flash_sequence.md` — ECU flashing workflow and sequence diagram
|
|
9. `08_babylin_internals.md` — BabyLIN SDK wrapper internals and call flow (DEPRECATED)
|
|
10. `16_mum_internals.md` — MUM (Melexis Universal Master) adapter internals and call flow
|
|
11. `17_ldf_parser.md` — LDF parser, `ldf` fixture, and per-frame `pack`/`unpack` helpers
|
|
12. `18_test_catalog.md` — Per-test catalog: purpose, markers, hardware needs, expected result
|
|
13. `DEVELOPER_COMMIT_GUIDE.md` — What to commit vs ignore, commands
|
|
14. `09_raspberry_pi_deployment.md` — Run on Raspberry Pi (venv, service, hardware notes)
|
|
15. `10_build_custom_image.md` — Build a custom Raspberry Pi OS image with the framework baked in
|
|
16. `12_using_the_framework.md` — Practical usage: local, hardware (MUM, or the deprecated BabyLIN), CI, and Pi
|
|
17. `13_unit_testing_guide.md` — Unit tests layout, markers, coverage, and tips
|
|
18. `14_power_supply.md` — Owon PSU control, configuration, tests, and quick demo script
|
|
19. `15_report_properties_cheatsheet.md` — Standardized keys for record_property/rp across suites
|
|
|
|
Related references:
|
|
|
|
- Root project guide: `../README.md`
|
|
- Full framework guide: `../TESTING_FRAMEWORK_GUIDE.md`
|
|
- BabyLIN placement and integration: `../vendor/README.md` (deprecated; only relevant for legacy rigs)
|
|
- MUM source scripts and protocol details: `../vendor/automated_lin_test/README.md`
|
|
- PSU quick demo and scripts: `../vendor/Owon/`
|