Repository navigation
Description
Task
T-029· Milestone M2 — Scenario + kinematic2d · Size XS · Priority P0 · Epic #2Implements FR-SIM-001 · NFR-CFG-001
Branch
feat/t-029-kinematic2d-model-file-typed-schema— one task = one branch = one PR (doc 32 §6)
Summary
Define Kinematic2DModel (pydantic) with sections robot, lidar, depth, localization, costmap, planner, controller, version and ship configs/backends/kinematic2d_v1.yaml with the doc 10 §7.1 values.
Context / motivation
Robot/controller/planner constants must be configuration (calibrated in T-034), and defining all sections up front lets T-033a/b/c work in parallel without editing the same file.
Scope
In scope
backends/kinematic2d/model.pywith validation & units.- YAML values: footprint 0.17 m,
a_max=0.5,α_max=2, lidar 180 beams/360°/0.15–12 m, depth 60 beams/70°, inflation 0.35 m, replanning 1 Hz, lookahead 0.6 m, proximity slow-down 1 m, localisation gaink0,model_version(k2d_model_version, doc 33 §6).
Implementation guidance
- Path from
backends.kinematic2d.model_file. The model version is recorded in manifests and used by the comparability rule. - Standards: respect the layering contracts (doc 16 §2) and conventions in doc 34; no hard-coded tunables — thresholds/defaults come from typed settings (doc 27); no magic numbers (ruff
PLR2004); public APIs typed (mypy strict) and documented.
Configuration keys
From the configuration reference (doc 27). Keys marked (new) must be added to the typed settings models and appear in the generated reference (T-003c).
backends.kinematic2d.model_filebackends.kinematic2d.dtbackends.kinematic2d.lidar_beamsbackends.kinematic2d.depth_beams
Acceptance criteria
- YAML validates; every constant in doc 10 §7.1 present with unit.
- Invalid values rejected.
- Tests listed below added and green in CI; coverage of new code meets the gate in doc 18 §3.
- Docs, config reference and CHANGELOG
Unreleasedupdated where behaviour, keys or interfaces changed. - Definition of Done (doc 32 §3) satisfied.
Tests required
tests/unit/backends/kinematic2d/test_model.py.
Dependencies
Blocked by: #19 (T-003a)
Blocks: #51 (T-033a), #52 (T-033b), #53 (T-033c)
Parallelization notes
Files / paths owned by this task — avoid editing other paths; shared files (pyproject.toml entry points, cli/main.py, api/routers/__init__.py, router.tsx, docker/compose.yaml, ci.yml) are append-only:
backend/src/roboprobe/backends/kinematic2d/model.pyconfigs/backends/kinematic2d_v1.yaml
Small interface task for the k2d stream; merge before T-033a/b/c.
Definition of Done
Per doc 32 §3 and AGENTS.md §5: lint, format, mypy strict and import-linter green; tests added and passing; docs updated; PR template completed with Closes #<this issue>; Conventional Commit messages referencing T-029 (doc 16 §6); commits authored only by the repository owner identity (AGENTS.md §4); CI green; reviewer checklist (doc 32 §5.1) satisfied.
References
Design docs: doc 10 §7.1 · doc 27 §4.5 · doc 33 §6
Requirements: FR-SIM-001 · NFR-CFG-001 (traceability: doc 28)
Metadata
Metadata
Assignees
Labels
Projects
- StatusShow more project fieldsReady
Activity