Skip to content

Commit

Permalink
update mkdocs: CUBE EVK recipe
Browse files Browse the repository at this point in the history
  • Loading branch information
riebl committed Nov 30, 2023
1 parent 6c6e5a2 commit e801a63
Show file tree
Hide file tree
Showing 15 changed files with 182 additions and 26 deletions.
14 changes: 13 additions & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="/recipes/cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="/recipes/cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="/recipes/cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="/recipes/cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="/recipes/cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="/recipes/cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="/recipes/cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down
14 changes: 13 additions & 1 deletion api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../recipes/cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="../recipes/cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="../recipes/cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="../recipes/cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down
14 changes: 13 additions & 1 deletion how-to-build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../recipes/cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="../recipes/cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="../recipes/cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="../recipes/cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down
16 changes: 14 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="recipes/cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="recipes/cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="recipes/cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="recipes/cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="recipes/cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="recipes/cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="recipes/cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -390,5 +402,5 @@ <h2 id="deployments">Deployments</h2>

<!--
MkDocs version : 1.5.2
Build Date UTC : 2023-11-30 11:04:34.127969+00:00
Build Date UTC : 2023-11-30 12:10:20.714245+00:00
-->
14 changes: 13 additions & 1 deletion legal/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../recipes/cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="../recipes/cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="../recipes/cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="../recipes/cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../recipes/cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down
14 changes: 13 additions & 1 deletion recipes/autotalks-sdk-build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="../cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="../cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="../cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down
14 changes: 13 additions & 1 deletion recipes/cohda-sdk-build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="../cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="../cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="../cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down
16 changes: 14 additions & 2 deletions recipes/cross-compile-dependencies/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="../cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="../cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="../cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -270,7 +282,7 @@ <h2 id="geographiclib">GeographicLib</h2>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../cohda-sdk-build/" class="btn btn-neutral float-left" title="Building for Cohda MK5"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../cube-evk-build/" class="btn btn-neutral float-right" title="Running socktap on nfiniity devices">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../cube-evk-build/" class="btn btn-neutral float-right" title="Building for CUBE EVK">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>
Expand Down
32 changes: 22 additions & 10 deletions recipes/cube-evk-build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>Running socktap on nfiniity devices - Vanetza - Your open-source ETSI C-ITS protocol stack</title>
<title>Building for CUBE EVK - Vanetza - Your open-source ETSI C-ITS protocol stack</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link href="../../css/extra.css" rel="stylesheet" />
<link href="../../css/tango.css" rel="stylesheet" />

<script>
// Current page data
var mkdocs_page_name = "Running socktap on nfiniity devices";
var mkdocs_page_name = "Building for CUBE EVK";
var mkdocs_page_input_path = "recipes/cube-evk-build.md";
var mkdocs_page_url = null;
</script>
Expand Down Expand Up @@ -112,8 +112,20 @@
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Running socktap on nfiniity devices</a>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Building for CUBE EVK</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -211,7 +223,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a> &raquo;</li>
<li>Recipes &raquo;</li>
<li class="breadcrumb-item active">Running socktap on nfiniity devices</li>
<li class="breadcrumb-item active">Building for CUBE EVK</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/riebl/vanetza/edit/master/docs/recipes/cube-evk-build.md" class="icon icon-github"> Edit on GitHub</a>
</li>
Expand All @@ -221,24 +233,24 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">

<h1 id="introduction">Introduction</h1>
<h1 id="building-for-cube-evk">Building for CUBE EVK</h1>
<p>The CUBE EVK from <a href="https://www.nfiniity.com/#portfolio">nfiniity</a> fully supports the Vanetza stack and its socktap application. An integrated V2X module listens for requests whether from a local or remote application. The communication protocol between host and V2X module is covered in Google&rsquo;s Protobuf that is used in the respective link-layer implementation.</p>
<h1 id="configuration">Configuration</h1>
<h2 id="configuration">Configuration</h2>
<p>Before building and running socktap you need to configure the V2X module and the WiFi once.</p>
<h2 id="v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</h2>
<h3 id="v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</h3>
<p>First of all select your desired radio configuration using the <code>v2xconfig</code> tool on the EVK:</p>
<pre class="codehilite"><code class="language-shell"># start dsrc or cv2x and enable auto-start
cube&gt; v2xconfig start enable dsrc
</code></pre>

<h2 id="connect-to-your-local-wifi">Connect to your local WiFi</h2>
<h3 id="connect-to-your-local-wifi">Connect to your local WiFi</h3>
<p>This is only needed for the wireless remote radio mode.</p>
<pre class="codehilite"><code class="language-shell">cube&gt; sudo nmcli dev wifi connect '&lt;ssid&gt;' password '&lt;password&gt;'
# get your ip
cube&gt; ip a
</code></pre>

<h1 id="building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</h1>
<h2 id="building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</h2>
<p>You can build and run socktap directly on your personal computer (host) and select <code>cube-evk</code> as link-layer. Further, gpsd daemon is running on the EVK that can feed socktap with GNSS data. </p>
<p>In <code>wireless remote radio mode</code> you develop, debug and run Vanetza/socktap on your personal computer. There is no need to flash or transfer the application onto your EVK. The V2X radio on the EVK listens for incoming requests from remote. Both devices need to be pingable from each other only.</p>
<pre class="codehilite"><code class="language-shell">host&gt; mkdir build &amp;&amp; cd build
Expand All @@ -252,7 +264,7 @@ <h1 id="building-and-running-socktap-for-wireless-remote-radio-mode">Building an
</code></pre>

<p>Moreover, the integrated LTE module allows the user to do field tests with the EVK from remote.</p>
<h1 id="building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</h1>
<h2 id="building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</h2>
<p>You can also build and run socktap on the EVK itself and it will connect to the local V2X module.</p>
<pre class="codehilite"><code class="language-shell">cube&gt; mkdir build &amp;&amp; cd build
cube&gt; cmake -DBUILD_SOCKTAP=ON -DSOCKTAP_WITH_CUBE_EVK=ON ..
Expand Down
14 changes: 13 additions & 1 deletion search.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,20 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="./recipes/cube-evk-build/">Running socktap on nfiniity devices</a>
<li class="toctree-l1"><a class="reference internal" href="./recipes/cube-evk-build/">Building for CUBE EVK</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="./recipes/cube-evk-build/#configuration">Configuration</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="./recipes/cube-evk-build/#v2x-radio-configuration-c-v2x-or-dsrc">V2X Radio Configuration - C-V2X or DSRC</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="./recipes/cube-evk-build/#connect-to-your-local-wifi">Connect to your local WiFi</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="./recipes/cube-evk-build/#building-and-running-socktap-for-wireless-remote-radio-mode">Building and Running Socktap for Wireless Remote Radio Mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="./recipes/cube-evk-build/#building-and-running-socktap-on-the-evk">Building and Running Socktap on the EVK</a>
</li>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.
Loading

0 comments on commit e801a63

Please sign in to comment.