SysML v2 model for an autonomous floor-cleaning robot. The model is used as an example for requirements traceability, subsystem architecture, behavior, verification, and analysis.
The workspace currently keeps one top-level package per .sysml file under model/ so private import PackageName::* resolves consistently across tools.
This repository gives systems engineers, tool builders, and educators a realistic SysML v2 corpus that is larger than a toy example but still small enough to read end to end.
It demonstrates how requirements, functional architecture, physical architecture, firmware allocation, safety analysis, verification, analysis cases, and stakeholder views can live together in one coherent model.
- Requirements-to-architecture-to-verification traceability across needs, system requirements, design elements, verification cases, and analyses.
- Functional and physical decomposition with explicit allocation layers.
- Implementation-facing interface control for PCB harnesses, software message contracts, firmware tasks, scheduler timing, and MCU deployment.
- Safety assurance, design trade studies, and technical margins instead of structure-only modeling.
- First-class SysML v2 views for context, structure, interconnections, behavior, traceability, safety, deployment, and rationale.
This model was built and validated using Spec42.
Spec42 is open source at elan8/spec42. Pull requests are also validated by the Spec42 GitHub Action in this repository.
The model imports packages from the SysML v2 standard library and from the Elan8 domain libraries, including the electronics-focused KPAR packages published in elan8/sysml-domain-libraries.
Spec42 resolves the required libraries in its validation workflow. If you open or validate this repository with another SysML v2 tool, make sure that tool has access to both the SysML v2 standard library KPAR and the Elan8 domain-library KPARs, or configure equivalent library search paths before loading model/.
- Stakeholder needs, derived system requirements, verification cases, and analysis evidence.
- Functional capabilities for locomotion, cleaning, perception, navigation, power, docking, safety, and user interaction.
- Physical assemblies with typed electronics harnesses, power rails, firmware deployment, and implementation-facing interface control.
- Operating lifecycle behavior, operational scenarios, safety analysis, trade studies, and canonical SysML v2 views.
- A selected privacy-conscious SLAM variant using 2D dToF/LiDAR, wheel odometry, IMU, cliff sensing, and short-range ToF sensing.
| Attribute | Value |
|---|---|
| BOM budget | 400 EUR |
| Mass budget | 5.0 kg |
| Battery capacity budget | 12500 mAh (12.5 Ah at 14.4 V nominal) |
| Localization error limit | 150 mm |
| Safe-stop reaction limit | 100 ms |
The limits are defined in DesignLimits.sysml and referenced by system requirements and analysis cases.
StakeholderNeeds.sysml- user needsSystemRequirements.sysml- derived system requirementsFunctionalArchitecture.sysml- capabilities and functional compositionPhysicalProtocols.sysml- electronics library imports and product bus aliasesProductContext.sysml- external actors and context boundaryElectricalInterfaces.sysml- PCB harness and connector recordsInterfaceControl.sysml- software message contractsFirmwareArchitecture.sysml- firmware tasks and scheduler timingPhysicalArchitecture.sysml- product assemblies and typed physical connectionsArchitectureAllocations.sysml- function, scenario, firmware, and MCU allocationsArchitecture.sysml- public architecture hub and system-level satisfy linksBehaviorStates.sysml- mission lifecycle statesOperationalScenarios.sysml- nominal and recovery mission flowsSafetyAnalysis.sysmlandTradeStudies.sysml- hazards and design rationaleModelViews.sysml- stakeholder viewsVerification.sysmlandAnalysisCases.sysml- V&V and engineering marginsAutonomousFloorCleaningRobotDemo.sysml- full workspace import hub
docs/MODEL_GUIDE.md- model layers, package map, and engineering threads.docs/MODEL_CONVENTIONS.md- naming, imports, comments, package ownership, and future folder structure.docs/VALIDATION.md- Spec42 setup, library paths, validation commands, and known tool notes.
- This is an engineering-grade showcase and validation corpus, not a certified product design or regulatory compliance package.
- The robot architecture is realistic enough for MBSE demonstration, but it is not a complete commercial robot-vacuum design.
- Generated documentation imagery is illustrative and not a product rendering from a manufactured device.
- The model currently keeps a flat
model/folder for broad tool compatibility; a folder split should be validated as a separate change.
Contributions are welcome. Please read CONTRIBUTING.md, follow docs/MODEL_CONVENTIONS.md, and run validation before opening a PR.
This repository is licensed under the MIT License. See NOTICE.md for trademark and showcase-disclaimer notes.
