EljakimHerrewijnen/wifi-tally_Oostendam
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed docs to include troubleshooting and pictures

Browse Source
This commit is contained in:
Eljakim Herrewijnen 2023-01-28 17:00:06 +01:00
parent 5e6b883f51
commit 3b49cebba5
14 changed files with 79 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
documentation/build/.doctrees/environment.pickle
View File

Binary file not shown.

BIN
documentation/build/.doctrees/index.doctree
View File

Binary file not shown.

BIN
documentation/build/.doctrees/troubleshooting.doctree
View File

Binary file not shown.

BIN
documentation/build/_images/kerk_tally.jpeg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 86 KiB

12
documentation/build/_sources/index.rst.txt
View File

@ -8,18 +8,20 @@ Tallies in Oostendam
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Build:
overview.rst overview.rst
hardware/index.rst hardware/index.rst
server/index.rst server/index.rst
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Development: :caption: Development:
patches.rst patches.rst
Troubleshooting.rst troubleshooting.rst
Introduction Introduction
============ ============
@ -49,3 +51,9 @@ To contact our church you can see our contact details below:
.. include:: dependencies.rst .. include:: dependencies.rst
Result
******
The tally in our Church in Oostendam:
.. image:: kerk_tally.jpeg

2
documentation/build/_sources/troubleshooting.rst.txt
View File

@ -33,3 +33,5 @@ ESPlorer
# Run it # Run it
java -jar target/ESPlorer.jar java -jar target/ESPlorer.jar
The ``ESPlorer`` can be used to interact with the ``esp8266`` and flash binaries using a GUI.

7
documentation/build/genindex.html
View File

@ -37,11 +37,16 @@
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Build:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a></li> <li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a></li> <li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="patches.html">Tally Patches</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul> </ul>
</div> </div>

27
documentation/build/index.html
View File

@ -39,11 +39,16 @@
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Build:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a></li> <li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a></li> <li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="patches.html">Tally Patches</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul> </ul>
</div> </div>
@ -73,7 +78,7 @@
<section id="tallies-in-oostendam"> <section id="tallies-in-oostendam">
<h1>Tallies in Oostendam<a class="headerlink" href="#tallies-in-oostendam" title="Permalink to this heading"></a></h1> <h1>Tallies in Oostendam<a class="headerlink" href="#tallies-in-oostendam" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Build:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a><ul> <li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#hardware">Hardware</a></li> <li class="toctree-l2"><a class="reference internal" href="overview.html#hardware">Hardware</a></li>
@ -93,6 +98,19 @@
</li> </li>
</ul> </ul>
</div> </div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Development:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="patches.html">Tally Patches</a><ul>
<li class="toctree-l2"><a class="reference internal" href="patches.html#led-patches">LED patches</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#esplorer">ESPlorer</a></li>
</ul>
</li>
</ul>
</div>
</section> </section>
<section id="introduction"> <section id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading"></a></h1> <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading"></a></h1>
@ -147,6 +165,11 @@ The main difference between this code and the project on github is the behaviour
</div></blockquote> </div></blockquote>
</section> </section>
</section> </section>
<section id="result">
<h2>Result<a class="headerlink" href="#result" title="Permalink to this heading"></a></h2>
<p>The tally in our Church in Oostendam:</p>
<img alt="_images/kerk_tally.jpeg" src="_images/kerk_tally.jpeg" />
</section>
</section> </section>

7
documentation/build/search.html
View File

@ -40,11 +40,16 @@
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Build:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a></li> <li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a></li> <li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="patches.html">Tally Patches</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul> </ul>
</div> </div>

2
documentation/build/searchindex.js
View File

File diff suppressed because one or more lines are too long

16
documentation/build/troubleshooting.html
View File

@ -21,6 +21,7 @@
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Tally Patches" href="patches.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -38,11 +39,19 @@
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Build:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="overview.html">Tallies Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a></li> <li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a></li> <li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="patches.html">Tally Patches</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#esplorer">ESPlorer</a></li>
</ul>
</li>
</ul> </ul>
</div> </div>
@ -97,13 +106,16 @@ Removing this rule will stop udev from hijacking the USB device.</p>
java -jar target/ESPlorer.jar java -jar target/ESPlorer.jar
</pre></div> </pre></div>
</div> </div>
<p>The <code class="docutils literal notranslate"><span class="pre">ESPlorer</span></code> can be used to interact with the <code class="docutils literal notranslate"><span class="pre">esp8266</span></code> and flash binaries using a GUI.</p>
</section> </section>
</section> </section>
</div> </div>
</div> </div>
<footer> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="patches.html" class="btn btn-neutral float-left" title="Tally Patches" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/> <hr/>

12
documentation/source/index.rst
View File

@ -8,18 +8,20 @@ Tallies in Oostendam
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Build:
overview.rst overview.rst
hardware/index.rst hardware/index.rst
server/index.rst server/index.rst
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Development: :caption: Development:
patches.rst patches.rst
Troubleshooting.rst troubleshooting.rst
Introduction Introduction
============ ============
@ -49,3 +51,9 @@ To contact our church you can see our contact details below:
.. include:: dependencies.rst .. include:: dependencies.rst
Result
******
The tally in our Church in Oostendam:
.. image:: kerk_tally.jpeg

BIN
documentation/source/kerk_tally.jpeg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 86 KiB

2
documentation/source/troubleshooting.rst
View File

@ -33,3 +33,5 @@ ESPlorer
# Run it # Run it
java -jar target/ESPlorer.jar java -jar target/ESPlorer.jar
The ``ESPlorer`` can be used to interact with the ``esp8266`` and flash binaries using a GUI.