Update documentation

This commit is contained in:
Konstantin Lampalzer 2022-11-01 23:06:23 +01:00
parent 5bea85af12
commit bcaeff1a1c
23 changed files with 377 additions and 1 deletions

291
other/hardware.html Normal file
View file

@ -0,0 +1,291 @@
<!DOCTYPE html>
<html class="writer-html5" lang="de" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Hardware &mdash; CompLib 0.2.3 Dokumentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/translations.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Stichwortverzeichnis" href="../genindex.html" />
<link rel="search" title="Suche" href="../search.html" />
<link rel="prev" title="Motoren" href="../lib/classes/Motor.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html">
<img src="../_static/compair-logo-white.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Dokumentation durchsuchen" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../gettingStarted/index.html">Erste Schritte</a></li>
<li class="toctree-l1"><a class="reference internal" href="../software/installation.html">Installationsanweisungen</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Beispiele</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lib/index.html">compLib</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Hardware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#sensorarray">Sensorarray</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#specs-v4">Specs V4</a></li>
<li class="toctree-l3"><a class="reference internal" href="#specs-v2">Specs V2</a></li>
<li class="toctree-l3"><a class="reference internal" href="#details">Details</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#motorboard">Motorboard</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#specs">Specs</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">Details</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#mainboard">Mainboard</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id3">Specs</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Details</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CompLib</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>Hardware</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/other/hardware.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="hardware">
<span id="other-bardware"></span><h1>Hardware<a class="headerlink" href="#hardware" title="Permalink to this heading"></a></h1>
<div class="section" id="sensorarray">
<h2>Sensorarray<a class="headerlink" href="#sensorarray" title="Permalink to this heading"></a></h2>
<p><img alt="SensorarrayImage" src="../_images/Sensorarray.png" /></p>
<div class="section" id="specs-v4">
<h3>Specs V4<a class="headerlink" href="#specs-v4" title="Permalink to this heading"></a></h3>
<div class="line-block">
<div class="line"><strong>Processor:</strong> <a class="reference external" href="https://mou.sr/3UxW49B">STM32G030F6P6</a> - 32-bit ARM Cortex M0 CPU &#64; 64 MHz</div>
<div class="line"><strong>I/O:</strong> 1x I2C, 1x SWD</div>
<div class="line"><strong>Sensors:</strong> 5x <a class="reference external" href="https://mou.sr/3TWGYdI">QRE1113GR</a></div>
</div>
</div>
<div class="section" id="specs-v2">
<h3>Specs V2<a class="headerlink" href="#specs-v2" title="Permalink to this heading"></a></h3>
<div class="line-block">
<div class="line"><strong>Processor:</strong> <a class="reference external" href="https://mou.sr/3FxhPC5">ATMEGA328P-AU</a> - 8-bit CPU &#64; 16 MHz</div>
<div class="line"><strong>I/O:</strong> 1x I2C, 1x UART, 1x ISP</div>
<div class="line"><strong>Sensors:</strong> 5x <a class="reference external" href="https://mou.sr/3TWGYdI">QRE1113GR</a></div>
</div>
</div>
<div class="section" id="details">
<h3>Details<a class="headerlink" href="#details" title="Permalink to this heading"></a></h3>
<p>Das Sensorarray wird verwendet um Linienen vor dem Roboter zu erkennen. Es agiert als I2C Slave und muss dementsprechend aktiv gepollt werden.
Zusätzlich besteht die möglichkeit alle Emitter zu deaktiviern um einen eventuellen Messfehler durch Sonneneinstralung oder andere Störquellen zu erkennen.</p>
<p>Version 4 unterscheidet sich zu Version 2 im Mikroprozessor, da es zu Lieferengpässen des ATMEGA gekommen ist.
Zusätzlich wurde die möglichkeit alle Emitter einzeln an bzw. auszuschalten entfernt, da diese keinen signifikanten Mehrwert brachte.</p>
</div>
</div>
<div class="section" id="motorboard">
<h2>Motorboard<a class="headerlink" href="#motorboard" title="Permalink to this heading"></a></h2>
<p><img alt="MainboardImage" src="../_images/Mainboard.png" /></p>
<div class="section" id="specs">
<h3>Specs<a class="headerlink" href="#specs" title="Permalink to this heading"></a></h3>
<p><strong>Motor-Treiber:</strong> <a class="reference external" href="https://mou.sr/3TXbFzu">LV8548MC-AH</a></p>
</div>
<div class="section" id="id2">
<h3>Details<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<p>Das Motorboard kann an einen der 4 Ports am Roboter angesteckt werden und ermöglicht das Ansteuern von Motoren und auslesen von Encodern.</p>
</div>
</div>
<div class="section" id="mainboard">
<h2>Mainboard<a class="headerlink" href="#mainboard" title="Permalink to this heading"></a></h2>
<div class="section" id="id3">
<h3>Specs<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<div class="line-block">
<div class="line"><strong>Processor:</strong> <a class="reference external" href="https://mou.sr/3fuaAQv">STM32L051C8T6TR</a> - 32-bit ARM Cortex M0 &#64; 32MHz</div>
<div class="line"><strong>I/O:</strong> 4x I2C (3x Bus 1, 1x Bus 2), 1x 40 Pin GPIO Header, 2x SPI (Verbunden mit GPIO), 4x Motor-/Servo-connector, 1x SWD, 1x USB-C</div>
</div>
</div>
<div class="section" id="id4">
<h3>Details<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<p>Das Mainboard wird auf den GPIO-Header eines Raspberry Pi gesteckt und ermöglicht die Steuerung eines Roboters mittels 4 Motor- bzw. Servo-Ports. Der RaspberryPi kommuniziert dabei mittels SPI mit dem Mainboard und steuert die einzelnen Sensoren oder Module an.
Zusätzlich befinden sich auf der Unterseite des Mainboards Lötstellen, welche direkt mit der Stromversorgung der Motoren verbunden sind und geben so die möglichkeit Motoren mit mehr als 5V anzusteuern.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../lib/classes/Motor.html" class="btn btn-neutral float-left" title="Motoren" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Zurück</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS)
</p>
</div>
Erstellt mit <a href="http://sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View file

@ -98,6 +98,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../lib/index.html">compLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
</ul>