Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

File structure refactoring draft #20

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

erikbosch
Copy link
Collaborator

@erikbosch erikbosch commented Feb 6, 2023

This PR shows a possible restructure of VSS files. Note - only signals previously part of the Vehicle folder has currently been refactored, old "large" folders like Body/Cabin/Powertrain has not been touched

This is the files refactored. The idea is to make it easy to find signals, like:

  • If you want to find Vehicle.CurrentLocation.GNSSReceiver.MountingPosition.X then you shall look in ./spec/Vehicle/CurrentLocation/GNSSReceiver/MountingPosition.vspec
  • If you want to find Vehicle.Speedyou should look in ./spec/Vehicle.vspec
Vehicle.vspec
Vehicle
  Acceleration.vspec
  AngularVelocity.vspec
  Connectivity.vspec
  CurrentLocation.vspec
  CurrentLocation
    GNSSReceiver.vspec
    GNSSReceiver
      MountingPosition.vspec
  Exterior.vspec
  LowVoltageBattery.vspec
  Service.vspec
  Trailer.vspec
  VehicleIdentification.vspec
  VersionVSS.vspec

Every vspec XXX.vspec file represents a branch and has the general structure:

XXX:
  type: branch

# Include sub-branches this way
#include XXX/SubBranch.vspec XXX
  
XXX.SomeSignal:
  datatype: boolean
  type: sensor
  description: .....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant