ecu-tests/config/examples.yaml
Hosam-Eldin Mostafa 582764d410 Mark legacy BabyLIN adapter as deprecated across code and docs
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>
2026-05-07 17:32:24 +02:00

54 lines
2.1 KiB
YAML

# Examples: Mock-only and (DEPRECATED) BabyLIN hardware configurations.
# For current MUM-based hardware setups, see config/mum.example.yaml.
#
# How to use (Windows PowerShell):
# # Point the framework to a specific config file
# $env:ECU_TESTS_CONFIG = ".\config\examples.yaml"
# # Run only mock tests
# pytest -m "not hardware" -v
# # Switch to the BabyLIN profile by moving it under the 'active' key or by
# # exporting a different file path containing only the desired profile.
#
# This file shows both profiles in one place; typically you'll copy the relevant
# section into its own YAML file (e.g., config/mock.yaml, config/babylin.yaml).
# --- MOCK PROFILE -----------------------------------------------------------
mock_profile:
interface:
type: mock
channel: 1
bitrate: 19200
flash:
enabled: false
hex_path:
# --- BABYLIN PROFILE (DEPRECATED) -------------------------------------------
# Retained for backward compatibility with existing BabyLIN rigs only. New
# setups should use config/mum.example.yaml.
# Requires: vendor/BabyLIN_library.py and platform libraries placed per vendor/README.md
babylin_profile:
interface:
type: babylin # deprecated
channel: 0 # SDK channel index (0-based)
bitrate: 19200 # Informational; SDF usually defines effective timing
node_name: ECU_TEST_NODE # Optional label
sdf_path: .\vendor\Example.sdf # Update to your real SDF path
schedule_nr: 0 # Start this schedule on connect
flash:
enabled: true
hex_path: C:\\Path\\To\\firmware.hex # Update as needed
# --- ACTIVE SELECTION -------------------------------------------------------
# To use one of the profiles above, copy it under the 'active' key below or
# include only that profile in a separate file. The loader expects the top-level
# keys 'interface' and 'flash' by default. For convenience, we expose a shape
# that mirrors that directly. Here is a self-contained active selection:
active:
interface:
type: mock
channel: 1
bitrate: 19200
flash:
enabled: false
hex_path: