wifi-tally_Oostendam/documentation/build/index.html

205 lines
9.6 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Tallies in Oostendam &mdash; Oostendam Tallies documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/drawio.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<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/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Tallies Overview" href="overview.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="#" class="icon icon-home"> Oostendam Tallies
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Build:</span></p>
<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="hardware/index.html">Hardware Setup</a></li>
2023-01-28 15:48:26 +00:00
<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>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Oostendam Tallies</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Tallies in Oostendam</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="tallies-in-oostendam">
<h1>Tallies in Oostendam<a class="headerlink" href="#tallies-in-oostendam" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Build:</span></p>
<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#software">Software</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware Setup</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#build-a-tally">Build a Tally</a></li>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#build-the-firmware">Build the firmware</a></li>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#flash-the-firmware">Flash the firmware</a></li>
2023-01-28 15:48:26 +00:00
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#flash-the-application">Flash the Application</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="server/index.html">Server</a><ul>
<li class="toctree-l2"><a class="reference internal" href="server/index.html#build-the-server">Build the server</a></li>
</ul>
</li>
</ul>
</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 id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading"></a></h1>
<p>This document contains the documentation for the tallies used in the <a class="reference external" href="https://kerkdienstgemist.nl/stations/2112-Immanuelkapel">Immanuelkapel in Oostendam</a>.
The goal in this project is to provide <em>cheap</em> indicator lights to show which camera is active during the service.
This way the minister knows which of the cameras is active and use it during the service.</p>
<p>This project relies heavily on an <a class="reference external" href="https://github.com/wifi-tally/wifi-tally/">existing project on github</a>.
The main difference between this code and the project on github is the behaviour of the tally lights.</p>
<section id="contact">
<h2>Contact<a class="headerlink" href="#contact" title="Permalink to this heading"></a></h2>
<p>To contact our church you can see our contact details below:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 32%" />
<col style="width: 68%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"></th>
<th class="head"><p>Immanuëlkapel (Oostendam)</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Street</p></td>
<td><p>Pruimendijk 99</p></td>
</tr>
<tr class="row-odd"><td><p>Postal code</p></td>
<td><p>2989 AH Ridderkerk</p></td>
</tr>
<tr class="row-even"><td><p>Phone</p></td>
<td><p>078-6819880</p></td>
</tr>
</tbody>
</table>
2023-01-28 15:48:26 +00:00
<section id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this heading"></a></h3>
<p>Install the following Dependencies:</p>
<blockquote>
<div><ul class="simple">
<li><p>luarocks : <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">luarocks</span></code></p></li>
<li><p>busted : <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">luarocks</span> <span class="pre">install</span> <span class="pre">busted</span></code></p></li>
<li><p>python3 : <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">python3</span></code></p></li>
<li><p>esptool : <code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">esptool</span></code></p></li>
<li><p>nodemcu-uploader : <code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">nodemcu-uploader</span></code></p></li>
</ul>
</div></blockquote>
<p>Install on the Server PC:</p>
<blockquote>
<div><ul class="simple">
<li><p>NodeJS : <a class="reference external" href="https://nodejs.org/">https://nodejs.org/</a></p></li>
<li><p>Next : <code class="docutils literal notranslate"><span class="pre">npm</span> <span class="pre">install</span> <span class="pre">next</span></code></p></li>
</ul>
</div></blockquote>
</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>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="overview.html" class="btn btn-neutral float-right" title="Tallies Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Eljakim.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>