Skip to content

Commit

Permalink
Auto-deploy docs built from commit 52d6873
Browse files Browse the repository at this point in the history
  • Loading branch information
UlfBj committed Nov 14, 2024
1 parent c275f7c commit 55e44e1
Show file tree
Hide file tree
Showing 22 changed files with 498 additions and 497 deletions.
16 changes: 8 additions & 8 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
<title>404 Page not found</title>


<link href="/vissr/css/nucleus.css?1731411606" rel="stylesheet">
<link href="/vissr/css/fontawesome-all.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/hybrid.css?1731411606" rel="stylesheet">
<link href="/vissr/css/featherlight.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/perfect-scrollbar.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/theme.css?1731411606" rel="stylesheet">
<link href="/vissr/css/hugo-theme.css?1731411606" rel="stylesheet">
<link href="/vissr/css/nucleus.css?1731594036" rel="stylesheet">
<link href="/vissr/css/fontawesome-all.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/hybrid.css?1731594036" rel="stylesheet">
<link href="/vissr/css/featherlight.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/perfect-scrollbar.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/theme.css?1731594036" rel="stylesheet">
<link href="/vissr/css/hugo-theme.css?1731594036" rel="stylesheet">

<link href="/vissr/css/theme-blue.css?1731411606" rel="stylesheet">
<link href="/vissr/css/theme-blue.css?1731594036" rel="stylesheet">

<style>
:root #header + #content > #left > #rlblock_left {
Expand Down
65 changes: 33 additions & 32 deletions build-system/hello-world/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@
<title>VISSR Hello World example :: COVESA VISSv2 Reference Implementation (vissr)</title>


<link href="/vissr/css/nucleus.css?1731411606" rel="stylesheet">
<link href="/vissr/css/fontawesome-all.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/hybrid.css?1731411606" rel="stylesheet">
<link href="/vissr/css/featherlight.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/perfect-scrollbar.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/auto-complete.css?1731411606" rel="stylesheet">
<link href="/vissr/css/atom-one-dark-reasonable.css?1731411606" rel="stylesheet">
<link href="/vissr/css/theme.css?1731411606" rel="stylesheet">
<link href="/vissr/css/hugo-theme.css?1731411606" rel="stylesheet">
<link href="/vissr/css/nucleus.css?1731594036" rel="stylesheet">
<link href="/vissr/css/fontawesome-all.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/hybrid.css?1731594036" rel="stylesheet">
<link href="/vissr/css/featherlight.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/perfect-scrollbar.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/auto-complete.css?1731594036" rel="stylesheet">
<link href="/vissr/css/atom-one-dark-reasonable.css?1731594036" rel="stylesheet">
<link href="/vissr/css/theme.css?1731594036" rel="stylesheet">
<link href="/vissr/css/hugo-theme.css?1731594036" rel="stylesheet">

<link href="/vissr/css/theme-blue.css?1731411606" rel="stylesheet">
<link href="/vissr/css/theme-blue.css?1731594036" rel="stylesheet">



<script src="/vissr/js/jquery-3.3.1.min.js?1731411606"></script>
<script src="/vissr/js/jquery-3.3.1.min.js?1731594036"></script>

<style>
:root #header + #content > #left > #rlblock_left{
Expand Down Expand Up @@ -59,14 +59,14 @@
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>

<script type="text/javascript" src="/vissr/js/lunr.min.js?1731411606"></script>
<script type="text/javascript" src="/vissr/js/auto-complete.js?1731411606"></script>
<script type="text/javascript" src="/vissr/js/lunr.min.js?1731594036"></script>
<script type="text/javascript" src="/vissr/js/auto-complete.js?1731594036"></script>
<script type="text/javascript">

var baseurl = "https:\/\/covesa.github.io\/vissr\/";

</script>
<script type="text/javascript" src="/vissr/js/search.js?1731411606"></script>
<script type="text/javascript" src="/vissr/js/search.js?1731594036"></script>


</div>
Expand Down Expand Up @@ -661,7 +661,7 @@ <h1>



<p>Two Hello Worl alternatives are available:</p>
<p>Two Hello World alternatives are available:</p>
<ul>
<li><a href="/vissr/build-system/hello-world/#native-build-based-hello-world-example">Native build</a> based example</li>
<li><a href="/vissr/build-system/hello-world/#docker-based-hello-world-example">Docker</a> based example</li>
Expand All @@ -671,11 +671,11 @@ <h2 id="native-build-based-hello-world-example">Native build based Hello World e
please see <a href="/vissr/build-system/#installing-golang">here</a> how to get that done.
The next step is to clone the <a href="https://github.com/COVESA/vissr">VISSR</a> repo.</p>
<pre tabindex="0"><code>$ git clone https://github.com/COVESA/vissr.git
</code></pre><p>This is followed going to the directory where the main server code is located, and build the server.</p>
</code></pre><p>This is followed by going to the directory where the main server code is located, and build the server.</p>
<pre tabindex="0"><code>$ cd vissr/server/vissv2server/
$ go build
</code></pre><p>This could be followed by directly starting a client to issue requests to the server,
but the server would then tr to read data from an empty data store, so all responses would say &lsquo;data-not-available&rsquo;.
but the server would then try to read data from an empty data store, so all responses would say &lsquo;Data-not-found&rsquo;.
To be able to get some real data back we will therefore start a feeder that will write simulated data into the data store.</p>
<p>To do this, open a new terminal window, go to the feederv3 directory, and build the feeder.</p>
<pre tabindex="0"><code>$ cd vissr/feeder/feeder-template/feederv3/
Expand All @@ -692,7 +692,7 @@ <h2 id="native-build-based-hello-world-example">Native build based Hello World e
But first we need to find out the IP address of the computer as the client connects to the server over a socket based on this address.
How to do that can e. g. be found <a href="https://www.wikihow.com/Check-a-Computer-IP-Address">here</a>, on Ubuntu the command</p>
<pre tabindex="0"><code>$ ifconfig
</code></pre><p>can be used. You will then have to search i a lot of information for an address that likely starts with &lsquo;192.168&rsquo; followed by two more segments.
</code></pre><p>can be used. You will then have to search through a lot of information for an address that likely starts with &lsquo;192.168&rsquo; followed by two more segments.
Please copy this and use the file browser on the computer to go to the client/client-1.0/Javascript directory.
There you click on the file &lsquo;wsclient_uncompressed.html&rsquo;, which leads to that it starts up in the browser.
You will there see a field whch says &lsquo;host ip&rsquo;, please paste the IP address in there and click on the button to the right that says &lsquo;Server IP&rsquo;.
Expand All @@ -705,16 +705,17 @@ <h2 id="native-build-based-hello-world-example">Native build based Hello World e
<pre tabindex="0"><code>Server: {&#34;action&#34;:&#34;get&#34;,&#34;requestId&#34;:&#34;232&#34;,&#34;ts&#34;:&#34;2024-11-12T11:26:44.546855082Z&#34;, &#34;data&#34;:{&#34;path&#34;:&#34;Vehicle.Cabin.Door.Row1.DriverSide.IsOpen&#34;, &#34;dp&#34;:{&#34;value&#34;:&#34;Data-not-found&#34;, &#34;ts&#34;:&#34;2024-11-12T11:26:44.548180993Z&#34;}}}
</code></pre><p>The value is set to &lsquo;Data-not-found&rsquo; which is due to that the federv3 is not instructed to create simulated values for this signal.
At startup the feederv3 reads the file VssVehicle.cvt which has been created by the <a href="/vissr/tools/">Domain Conversion Tool</a>.
This file contains the insructions for how signals are mapped and scaled when they traverse between the &lsquo;vehicle domain&rsquo; and the &lsquo;VSS domain&rsquo;,
This file contains the instructions for how signals are mapped and scaled when they traverse between the &lsquo;vehicle domain&rsquo; and the &lsquo;VSS domain&rsquo;,
but the feederv3 also uses this information to select which signals to create simulated values for.
The cvt-file that comes with the repo only contains the five signals that can be read in the tools/DomainConversionTool/Map-VSSv0.1-CANv0.1.yaml file.
So if we want to get a response with a simulated value a client request to any of these signals must be issued, e. g.:</p>
So if we want to get a response with a simulated value a client request to any of these signals must be issued, e. g. like below.
An alternative would be to create a new cvt-file with more signals first.</p>
<pre tabindex="0"><code>{&#34;action&#34;:&#34;get&#34;,&#34;path&#34;:&#34;Vehicle.Speed&#34;,&#34;requestId&#34;:&#34;232&#34;}
</code></pre><p>Please issue this request, se the response, wait about 30 secs and issue it again.
The values returned in the two responses should differ as the feeder randomly generates new values. If not wait another 30 secs and issue it again.
This could more easily be seen if a time-based subscribe request is issued:</p>
<pre tabindex="0"><code>{&#34;action&#34;:&#34;subscribe&#34;,&#34;path&#34;:&#34;Vehicle.Speed&#34;,&#34;filter&#34;:{&#34;variant&#34;:&#34;timebased&#34;,&#34;parameter&#34;:{&#34;period&#34;:&#34;10000&#34;}},&#34;requestId&#34;:&#34;246&#34;}
</code></pre><p>The server will issue event messages every ten seconds, and it can after a number of events has been received that the value is randomly changed.
</code></pre><p>The server will issue event messages every ten seconds, and it can after a number of events has been received be seen that the value is randomly changed.
To unsubscribe, issue the request:</p>
<pre tabindex="0"><code>{&#34;action&#34;:&#34;unsubscribe&#34;,&#34;subscriptionId&#34;:&#34;1&#34;,&#34;requestId&#34;:&#34;240&#34;}
</code></pre><p>The file client/client-1.0/Javascript/appclient_commands.txt contains examples of different requests that can be used, either as is or modified.</p>
Expand All @@ -724,7 +725,7 @@ <h2 id="native-build-based-hello-world-example">Native build based Hello World e
</code></pre><p>More simulation info can be found <a href="/vissr/feeder/#simulated-vehicle-data-sources">here</a>.
These files can easily be modified and extended with data for more signals and longer trips.</p>
<h2 id="docker-based-hello-world-example">Docker based Hello World example</h2>
<p>This is not ready yet&hellip;</p>
<p>The <a href="https://github.com/COVESA/cdsp/blob/main/docker/README.md">README</a> describes how to use a Docker image to get the VISSR server up and running.</p>



Expand Down Expand Up @@ -1067,19 +1068,19 @@ <h2 id="docker-based-hello-world-example">Docker based Hello World example</h2>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="/vissr/js/clipboard.min.js?1731411606"></script>
<script src="/vissr/js/perfect-scrollbar.min.js?1731411606"></script>
<script src="/vissr/js/perfect-scrollbar.jquery.min.js?1731411606"></script>
<script src="/vissr/js/jquery.sticky.js?1731411606"></script>
<script src="/vissr/js/featherlight.min.js?1731411606"></script>
<script src="/vissr/js/highlight.pack.js?1731411606"></script>
<script src="/vissr/js/clipboard.min.js?1731594036"></script>
<script src="/vissr/js/perfect-scrollbar.min.js?1731594036"></script>
<script src="/vissr/js/perfect-scrollbar.jquery.min.js?1731594036"></script>
<script src="/vissr/js/jquery.sticky.js?1731594036"></script>
<script src="/vissr/js/featherlight.min.js?1731594036"></script>
<script src="/vissr/js/highlight.pack.js?1731594036"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/vissr/js/modernizr.custom-3.6.0.js?1731411606"></script>
<script src="/vissr/js/learn.js?1731411606"></script>
<script src="/vissr/js/hugo-learn.js?1731411606"></script>
<script src="/vissr/js/modernizr.custom-3.6.0.js?1731594036"></script>
<script src="/vissr/js/learn.js?1731594036"></script>
<script src="/vissr/js/hugo-learn.js?1731594036"></script>


<script src="/vissr/mermaid/mermaid.js?1731411606"></script>
<script src="/vissr/mermaid/mermaid.js?1731594036"></script>

<script>
mermaid.initialize({ startOnLoad: true });
Expand Down
48 changes: 24 additions & 24 deletions build-system/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@
<title>VISSR Build System :: COVESA VISSv2 Reference Implementation (vissr)</title>


<link href="/vissr/css/nucleus.css?1731411606" rel="stylesheet">
<link href="/vissr/css/fontawesome-all.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/hybrid.css?1731411606" rel="stylesheet">
<link href="/vissr/css/featherlight.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/perfect-scrollbar.min.css?1731411606" rel="stylesheet">
<link href="/vissr/css/auto-complete.css?1731411606" rel="stylesheet">
<link href="/vissr/css/atom-one-dark-reasonable.css?1731411606" rel="stylesheet">
<link href="/vissr/css/theme.css?1731411606" rel="stylesheet">
<link href="/vissr/css/hugo-theme.css?1731411606" rel="stylesheet">
<link href="/vissr/css/nucleus.css?1731594036" rel="stylesheet">
<link href="/vissr/css/fontawesome-all.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/hybrid.css?1731594036" rel="stylesheet">
<link href="/vissr/css/featherlight.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/perfect-scrollbar.min.css?1731594036" rel="stylesheet">
<link href="/vissr/css/auto-complete.css?1731594036" rel="stylesheet">
<link href="/vissr/css/atom-one-dark-reasonable.css?1731594036" rel="stylesheet">
<link href="/vissr/css/theme.css?1731594036" rel="stylesheet">
<link href="/vissr/css/hugo-theme.css?1731594036" rel="stylesheet">

<link href="/vissr/css/theme-blue.css?1731411606" rel="stylesheet">
<link href="/vissr/css/theme-blue.css?1731594036" rel="stylesheet">



<script src="/vissr/js/jquery-3.3.1.min.js?1731411606"></script>
<script src="/vissr/js/jquery-3.3.1.min.js?1731594036"></script>

<style>
:root #header + #content > #left > #rlblock_left{
Expand Down Expand Up @@ -59,14 +59,14 @@
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>

<script type="text/javascript" src="/vissr/js/lunr.min.js?1731411606"></script>
<script type="text/javascript" src="/vissr/js/auto-complete.js?1731411606"></script>
<script type="text/javascript" src="/vissr/js/lunr.min.js?1731594036"></script>
<script type="text/javascript" src="/vissr/js/auto-complete.js?1731594036"></script>
<script type="text/javascript">

var baseurl = "https:\/\/covesa.github.io\/vissr\/";

</script>
<script type="text/javascript" src="/vissr/js/search.js?1731411606"></script>
<script type="text/javascript" src="/vissr/js/search.js?1731594036"></script>


</div>
Expand Down Expand Up @@ -1069,19 +1069,19 @@ <h2 id="docker">Docker</h2>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="/vissr/js/clipboard.min.js?1731411606"></script>
<script src="/vissr/js/perfect-scrollbar.min.js?1731411606"></script>
<script src="/vissr/js/perfect-scrollbar.jquery.min.js?1731411606"></script>
<script src="/vissr/js/jquery.sticky.js?1731411606"></script>
<script src="/vissr/js/featherlight.min.js?1731411606"></script>
<script src="/vissr/js/highlight.pack.js?1731411606"></script>
<script src="/vissr/js/clipboard.min.js?1731594036"></script>
<script src="/vissr/js/perfect-scrollbar.min.js?1731594036"></script>
<script src="/vissr/js/perfect-scrollbar.jquery.min.js?1731594036"></script>
<script src="/vissr/js/jquery.sticky.js?1731594036"></script>
<script src="/vissr/js/featherlight.min.js?1731594036"></script>
<script src="/vissr/js/highlight.pack.js?1731594036"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/vissr/js/modernizr.custom-3.6.0.js?1731411606"></script>
<script src="/vissr/js/learn.js?1731411606"></script>
<script src="/vissr/js/hugo-learn.js?1731411606"></script>
<script src="/vissr/js/modernizr.custom-3.6.0.js?1731594036"></script>
<script src="/vissr/js/learn.js?1731594036"></script>
<script src="/vissr/js/hugo-learn.js?1731594036"></script>


<script src="/vissr/mermaid/mermaid.js?1731411606"></script>
<script src="/vissr/mermaid/mermaid.js?1731594036"></script>

<script>
mermaid.initialize({ startOnLoad: true });
Expand Down
Loading

0 comments on commit 55e44e1

Please sign in to comment.