Sitelet https://github.com/qoretechnologies/module-vss
Skip to content

Repository files navigation

Qore COVESA VSS Module
======================

Introduction
------------
The Qore VSS module provides support for the COVESA Vehicle Signal
Specification (VSS), the industry-standard data model for vehicle signals.

This module includes:
  - VssLoader: Native .vspec file parsing (including #include directives,
    instance expansion, overlay merging), pre-exported VSS JSON/YAML loading,
    data validation against VSS catalogs, and extensible unit conversion
  - VssDataProvider: Qorus DataProvider integration for browsable VSS catalog
    navigation, signal metadata retrieval, data validation, and pipeline data
    processors for telemetry normalization, unit conversion, and enrichment

Requirements
------------
  - Qore 2.0+
  - yaml module (for YAML/vspec parsing)
  - DataProvider module (for VssDataProvider)

License
-------
This module is released under the MIT license; see COPYING.MIT for details.
The derived COVESA test fixture test/data/vss_v6_subset.yaml is under MPL-2.0;
see its attribution and COPYING.MPL-2.0.

Building
--------
  mkdir build
  cd build
  cmake .. -DCMAKE_INSTALL_PREFIX=/usr
  make
  sudo make install

Testing
-------
  export QORE_MODULE_DIR=qlib:${QORE_MODULE_DIR}
  qore test/VssLoader.qtest -vv
  qore test/VssValidator.qtest -vv
  qore test/VssUnitConverter.qtest -vv
  qore test/VssDataProvider.qtest -vv
  qore test/VssProcessors.qtest -vv
  qore test/VssReadDataProvider.qtest -vv
  qore test/VssRecordIterators.qtest -vv

Documentation
-------------
Run `cmake --build build --target docs` after configuring with Doxygen available.
Open build/docs/vss/html/index.html for the overview and release notes, with links
to both module API references. The Qore SDK's module documentation indexes provide
links to DataProvider, reflection, JSON and YAML APIs without network access.
The overview and API pages share the SDK's Qore theme, header, and favicon.
After building, run `python3 test/test_docs.py build/docs -v` to check the rendered
theme assets, license, and cross-module links.

Author
------
Qore Technologies, s.r.o. (david@qore.org)

About

Qore COVESA VSS module

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages