Skip to content

Commit

Permalink
deploy: 976a356
Browse files Browse the repository at this point in the history
  • Loading branch information
BjoernAtBosch committed May 31, 2024
1 parent bf408ba commit 7aade30
Show file tree
Hide file tree
Showing 123 changed files with 3,056 additions and 9,058 deletions.
19 changes: 5 additions & 14 deletions assets/diagrams.drawio

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion assets/direct_service_invocation.drawio
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
<mxCell id="Vslb4EtYpa9SIVrh0Tky-35" value="Vehicle Model SDK" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;" parent="1" vertex="1">
<mxGeometry x="730" y="444" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="Vslb4EtYpa9SIVrh0Tky-38" value="Kuksa Databroker" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;" parent="1" vertex="1">
<mxCell id="Vslb4EtYpa9SIVrh0Tky-38" value="KUKSA Databroker" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;" parent="1" vertex="1">
<mxGeometry x="730" y="620" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="dPI-obEnypmD2hLNzWjc-1" value="" style="group" parent="1" vertex="1" connectable="0">
Expand Down
2 changes: 1 addition & 1 deletion assets/programming_model.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/project-overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
665 changes: 4 additions & 661 deletions assets/sdk_overview.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions assets/seat_adjuster_dataflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions assets/seat_adjuster_dataflow_1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions assets/seat_adjuster_dataflow_2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions categories/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@



<link rel="preload" href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" as="style">
<link href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" rel="stylesheet" integrity="">
<link rel="preload" href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" as="style">
<link href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" rel="stylesheet" integrity="">

<script
src=/velocitas-docs/js/jquery-3.6.0.min.js
Expand Down Expand Up @@ -85,7 +85,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/velocitas-docs/offline-search-index.55197f087906bba38d74901107396d10.json"
data-offline-search-index-json-src="/velocitas-docs/offline-search-index.b9de75ab8ed72d4d7a8d8ab3558d3364.json"
data-offline-search-base-href="/"
data-offline-search-max-results="10"
>
Expand Down
6 changes: 3 additions & 3 deletions community/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@



<link rel="preload" href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" as="style">
<link href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" rel="stylesheet" integrity="">
<link rel="preload" href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" as="style">
<link href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" rel="stylesheet" integrity="">

<script
src=/velocitas-docs/js/jquery-3.6.0.min.js
Expand Down Expand Up @@ -86,7 +86,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/velocitas-docs/offline-search-index.55197f087906bba38d74901107396d10.json"
data-offline-search-index-json-src="/velocitas-docs/offline-search-index.b9de75ab8ed72d4d7a8d8ab3558d3364.json"
data-offline-search-base-href="/"
data-offline-search-max-results="10"
>
Expand Down
6 changes: 3 additions & 3 deletions community/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@



<link rel="preload" href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" as="style">
<link href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" rel="stylesheet" integrity="">
<link rel="preload" href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" as="style">
<link href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" rel="stylesheet" integrity="">

<script
src=/velocitas-docs/js/jquery-3.6.0.min.js
Expand Down Expand Up @@ -86,7 +86,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/velocitas-docs/offline-search-index.55197f087906bba38d74901107396d10.json"
data-offline-search-index-json-src="/velocitas-docs/offline-search-index.b9de75ab8ed72d4d7a8d8ab3558d3364.json"
data-offline-search-base-href="/"
data-offline-search-max-results="10"
>
Expand Down
1,262 changes: 415 additions & 847 deletions docs/_print/index.html

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions docs/about/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@



<link rel="preload" href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" as="style">
<link href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" rel="stylesheet" integrity="">
<link rel="preload" href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" as="style">
<link href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" rel="stylesheet" integrity="">

<script
src=/velocitas-docs/js/jquery-3.6.0.min.js
Expand Down Expand Up @@ -90,7 +90,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/velocitas-docs/offline-search-index.55197f087906bba38d74901107396d10.json"
data-offline-search-index-json-src="/velocitas-docs/offline-search-index.b9de75ab8ed72d4d7a8d8ab3558d3364.json"
data-offline-search-base-href="/"
data-offline-search-max-results="10"
>
Expand Down Expand Up @@ -388,7 +388,7 @@ <h2 id="examples">Examples</h2>
<h1 id="pg-14994cdfceb19b97cd58870a0d746743">1.1 - Seat Adjuster</h1>
<div class="lead">Provides option to request a new seat position and to publish the current seat position</div>
<p>In the scenario of a car sharing company, the goal is to provide the functionality of automatically adjusting the driver&rsquo;s seat position based on their preferred settings stored in their profile. When the driver unlocks the car, a request is sent to the vehicle to retrieve the preferred seat position. This is where your implementation begins.</p>
<p>The <em>Seat Adjuster Vehicle App</em> receives a MQTT message containing the seat position, which then triggers a seat adjustment command through the <em>Seat Service</em> to change the seat position. Additionally, to ensure convenience for future trips, the car sharing company saves the driver&rsquo;s preferred seat position and utilizes it accordingly. <em>The Seat Adjuster Vehicle App</em> subscribes to the seat position, receiving updates from the <em>Data Broker</em>, which streams data from the <em>Seat Service</em>.</p>
<p>The <em>Seat Adjuster Vehicle App</em> receives a MQTT message containing the seat position, which then triggers a seat adjustment command through the <em>Seat Service</em> to change the seat position. Additionally, to ensure convenience for future trips, the car sharing company saves the driver&rsquo;s preferred seat position and utilizes it accordingly. <em>The Seat Adjuster Vehicle App</em> subscribes to the seat position, receiving updates from the <em>Databroker</em>, which streams data from the <em>Seat Service</em>.</p>
<h2 id="requesting-new-seat-position">Requesting new seat position</h2>
<p><img src="./seat_adjuster_dataflow_1.png" alt="seat_adjuster_dataflow_1"></p>
<ol>
Expand All @@ -400,7 +400,7 @@ <h2 id="requesting-new-seat-position">Requesting new seat position</h2>
<p>The <strong>Seat Adjuster <em>Vehicle App</em></strong> that has subscribed to this topic, receives the request to change the seat position as a MQTT message.</p>
</li>
<li>
<p>The <strong>Seat Adjuster <em>Vehicle App</em></strong> gets the current vehicle speed from the data broker, which is fed by the <strong>CAN Feeder (KUKSA DBC Feeder)</strong>.</p>
<p>The <strong>Seat Adjuster <em>Vehicle App</em></strong> gets the current vehicle speed from the Databroker, which is fed by the <strong>CAN Provider (KUKSA CAN Provider)</strong>.</p>
</li>
<li>
<p>With the support of the <strong><em>Vehicle App</em> SDK</strong>, the <strong>Seat Adjuster <em>Vehicle App</em></strong> triggers a seat adjustment command of the <strong>Seat Service</strong> via gRPC in the event that the speed is equal to zero. Hint: This is a helpful convenience check but not a safety check.</p>
Expand Down Expand Up @@ -428,10 +428,10 @@ <h2 id="publishing-current-seat-position">Publishing current seat position</h2>
<p>If the seat position will be changed by the driver, the new seat position will be sent to the <strong>Seat Service</strong> via CAN.</p>
</li>
<li>
<p>The <strong>Seat Service</strong> streams the seat position via gRPC to the <strong>KUKSA Data Broker</strong> since it was registered beforehand.</p>
<p>The <strong>Seat Service</strong> streams the seat position via gRPC to the <strong>KUKSA Databroker</strong> since it was registered beforehand.</p>
</li>
<li>
<p>The <strong>Seat Adjuster <em>Vehicle App</em></strong> that subscribed to the seat position receives the new seat position from the <strong>KUKSA Data Broker</strong> as a result.</p>
<p>The <strong>Seat Adjuster <em>Vehicle App</em></strong> that subscribed to the seat position receives the new seat position from the <strong>KUKSA Databroker</strong> as a result.</p>
</li>
<li>
<p>The <strong>Seat Adjuster <em>Vehicle App</em></strong> publishes this on topic <code>seatadjuster/currentPosition</code> with the payload:</p>
Expand Down Expand Up @@ -589,25 +589,25 @@ <h1 id="pg-2c63eee46c0f8f9183b9da4a108ddf3f">2 - Repository Overview</h1>
<tr>
<td>

<a href="https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker" target="_blank" rel="noopener">kuksa.val</a>
<a href="https://github.com/eclipse-kuksa/kuksa-databroker" target="_blank" rel="noopener">kuksa-databroker</a>
</td>
<td>Is a part of the <em>Vehicle Abstraction Layer (VAL)</em> of the

<a href="https://www.eclipse.org/kuksa/" target="_blank" rel="noopener">Eclipse KUKSA project</a>
and provides the KUKSA Data Broker (aka Vehicle Data Broker). The KUKSA Data Broker offers data points available in the vehicle to the <em>Vehicle Apps</em> semantically aligned to a data model like the
<a href="https://github.com/eclipse-kuksa" target="_blank" rel="noopener">Eclipse KUKSA project</a>
and provides the KUKSA Databroker. The KUKSA Databroker offers data points available in the vehicle to the <em>Vehicle Apps</em> semantically aligned to a data model like the

<a href="https://covesa.github.io/vehicle_signal_specification/" target="_blank" rel="noopener">Vehicle Signal Specification (VSS)</a>
.</td>
</tr>
<tr>
<td>

<a href="https://github.com/eclipse/kuksa.val.feeders/tree/main/dbc2val" target="_blank" rel="noopener">kuksa.val.feeders</a>
<a href="https://github.com/eclipse-kuksa/kuksa-can-provider" target="_blank" rel="noopener">kuksa-can-provider</a>
</td>
<td>The KUKSA DBC Feeder is a generic data feeder that reads data from the vehicle&rsquo;s
<td>The KUKSA CAN Provider is a generic data feeder that reads data from the vehicle&rsquo;s

<a href="https://en.wikipedia.org/wiki/CAN_bus" target="_blank" rel="noopener">CAN bus</a>
defined by a DBC file, maps them to a set of data points (e.g. according to the VSS) and feeds it into the Data Broker.</td>
defined by a DBC file, maps them to a set of data points (e.g. according to the VSS) and feeds it into the Databroker.</td>
</tr>
<tr>
<td>
Expand Down
27 changes: 6 additions & 21 deletions docs/about/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@



<link rel="preload" href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" as="style">
<link href="/velocitas-docs/scss/main.min.4ebaddcfde6fc9e0acc62443eeb47c0964bcde6cb0949e7c6116262523aabe94.css" rel="stylesheet" integrity="">
<link rel="preload" href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" as="style">
<link href="/velocitas-docs/scss/main.min.b71603ee60329cd2b2d1483afdc897215eeae83b9a59331f20357707fc7c9481.css" rel="stylesheet" integrity="">

<script
src=/velocitas-docs/js/jquery-3.6.0.min.js
Expand Down Expand Up @@ -90,7 +90,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/velocitas-docs/offline-search-index.55197f087906bba38d74901107396d10.json"
data-offline-search-index-json-src="/velocitas-docs/offline-search-index.b9de75ab8ed72d4d7a8d8ab3558d3364.json"
data-offline-search-base-href="/"
data-offline-search-max-results="10"
>
Expand All @@ -116,7 +116,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/velocitas-docs/offline-search-index.55197f087906bba38d74901107396d10.json"
data-offline-search-index-json-src="/velocitas-docs/offline-search-index.b9de75ab8ed72d4d7a8d8ab3558d3364.json"
data-offline-search-base-href="/"
data-offline-search-max-results="10"
>
Expand Down Expand Up @@ -382,27 +382,12 @@
<input type="checkbox" id="m-velocitas-docsdocstutorialsvehicle_app_runtimekanto_runtime-check"/>
<label for="m-velocitas-docsdocstutorialsvehicle_app_runtimekanto_runtime-check"><a href="/velocitas-docs/docs/tutorials/vehicle_app_runtime/kanto_runtime/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-velocitas-docsdocstutorialsvehicle_app_runtimekanto_runtime"><span class="">Kanto Runtime</span></a></label>

</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-velocitas-docsdocstutorialsvehicle_app_runtimekubernetes_runtime-li">
<input type="checkbox" id="m-velocitas-docsdocstutorialsvehicle_app_runtimekubernetes_runtime-check"/>
<label for="m-velocitas-docsdocstutorialsvehicle_app_runtimekubernetes_runtime-check"><a href="/velocitas-docs/docs/tutorials/vehicle_app_runtime/kubernetes_runtime/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-velocitas-docsdocstutorialsvehicle_app_runtimekubernetes_runtime"><span class="">Kubernetes Runtime</span></a></label>

</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id="m-velocitas-docsdocstutorialsvehicle_app_deployment-li">
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-velocitas-docsdocstutorialsvehicle_app_deployment-li">
<input type="checkbox" id="m-velocitas-docsdocstutorialsvehicle_app_deployment-check"/>
<label for="m-velocitas-docsdocstutorialsvehicle_app_deployment-check"><a href="/velocitas-docs/docs/tutorials/vehicle_app_deployment/" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id="m-velocitas-docsdocstutorialsvehicle_app_deployment"><span class="">Vehicle App Deployment</span></a></label>

<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-velocitas-docsdocstutorialsvehicle_app_deploymentpodspecs_deployment-li">
<input type="checkbox" id="m-velocitas-docsdocstutorialsvehicle_app_deploymentpodspecs_deployment-check"/>
<label for="m-velocitas-docsdocstutorialsvehicle_app_deploymentpodspecs_deployment-check"><a href="/velocitas-docs/docs/tutorials/vehicle_app_deployment/podspecs_deployment/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-velocitas-docsdocstutorialsvehicle_app_deploymentpodspecs_deployment"><span class="">PodSpecs Deployment</span></a></label>

</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-velocitas-docsdocstutorialsvehicle_app_deploymenthelm_deployment-li">
<input type="checkbox" id="m-velocitas-docsdocstutorialsvehicle_app_deploymenthelm_deployment-check"/>
<label for="m-velocitas-docsdocstutorialsvehicle_app_deploymenthelm_deployment-check"><a href="/velocitas-docs/docs/tutorials/vehicle_app_deployment/helm_deployment/" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id="m-velocitas-docsdocstutorialsvehicle_app_deploymenthelm_deployment"><span class="">Helm Deployment</span></a></label>

</li>
</ul>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id="m-velocitas-docsdocscontribution-guidelines-li">
Expand Down Expand Up @@ -657,7 +642,7 @@ <h5>


<div class="text-muted mt-5 pt-3 border-top">
Last modified February 27, 2024: <a href="https://github.com/eclipse-velocitas/velocitas-docs/commit/383f29a4d4b5cf87e794b07485ab36b9b0f8cb1b">Version fixes and removal of strange header of rendered page (#117) (383f29a)</a>
Last modified May 31, 2024: <a href="https://github.com/eclipse-velocitas/velocitas-docs/commit/976a356437d520b8ad4f9e0af1ceb4fdc1b6d203">Another fix of cpp_development.md (976a356)</a>
</div>

</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/about/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -111,25 +111,25 @@
&lt;tr&gt;
&lt;td&gt;

&lt;a href=&#34;https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker&#34; target=&#34;_blank&#34; rel=&#34;noopener&#34;&gt;kuksa.val&lt;/a&gt;
&lt;a href=&#34;https://github.com/eclipse-kuksa/kuksa-databroker&#34; target=&#34;_blank&#34; rel=&#34;noopener&#34;&gt;kuksa-databroker&lt;/a&gt;
&lt;/td&gt;
&lt;td&gt;Is a part of the &lt;em&gt;Vehicle Abstraction Layer (VAL)&lt;/em&gt; of the

&lt;a href=&#34;https://www.eclipse.org/kuksa/&#34; target=&#34;_blank&#34; rel=&#34;noopener&#34;&gt;Eclipse KUKSA project&lt;/a&gt;
and provides the KUKSA Data Broker (aka Vehicle Data Broker). The KUKSA Data Broker offers data points available in the vehicle to the &lt;em&gt;Vehicle Apps&lt;/em&gt; semantically aligned to a data model like the
&lt;a href=&#34;https://github.com/eclipse-kuksa&#34; target=&#34;_blank&#34; rel=&#34;noopener&#34;&gt;Eclipse KUKSA project&lt;/a&gt;
and provides the KUKSA Databroker. The KUKSA Databroker offers data points available in the vehicle to the &lt;em&gt;Vehicle Apps&lt;/em&gt; semantically aligned to a data model like the

&lt;a href=&#34;https://covesa.github.io/vehicle_signal_specification/&#34; target=&#34;_blank&#34; rel=&#34;noopener&#34;&gt;Vehicle Signal Specification (VSS)&lt;/a&gt;
.&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;

&lt;a href=&#34;https://github.com/eclipse/kuksa.val.feeders/tree/main/dbc2val&#34; target=&#34;_blank&#34; rel=&#34;noopener&#34;&gt;kuksa.val.feeders&lt;/a&gt;
&lt;a href=&#34;https://github.com/eclipse-kuksa/kuksa-can-provider&#34; target=&#34;_blank&#34; rel=&#34;noopener&#34;&gt;kuksa-can-provider&lt;/a&gt;
&lt;/td&gt;
&lt;td&gt;The KUKSA DBC Feeder is a generic data feeder that reads data from the vehicle&amp;rsquo;s
&lt;td&gt;The KUKSA CAN Provider is a generic data feeder that reads data from the vehicle&amp;rsquo;s

&lt;a href=&#34;https://en.wikipedia.org/wiki/CAN_bus&#34; target=&#34;_blank&#34; rel=&#34;noopener&#34;&gt;CAN bus&lt;/a&gt;
defined by a DBC file, maps them to a set of data points (e.g. according to the VSS) and feeds it into the Data Broker.&lt;/td&gt;
defined by a DBC file, maps them to a set of data points (e.g. according to the VSS) and feeds it into the Databroker.&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;
Expand Down
Loading

0 comments on commit 7aade30

Please sign in to comment.