mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-12-01 11:14:15 +01:00
232 lines
6.5 KiB
HTML
232 lines
6.5 KiB
HTML
|
|
||
|
|
|
||
|
|
<!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>REST API — CraftBeerPi 4.0 documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<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="prev" title="Standard & Guidelines" href="standards.html" />
|
||
|
|
|
||
|
|
|
||
|
|
<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="index.html" 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 class="current">
|
||
|
|
<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>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="standards.html">Standard & Guidelines</a></li>
|
||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">REST API</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="#websocket-api">WebSocket API</a></li>
|
||
|
|
</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="index.html">CraftBeerPi</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="index.html">Docs</a> »</li>
|
||
|
|
|
||
|
|
<li>REST API</li>
|
||
|
|
|
||
|
|
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
|
||
|
|
|
||
|
|
<a href="_sources/webapis.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">
|
||
|
|
|
||
|
|
<div class="section" id="rest-api">
|
||
|
|
<h1>REST API<a class="headerlink" href="#rest-api" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<p>The REST API is document by using Swagger.IO.
|
||
|
|
After startup of the server the API documentation is available under:</p>
|
||
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//<</span><span class="n">SERVER_IP</span><span class="o">></span><span class="p">:</span><span class="o"><</span><span class="n">PORT</span><span class="o">>/</span><span class="n">api</span><span class="o">/</span><span class="n">doc</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="websocket-api">
|
||
|
|
<h1>WebSocket API<a class="headerlink" href="#websocket-api" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<p>WebSocket client can be connected to the following endpoint:</p>
|
||
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//<</span><span class="n">SERVER_IP</span><span class="o">></span><span class="p">:</span><span class="o"><</span><span class="n">PORT</span><span class="o">>/</span><span class="n">ws</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>I recommend to use Dark WebSocket Terminal for testing. At the moment the WebSocket API is just pushing data.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">Currently Security is not enabled. That means you need no password to connect to th Web APIs</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<footer>
|
||
|
|
|
||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
|
|
||
|
|
|
||
|
|
<a href="standards.html" class="btn btn-neutral" title="Standard & Guidelines" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>
|
||
|
|
© Copyright 2018, Manuel Fritsch
|
||
|
|
|
||
|
|
</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>.
|
||
|
|
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|