craftbeerpi4-pione/docs/index.html

259 lines
8 KiB
HTML
Raw Normal View History

2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to CraftBeerPis documentation! &mdash; CraftBeerPi 4.0 documentation</title>
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="install.html" />
2018-11-18 15:40:10 +01:00
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
<script src="_static/js/modernizr.min.js"></script>
</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"> CraftBeerPi
</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="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="core.html">Core</a></li>
<li class="toctree-l1"><a class="reference internal" href="actor.html">Actor</a></li>
<li class="toctree-l1"><a class="reference internal" href="sensor.html">Sensor</a></li>
<li class="toctree-l1"><a class="reference internal" href="step.html">Brewing Step</a></li>
<li class="toctree-l1"><a class="reference internal" href="kettle_controller.html">Kettle</a></li>
<li class="toctree-l1"><a class="reference internal" href="properties.html">Properties</a></li>
2018-12-10 22:13:28 +01:00
<li class="toctree-l1"><a class="reference internal" href="standards.html">Standard &amp; Guidelines</a></li>
2018-12-09 22:20:33 +01:00
</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="#">CraftBeerPi</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> &raquo;</li>
<li>Welcome to CraftBeerPis documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
</li>
</ul>
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
2018-11-16 20:59:19 +01:00
<div class="section" id="welcome-to-craftbeerpi-s-documentation">
<h1>Welcome to CraftBeerPis documentation!<a class="headerlink" href="#welcome-to-craftbeerpi-s-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
2018-11-18 15:40:10 +01:00
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
2018-11-16 21:59:41 +01:00
<li class="toctree-l1"><a class="reference internal" href="core.html">Core</a></li>
<li class="toctree-l1"><a class="reference internal" href="actor.html">Actor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="actor.html#architecture">Architecture</a></li>
2018-12-08 14:21:00 +01:00
<li class="toctree-l2"><a class="reference internal" href="actor.html#actorcontroller">ActorController</a></li>
<li class="toctree-l2"><a class="reference internal" href="actor.html#cbpiactor">CBPiActor</a></li>
2018-11-16 21:59:41 +01:00
<li class="toctree-l2"><a class="reference internal" href="actor.html#custom-actor">Custom Actor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sensor.html">Sensor</a><ul>
2018-12-09 22:20:33 +01:00
<li class="toctree-l2"><a class="reference internal" href="sensor.html#sensor-controller">Sensor Controller</a></li>
<li class="toctree-l2"><a class="reference internal" href="sensor.html#cbpisensor">CBPiSensor</a></li>
2018-11-16 21:59:41 +01:00
<li class="toctree-l2"><a class="reference internal" href="sensor.html#custom-sensor">Custom Sensor</a></li>
</ul>
</li>
2018-12-08 14:21:00 +01:00
<li class="toctree-l1"><a class="reference internal" href="step.html">Brewing Step</a><ul>
<li class="toctree-l2"><a class="reference internal" href="step.html#stepcontroller">StepController</a></li>
2018-12-10 22:13:28 +01:00
<li class="toctree-l2"><a class="reference internal" href="step.html#cbpisimplestep">CBPiSimpleStep</a></li>
2018-12-08 14:21:00 +01:00
<li class="toctree-l2"><a class="reference internal" href="step.html#custom-step">Custom Step</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kettle_controller.html">Kettle</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kettle_controller.html#kettlecontroller">KettleController</a></li>
<li class="toctree-l2"><a class="reference internal" href="kettle_controller.html#cbpikettlelogic">CBPiKettleLogic</a></li>
<li class="toctree-l2"><a class="reference internal" href="kettle_controller.html#custom-logic">Custom Logic</a></li>
</ul>
</li>
2018-12-09 22:20:33 +01:00
<li class="toctree-l1"><a class="reference internal" href="properties.html">Properties</a><ul>
<li class="toctree-l2"><a class="reference internal" href="properties.html#custom-actor">Custom Actor</a></li>
</ul>
</li>
2018-12-10 22:13:28 +01:00
<li class="toctree-l1"><a class="reference internal" href="standards.html">Standard &amp; Guidelines</a><ul>
<li class="toctree-l2"><a class="reference internal" href="standards.html#python">Python</a><ul>
<li class="toctree-l3"><a class="reference internal" href="standards.html#eventbus">CBPiEventBus</a></li>
2018-12-10 22:29:27 +01:00
<li class="toctree-l3"><a class="reference internal" href="standards.html#http-endpoints">HTTP Endpoints</a></li>
<li class="toctree-l3"><a class="reference internal" href="standards.html#websocket">WebSocket</a></li>
2018-12-10 22:13:28 +01:00
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="standards.html#web-user-interface">Web User Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="standards.html#rest-api">REST API</a></li>
</ul>
</li>
2018-11-16 20:59:19 +01:00
</ul>
</div>
</div>
2018-12-09 22:20:33 +01:00
</div>
2018-11-16 20:59:19 +01:00
</div>
2018-12-09 22:20:33 +01:00
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="install.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
<hr/>
2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
<div role="contentinfo">
<p>
&copy; Copyright 2018, Manuel Fritsch
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
</footer>
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
</div>
</div>
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
</section>
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
</div>
2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
<script type="text/javascript" src="_static/js/theme.js"></script>
2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
2018-11-16 20:59:19 +01:00
2018-12-09 22:20:33 +01:00
</body>
2018-11-16 20:48:01 +01:00
</html>