170 lines
7.4 KiB
HTML
170 lines
7.4 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<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>OwlBoard Components - OwlBoard Documentation</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "OwlBoard Components";
|
|
var mkdocs_page_input_path = "components.md";
|
|
var mkdocs_page_url = null;
|
|
</script>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
|
<script>hljs.highlightAll();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> OwlBoard Documentation
|
|
</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" aria-label="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="" href="https://owlboard.info">Go to OwlBoard</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Website</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Welcome</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../registering/">Registering for OwlBoard</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pages/">Pages</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pis/">PIS</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../timetable/">Timetable Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../departures/">Departure Boards</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../menu/">Menu</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../code-lookup/">Code Lookup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../settings/">Settings</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../api-intro/">OwlBoard API</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Components</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">OwlBoard Components</a>
|
|
<ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="#web">Web</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#api-server">API Server</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#timetable-manager">Timetable Manager</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#diagram-parser">Diagram Parser</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">OwlBoard Documentation</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=".." class="icon icon-home" aria-label="Docs"></a></li>
|
|
<li class="breadcrumb-item">Components</li>
|
|
<li class="breadcrumb-item active">OwlBoard Components</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<h1 id="owlboard-components">OwlBoard Components</h1>
|
|
<p>OwlBoard is powered by several programs.</p>
|
|
<h2 id="web">Web</h2>
|
|
<p>The OwlBoard website is powered by Svelte. The speed is improved by installing components into your browser to reduce the amount of data that flows between the server and your device.</p>
|
|
<p>It has been designed to work well over very weak connections.</p>
|
|
<h2 id="api-server">API Server</h2>
|
|
<p>The OwlBoard API Server is powered by ExpressJS. The responses are kept as small as possible to improve performance over weak connections.</p>
|
|
<p>The API Server is what provides data to the OwlBoard website.</p>
|
|
<h2 id="timetable-manager">Timetable Manager</h2>
|
|
<p>timetable-mgr is the newest addition to the OwlBoard suite. Replacing db-manager.</p>
|
|
<p>timetable-mgr fetches timetable data from Network Rail daily, and also listens for VSTP messages which adds VSTP planned trains into the local timetable.</p>
|
|
<p>It is written in Go for fast performance.</p>
|
|
<h2 id="diagram-parser">Diagram Parser</h2>
|
|
<p>dg-parser reads diagrams and extracts headcodes and PIS codes before referencing the timetable to find which service the PIS code is valid for. These PIS codes are then semi-automatically added to OwlBoard.</p>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../api-intro/" class="btn btn-neutral float-left" title="OwlBoard API"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</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>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
|
|
<span><a href="../api-intro/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
</span>
|
|
</div>
|
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
|
<script>var base_url = "..";</script>
|
|
<script src="../js/theme_extra.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
<script src="../search/main.js"></script>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|