Velocitas Vehicle Model Generator

About

This generator creates a vehicle model from the given vspec specification for the target programming language.

Supported languages

• Python 3
• C++
• TypeScript (Node.js 18+, TypeScript 5.x)

TypeScript Code Generation Conventions

• Properties (PascalCase): Tree branch and leaf properties preserve VSS PascalCase naming (e.g. vehicle.Cabin.Seat.Row1.DriverSide.Position) to maintain 1:1 path fidelity with VSS signal definitions and consistency across Python, C++, and TypeScript SDKs.
• Methods (camelCase): SDK methods, collection accessors, and utility functions follow standard JavaScript/TypeScript camelCase conventions (e.g. get(), set(), subscribe(), row(), element(), createVehicle()).

HINT: C++ model generated by model generator versions >= 0.8.0 require C++ SDK versions >= 0.5.5 !

Supported VSS versions

Out of the box the following VSS versions are supported:

.vspec

• VSS 4.2.1
• VSS 5.x
• VSS 6.x

.json

• VSS 3.x
• VSS 4.x
• VSS 5.x
• VSS 6.x

Support for other vspec version might require changes to the baseline vspec files:

• 3.0, 3.1, 3.1.1: Convert legacy units.yaml entries to the vss-tools 6.0 schema and change type: Actuator to type: actuator in Powertrain/Battery.vspec. VSS 3.1 also needs a description for Vehicle.Body.Lights.Brake.
• 4.0: Convert legacy units.yaml entries to the vss-tools 6.0 schema.
• 4.1: In units.yaml, rename ml.description to ml.definition, kg.label to kg.unit, and months.units to months.unit.
• 5.1: In Vehicle/MotionManagement/Brake/Axle.vspec, change TorqueElectricMinimum.max from 0.0 to 0.

Usage

Invoke the src/velocitas/model_generator/cli.py script with the path to the vspec or json file you wish to generate code for, additionally passing include paths to directories which contain referenced vspec files. You need a units.yaml in the same directory. If you want to use the default one see here. For stability use release branch with tags. For example branch release/6.0.

python3 src/velocitas/model_generator/cli.py -I <path_to_dir_with_included_vspec_files> <path_to_your_vspec_file>

or

python3 src/velocitas/model_generator/cli.py <path_to_your_json_file>

Example

git clone -b v6.1 https://github.com/COVESA/vehicle_signal_specification.git
python3 src/velocitas/model_generator/cli.py -I ./vehicle_signal_specification/spec ./vehicle_signal_specification/spec/VehicleSignalSpecification.vspec

Or use VSCode Launch: Press F5, select Python or cpp and pass in the include directory and input file path.

Arguments

Contribution

• GitHub Issues
• Mailing List
• Contribution