Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Vector SIL Kit
# Contributing to the SIL Kit Project

Welcome and thank you for your interest in contributing to the Vector SIL Kit
Welcome and thank you for your interest in contributing to the SIL Kit
open source project.

We are sorry, but at the moment, we do not accept external contributions until
Expand Down
14 changes: 7 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
================================
The Vector SIL Kit
The SIL Kit Project
================================
.. |VectorSite| image:: https://img.shields.io/badge/vector-sil--kit-red
:target: https://vector.com/sil-kit
Expand All @@ -26,11 +26,11 @@ The Vector SIL Kit
| |AsanBadge| |UbsanBadge| |TsanBadge| |Linux/Arm64|
| |WinBadge|

The Vector SIL Kit is an open-source library for connecting Software-in-the-Loop Environments.
This README is intended to provide you with quick start on how to build the Vector SIL Kit.
The SIL Kit is an open-source library for connecting Software-in-the-Loop Environments.
This README is intended to provide you with quick start on how to build the SIL Kit.

For documentation on using the Vector SIL Kit, see the HTML documentation,
which can be generated when building the Vector SIL Kit (cf. Customizing the
For documentation on using the SIL Kit, see the HTML documentation,
which can be generated when building the SIL Kit (cf. Customizing the
Build) and is provided in pre-built form with the SIL Kit packages.

The SIL Kit source and documentation is licensed under a permissible open
Expand All @@ -54,7 +54,7 @@ The SIL Kit ecosystem comprises the following turn-key solutions:
project provides first-class support for TAP devices of the host operating system.

* The `SIL Kit Adapter for virtual CAN <https://github.com/vectorgrp/sil-kit-adapters-vcan>`_
can be used to attach a virtual CAN interface (SocketCAN) to a Vector SIL Kit CAN bus.
can be used to attach a virtual CAN interface (SocketCAN) to a SIL Kit CAN bus.

* The `SIL Kit Adapter for Generic Linux IO <https://github.com/vectorgrp/sil-kit-adapters-generic-linux-io>`_
allows to attach SIL Kit to a generic Linux IO device, such as character devices or GPIOs.
Expand Down Expand Up @@ -99,7 +99,7 @@ directory and configure CMake::
cmake ..


3. Build the Vector SIL Kit
3. Build the SIL Kit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Once the project has been generated, you can build the SIL Kit using the
Expand Down
4 changes: 2 additions & 2 deletions SilKit/source/SilKit.rc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#define VERSIONSTRING(a,b,c,d) STRING_HELPER(a) "." STRING_HELPER(b) "." STRING_HELPER(c) "." STRING_HELPER(d)

#define ASSEMBLYINFO_COMPANY "Vector Informatik GmbH"
#define ASSEMBLYINFO_PRODUCT "Vector SIL Kit"
#define ASSEMBLYINFO_PRODUCT "SIL Kit"
#define ASSEMBLYINFO_COPYRIGHT "Copyright © 2022 Vector Informatik GmbH."
#define ASSEMBLYINFO_FILEDESCRIPTION "Vector SIL Kit by Vector Informatik GmbH"
#define ASSEMBLYINFO_VERSIONSTRING VERSIONSTRING(SILKIT_VERSION_MAJOR,SILKIT_VERSION_MINOR,SILKIT_VERSION_PATCH,SILKIT_BUILD_NUMBER)
Expand Down Expand Up @@ -38,7 +38,7 @@ BEGIN
VALUE "CompanyName", ASSEMBLYINFO_COMPANY
VALUE "FileDescription", ASSEMBLYINFO_FILEDESCRIPTION
VALUE "FileVersion", ASSEMBLYINFO_VERSIONSTRING
VALUE "InternalName", "Vector SIL Kit"
VALUE "InternalName", "SIL Kit"
VALUE "LegalCopyright", ASSEMBLYINFO_COPYRIGHT
VALUE "OriginalFilename", "SilKit.dll"
VALUE "ProductName", ASSEMBLYINFO_PRODUCT
Expand Down
4 changes: 2 additions & 2 deletions Utilities/SilKitMonitor/PassiveSystemMonitor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ int main(int argc, char** argv)
commandlineParser.Add<CliParser::Flag>("sync", "s", "[--sync]",
"-s, --sync: Run with virtual time synchronization.");

std::cout << "Vector SIL Kit -- System Monitor, SIL Kit version: " << SilKit::Version::String() << std::endl
std::cout << "SIL Kit -- System Monitor, SIL Kit version: " << SilKit::Version::String() << std::endl
<< std::endl;

try
Expand Down Expand Up @@ -116,7 +116,7 @@ int main(int argc, char** argv)
std::string hash{SilKit::Version::GitHash()};
auto shortHash = hash.substr(0, 7);
std::cout << "Version Info:" << std::endl
<< " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
<< " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;

return 0;
}
Expand Down
4 changes: 2 additions & 2 deletions Utilities/SilKitRegistry/Registry.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ int main(int argc, char** argv)
"-W, --windows-service: Run as a Windows service.", CliParser::Hidden);
}

std::cout << "Vector SIL Kit -- Registry, SIL Kit version: " << SilKit::Version::String() << std::endl << std::endl;
std::cout << "SIL Kit -- Registry, SIL Kit version: " << SilKit::Version::String() << std::endl << std::endl;

try
{
Expand Down Expand Up @@ -403,7 +403,7 @@ int main(int argc, char** argv)
std::string hash{SilKit::Version::GitHash()};
auto shortHash = hash.substr(0, 7);
std::cout << "Version Info:" << std::endl
<< " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
<< " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;

return 0;
}
Expand Down
4 changes: 2 additions & 2 deletions Utilities/SilKitSystemController/SystemController.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ int main(int argc, char** argv)
"--non-interactive: Run without awaiting any user interactions at any time.",
CliParser::Hidden);

std::cout << "Vector SIL Kit -- System Controller, SIL Kit version: " << SilKit::Version::String() << std::endl
std::cout << "SIL Kit -- System Controller, SIL Kit version: " << SilKit::Version::String() << std::endl
<< std::endl;

try
Expand Down Expand Up @@ -345,7 +345,7 @@ int main(int argc, char** argv)
std::string hash{SilKit::Version::GitHash()};
auto shortHash = hash.substr(0, 7);
std::cout << "Version Info:" << std::endl
<< " - Vector SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;
<< " - SilKit: " << SilKit::Version::String() << ", #" << shortHash << std::endl;

return 0;
}
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{% extends "!layout.html" %}
{% block sidebartitle %}
<a class="icon icon-home" href="contents.html">
Vector SIL Kit
SIL Kit
</a>
<div class="version" style="margin-bottom: 0.5em;">
Version: {{ release }}
Expand Down
2 changes: 1 addition & 1 deletion docs/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
C/C++ API
=========

This document describes the user available programming interfaces of the Vector |ProductName|.
This document describes the user available programming interfaces of the |ProductName|.
If you are not yet familiar with the |ProductName|, have a look at the :doc:`Developers Guide<../for-developers/developers>`.
Information on API organization in the |ProductName|:

Expand Down
2 changes: 1 addition & 1 deletion docs/changelog/overview.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Changelog
=========

All notable changes to the Vector SIL Kit project are listed on the respective
All notable changes to the SIL Kit project are listed on the respective
versions page.

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

# -- Project information -----------------------------------------------------

project = 'Vector SIL Kit'
project = 'SIL Kit'
copyright = '2022 Vector Informatik GmbH'
author = 'Vector Informatik GmbH'
version = '1.0.0'
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Configuration

.. _sec:sil-kit-config-yaml:

The Vector |ProductName| provides optional configuration to enhance flexibility and control through use of YAML files.
The |ProductName| provides optional configuration to enhance flexibility and control through use of YAML files.
This allows users to modify behavior without recompiling source code.
Further, it allows configuration of services which are inactive by default, such as tracing and logging.
Different configuration options are available for |ProductName| participants and the |ProductName| Registry.
Expand Down Expand Up @@ -202,7 +202,7 @@ The Registry Configuration File

An instance of the |ProductName| Registry (``sil-kit-registry(.exe)``) can be configured via a YAML file.
The configuration file is optional and overrides the settings specified on the command line.
It also allows extended configuration, beyond what the command line allows, particularly for logging and data export to a `Vector SIL Kit Dashboard <https://vector.com/sil-kit-dashboard>`_ instance.
It also allows extended configuration, beyond what the command line allows, particularly for logging and data export to a `SIL Kit Dashboard <https://vector.com/sil-kit-dashboard>`_ instance.

The outline of a registry configuration file is as follows:

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/experimental-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Metrics for the registry
The registry configuration supports collecting metrics from remote participants
and forwarding the collected data to the SIL Kit Dashboard for further
analysis and visualization.
Refer to the documentation of the `Vector SIL Kit Dashboard <https://vector.com/sil-kit-dashboard>`_ for further instructions.
Refer to the documentation of the `SIL Kit Dashboard <https://vector.com/sil-kit-dashboard>`_ for further instructions.

.. code-block:: yaml

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/extension-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Extensions Configuration
Overview
========================================

The Vector SIL Kit Extensions are developed by Vector and provided in binary form.
The SIL Kit Extensions are developed by Vector and provided in binary form.
To facilitate the lookup of these binaries, specific search paths can be configured as explained below.

Configuration
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/logging-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Logging Configuration
Overview
========================================

Within the Vector SIL Kit, the Logger provides features for local and distributed logging on different log
Within the SIL Kit, the Logger provides features for local and distributed logging on different log
levels.

Configuration
========================================
The Logging configuration allows to configure the logging behavior of the simulation participant.
Within the Vector SIL Kit, the Logger uses so-called sinks to store log messages.
Within the SIL Kit, the Logger uses so-called sinks to store log messages.
Multiple sinks can be configured at the same time. For example, to send log
messages with log level ``Debug`` or higher to a remote logger and write ``Trace`` level
logs to a file, the following configuration could be used:
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/middleware-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Middleware Configuration
Overview
--------------------

The Vector SIL Kit uses an internal middleware for message exchange.
This middleware is open source and included in the sources of the Vector SIL Kit.
The SIL Kit uses an internal middleware for message exchange.
This middleware is open source and included in the sources of the SIL Kit.

The middleware can be configured as follows.

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/services-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Communication Services (CAN, LIN, FlexRay, Ethernet, Data, RPC)

Overview
========================================
All services of the Vector SIL Kit can be configured within the participant configuration.
All services of the SIL Kit can be configured within the participant configuration.
The following sections describe how each service can be configured.
The configuration of the single services is fully optional.

Expand Down
4 changes: 2 additions & 2 deletions docs/faq/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ The registry does not partake in the simulation itself.
It especially does not route messages between participants.
Please note that it is mandatory that all |ProductName| simulation participants can reach the |ProductName| registry for a proper simulation setup.

Can I use Vector |ProductName| together with real hardware/in a Hardware-in-the-Loop setup?
Can I use |ProductName| together with real hardware/in a Hardware-in-the-Loop setup?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Vector |ProductName| was designed deliberately with Software-in-the-Loop environments in mind.
|ProductName| was designed deliberately with Software-in-the-Loop environments in mind.
Many aspects of it are designed for SIL settings (especially the virtual time synchronization, that adapts its speed to the execution speed of the participants) and not HIL settings.
These aspects might imply that |ProductName| does not fit the needs of your hardware setup.
Furthermore, |ProductName| itself does not provide capabilities to connect it to a hardware setup.
Expand Down
2 changes: 1 addition & 1 deletion docs/for-developers/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Developer Guide
=============================

The following sections explain, how to consume the Vector |ProductName| library in your own application and how to use the |ProductName| API to communicate with other participants of a simulation.
The following sections explain, how to consume the |ProductName| library in your own application and how to use the |ProductName| API to communicate with other participants of a simulation.

.. contents::
:local:
Expand Down
2 changes: 1 addition & 1 deletion docs/for-users/users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
User Guide
==============================

The following section explains how to bring together Vector |ProductName| enabled applications and how to successfully run a simulation.
The following section explains how to bring together |ProductName| enabled applications and how to successfully run a simulation.

.. contents::
:local:
Expand Down
5 changes: 2 additions & 3 deletions docs/man/sil-kit-monitor.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
.TH sil-kit-monitor "1" "September 2024" "sil-kit-monitor" "User Commands"
.SH NAME
sil-kit-monitor \- Manual page for Vector SIL Kit - System Monitor
sil-kit-monitor \- Manual page for SIL Kit - System Monitor
.SH SYNOPSIS
.B sil-kit-monitor
[\fI\,--version\/\fR] [\fI\,--help\/\fR] [\fI\,--connect-uri <silkitUri>\/\fR] [\fI\,--name <participantName>\/\fR] [\fI\,--configuration <filePath>\/\fR] [\fI\,--autonomous\/\fR] [\fI\,--coordinated\/\fR] [\fI\,--sync\/\fR]
.SH DESCRIPTION
Vector SIL Kit \fB\-\-\fR System Monitor
SIL Kit \fB\-\-\fR System Monitor
.PP
.SH SYNOPSIS
.IP "-v --version"
Expand All @@ -28,7 +28,6 @@ Run with virtual time synchronization.
.SH "SEE ALSO"
The full documentation for
.I sil-kit-monitor
.B Vector
is maintained at
.B https://vectorgrp.github.io/sil-kit-docs/
.SH COPYRIGHT
Expand Down
4 changes: 2 additions & 2 deletions docs/man/sil-kit-registry.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
.TH sil-kit-registry "1" "September 2024" "sil-kit-registry" "User Commands"
.SH NAME
sil-kit-registry \- Manual page for Vector SIL Kit - Registry
sil-kit-registry \- Manual page for SIL Kit - Registry
.SH SYNOPSIS
.B sil-kit-registry
[\fI\,--version\/\fR] [\fI\,--help\/\fR] [\fI\,--listen-uri <silkitUri>\/\fR] [\fI\,--generate-configuration <filePath>\/\fR] [\fI\,--dashboard-uri <uri>\/\fR] [\fI\,--log <level>\/\fR] [\fI\,--registry-configuration <filePath>\/\fR]
.SH DESCRIPTION
Vector SIL Kit \fB\-\-\fR Registry
SIL Kit \fB\-\-\fR Registry
.PP
.SH OPTIONS
.IP "-v --version"
Expand Down
4 changes: 2 additions & 2 deletions docs/man/sil-kit-system-controller.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
.TH sil-kit-system-controller "1" "September 2024" "sil-kit-system-controller" "User Commands"
.SH NAME
sil-kit-system-controller \- Manual page for Vector SIL Kit - System Controller
sil-kit-system-controller \- Manual page for SIL Kit - System Controller
.SH SYNOPSIS
.B sil-kit-system-controller
[\fI\,--version\/\fR] [\fI\,--help\/\fR] [\fI\,--non-interactive\/\fR] [\fI\,--connect-uri <silkitUri>\/\fR] [\fI\,--name <participantName>\/\fR] [\fI\,--configuration <filePath>\/\fR] \fI\,<participantName1> \/\fR[\fI\,<participantName2> \/\fR...]
.SH DESCRIPTION
Vector SIL Kit \fB\-\-\fR System Controller
SIL Kit \fB\-\-\fR System Controller
.PP
Arguments:
.IP "-v --version"
Expand Down
6 changes: 3 additions & 3 deletions docs/overview/overview.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. include:: substitutions.rst

=======================
Vector SIL Kit Overview
SIL Kit Overview
=======================

.. |_| unicode:: 0xA0
Expand All @@ -15,7 +15,7 @@ Vector SIL Kit Overview
.. |Timesync-API| replace:: :ref:`time synchronization<chap:timesync-service-api>`
.. |Logging-API| replace:: :ref:`logging<chap:logging-service-api>`

The Vector |ProductName| is an open source library for connecting Software-in-the-Loop Environments.
The |ProductName| is an open source library for connecting Software-in-the-Loop Environments.
It provides:

* Communication infrastructure for automotive and non-automotive applications
Expand Down Expand Up @@ -101,7 +101,7 @@ The |ProductName| ecosystem comprises the following turn-key solutions:
project provides first-class support for TAP devices of the host operating system.

* The `SIL Kit Adapter for virtual CAN <https://github.com/vectorgrp/sil-kit-adapters-vcan>`_
can be used to attach a virtual CAN (Controller Area Network) interface (SocketCAN) to a Vector SIL Kit CAN bus.
can be used to attach a virtual CAN (Controller Area Network) interface (SocketCAN) to a SIL Kit CAN bus.

* The `SIL Kit Adapter for Generic Linux IO <https://github.com/vectorgrp/sil-kit-adapters-generic-linux-io>`_
allows to attach SIL Kit to a generic Linux IO device, such as character devices or GPIOs.
Expand Down
6 changes: 3 additions & 3 deletions docs/troubleshooting/advanced.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
Advanced
========

This section shows how to use advanced tools like the `Vector SIL Kit Dashboard <https://vector.com/sil-kit-dashboard>`_ to visualize simulations, in order to identitfy participant misconfigurations, detect system misbehavior or analyze participant performance.
This section shows how to use advanced tools like the `SIL Kit Dashboard <https://vector.com/sil-kit-dashboard>`_ to visualize simulations, in order to identitfy participant misconfigurations, detect system misbehavior or analyze participant performance.

Getting Started with the dashboard
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The dashboard is a freeware application that collects and visualizes SIL Kit simulation data.
It can be used to show static attributes of participants and also show their simulation properties like active peer connections and simulated, active networks.
In addition, the collection of performance metrics can be enabled in the configuration files of the SIL Kit participants.

This section shows how to enable the data collection of simulations for the Vector SIL Kit Dashboard.
This section shows how to enable the data collection of simulations for the SIL Kit Dashboard.
Please refer to the SIL Kit Dashboard documentation for updated instructions.

#. The SIL Kit registry will forward simulation data to a running Vector SIL Kit Dashboard instance, if configured properly.
#. The SIL Kit registry will forward simulation data to a running SIL Kit Dashboard instance, if configured properly.
The ``sil-kit-registry`` executable supports the ``--dashboard-uri https://1.2.3.4`` command line flag and the registry's configuration supports the ``DashboardUri: https://1.2.3.4`` declaration.
Ensure that the registry is able to connect to the Dashboard when started, e.g. by verifying the log output.
The registry's configuration of ``CollectFromRemotes: true`` defaults to true -- it can be disabled explicitly.
Expand Down
4 changes: 2 additions & 2 deletions docs/utilities/utilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Utilities
:local:
:depth: 1

Running a Vector |ProductName| system is supported by several utilities.
Running a |ProductName| system is supported by several utilities.
The **Registry** is a mandatory part of the |ProductName| integrated middleware.
It is needed to establish the connections between simulation participants at the start of a simulation.
The **System Controller** implements a simulation-wide state handling.
Expand All @@ -25,7 +25,7 @@ sil-kit-registry

Abstract
The ``sil-kit-registry`` enables discovery between |ProductName| participants.
It is needed for Vector |ProductName| simulations.
It is needed for |ProductName| simulations.
Source location
``Utilities/SilKitRegistry``
Requirements
Expand Down
Loading