EljakimHerrewijnen/wifi-tally_Oostendam
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
master
wifi-tally_Oostendam/documentation/build/overview.html

162 lines
7.9 KiB
HTML
Raw Permalink Normal View History

Added start of RTD docs for this project
2023-01-23 22:25:17 +00:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
Added .bat file for runserver and migration files
2023-05-08 19:18:58 +00:00
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
Added start of RTD docs for this project
2023-01-23 22:25:17 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Tallies Overview &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/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" />
Added .bat file for runserver and migration files
2023-05-08 19:18:58 +00:00
<link rel="next" title="Hardware Setup" href="hardware/index.html" />
Added start of RTD docs for this project
2023-01-23 22:25:17 +00:00
<link rel="prev" title="Tallies in Oostendam" href="index.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" 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">
Added .bat file for runserver and migration files
2023-05-08 19:18:58 +00:00
<p class="caption" role="heading"><span class="caption-text">Build:</span></p>
Added start of RTD docs for this project
2023-01-23 22:25:17 +00:00
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Tallies Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#hardware">Hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="#software">Software</a></li>
</ul>
</li>
Added .bat file for runserver and migration files
2023-05-08 19:18:58 +00:00
<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>
</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>
<p class="caption" role="heading"><span class="caption-text">Migrating:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="migration.html">Migrating to a new PC</a></li>
Added start of RTD docs for this project
2023-01-23 22:25:17 +00:00
</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="index.html">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="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Tallies Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/overview.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-overview">
<h1>Tallies Overview<a class="headerlink" href="#tallies-overview" title="Permalink to this heading"></a></h1>
<p>This page gives a short overview of how the tallies work in relation to the camera’s. A simple overview of the tallies in correlation between the server and the streamer is shown below:</p>
<img alt="_images/overview.svg" class="drawio" src="_images/overview.svg" /><section id="hardware">
<h2>Hardware<a class="headerlink" href="#hardware" title="Permalink to this heading"></a></h2>
<p>The hardware for the tallies is an <code class="docutils literal notranslate"><span class="pre">esp8266</span></code> microcontroller, as they can be found <a class="reference external" href="https://www.amazon.nl/Diymore-ESP8266-WiFi-ontwikkelingskaart-NodeMCU-ESP-12E-module/dp/B09Z6T2XS4/ref=sr_1_2_sspa?__mk_nl_NL=%C3%85M%C3%85%C5%BD%C3%95%C3%91&amp;crid=3DHTKU7SQKET9&amp;keywords=esp8266&amp;qid=1674509572&amp;sprefix=esp8266%2Caps%2C135&amp;sr=8-2-spons&amp;sp_csd=d2lkZ2V0TmFtZT1zcF9hdGY&amp;psc=1">on Amazon</a>.
These microcontrollers are very cheap but are capable of using the <code class="docutils literal notranslate"><span class="pre">802.11</span> <span class="pre">b/g/n</span></code> wifi standard(<code class="docutils literal notranslate"><span class="pre">IEEE</span></code>).</p>
<p>A quick overview of the hardware:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>CPU</p></td>
<td><p>32Bit RISC based on <code class="docutils literal notranslate"><span class="pre">Xtensa</span> <span class="pre">lx106</span></code></p></td>
</tr>
<tr class="row-odd"><td><p>Instruction RAM</p></td>
<td><p>32 KiB</p></td>
</tr>
<tr class="row-even"><td><p>Instruction Cache</p></td>
<td><p>32 KiB</p></td>
</tr>
<tr class="row-odd"><td><p>User Data RAM</p></td>
<td><p>80 KiB</p></td>
</tr>
<tr class="row-even"><td><p>System Data RAM</p></td>
<td><p>16 KiB</p></td>
</tr>
<tr class="row-odd"><td><p>Flash Memory (External)</p></td>
<td><p>4 MiB</p></td>
</tr>
</tbody>
</table>
<p>Of the 17 GPIO pins available, only 3 are used for the RGB colouring.
Wifi is used for communication between the tallies and a server that will tell the tally to turn on the lights.</p>
</section>
<section id="software">
<h2>Software<a class="headerlink" href="#software" title="Permalink to this heading"></a></h2>
<p>On the Host a <code class="docutils literal notranslate"><span class="pre">NodeJS</span></code> server is run that opens a websocket on port <code class="docutils literal notranslate"><span class="pre">7411</span></code>.
This websockets waits for tallies to connect and sends data to them when connected.
The server also connects to the streamer, in our case a <code class="docutils literal notranslate"><span class="pre">Black</span> <span class="pre">Magic</span> <span class="pre">ATEM</span></code> that controls the camera’s.
The streamer gives information about which camera is active which is passed to the tallies.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Tallies in Oostendam" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
Added .bat file for runserver and migration files
2023-05-08 19:18:58 +00:00
<a href="hardware/index.html" class="btn btn-neutral float-right" title="Hardware Setup" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
Added start of RTD docs for this project
2023-01-23 22:25:17 +00:00
</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>
Reference in New Issue Copy Permalink