Home-IoT/craftbeerpi4-pione
1
0
Fork 0
mirror of https://github.com/PiBrewing/craftbeerpi4.git synced 2024-11-21 22:48:16 +01:00
Code Issues Projects Releases Packages Wiki Activity

documentation fix

Browse source
This commit is contained in:
manuel83 2019-01-08 20:40:03 +01:00
parent ace88601f2
commit 3478d06806
17 changed files with 388 additions and 112 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

163
.idea/workspace.xml
View file

@ -2,7 +2,9 @@
<project version="4"> <project version="4">
<component name="ChangeListManager"> <component name="ChangeListManager">
<list default="true" id="1a245e6a-2e43-4348-8759-dc1b63a4c9c8" name="Default" comment="Lots of changes"> <list default="true" id="1a245e6a-2e43-4348-8759-dc1b63a4c9c8" name="Default" comment="Lots of changes">
<change beforePath="$PROJECT_DIR$/cbpi/craftbeerpi.py" beforeDir="false" afterPath="$PROJECT_DIR$/cbpi/craftbeerpi.py" afterDir="false" /> <change beforePath="$PROJECT_DIR$/docs_src/source/core.rst" beforeDir="false" afterPath="$PROJECT_DIR$/docs_src/source/core.rst" afterDir="false" />
<change beforePath="$PROJECT_DIR$/docs_src/source/install.rst" beforeDir="false" afterPath="$PROJECT_DIR$/docs_src/source/install.rst" afterDir="false" />
<change beforePath="$PROJECT_DIR$/setup.py" beforeDir="false" afterPath="$PROJECT_DIR$/setup.py" afterDir="false" />
</list> </list>
<option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" /> <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
<option name="SHOW_DIALOG" value="false" /> <option name="SHOW_DIALOG" value="false" />
@ -70,6 +72,30 @@
</component> </component>
<component name="FileEditorManager"> <component name="FileEditorManager">
<leaf SIDE_TABS_SIZE_LIMIT_KEY="300"> <leaf SIDE_TABS_SIZE_LIMIT_KEY="300">
<file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/setup.py">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="45">
<caret line="3" column="22" selection-start-line="3" selection-start-column="22" selection-end-line="3" selection-end-column="22" />
</state>
</provider>
</entry>
</file>
<file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/docs_src/source/install.rst">
<provider selected="true" editor-type-id="restructured-text-editor" />
</entry>
</file>
<file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/docs_src/source/index.rst">
<provider selected="true" editor-type-id="restructured-text-editor" />
</entry>
</file>
<file pinned="false" current-in-tab="true">
<entry file="file://$PROJECT_DIR$/docs_src/source/core.rst">
<provider selected="true" editor-type-id="restructured-text-editor" />
</entry>
</file>
<file pinned="false" current-in-tab="false"> <file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/config/plugin_list.txt"> <entry file="file://$PROJECT_DIR$/config/plugin_list.txt">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor">
@ -90,46 +116,11 @@
</provider> </provider>
</entry> </entry>
</file> </file>
<file pinned="false" current-in-tab="true"> <file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/cbpi/craftbeerpi.py"> <entry file="file://$PROJECT_DIR$/cbpi/craftbeerpi.py">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="86"> <state relative-caret-position="86">
<caret line="32" column="8" lean-forward="true" selection-start-line="32" selection-start-column="8" selection-end-line="32" selection-end-column="8" /> <caret line="32" column="8" selection-start-line="32" selection-start-column="8" selection-end-line="32" selection-end-column="8" />
</state>
</provider>
</entry>
</file>
<file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/cbpi/controller/plugin_controller.py">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="945">
<caret line="63" column="44" selection-start-line="63" selection-start-column="44" selection-end-line="63" selection-end-column="44" />
<folding>
<element signature="e#0#14#0" expanded="true" />
</folding>
</state>
</provider>
</entry>
</file>
<file pinned="false" current-in-tab="false">
<entry file="file://$USER_HOME$/cbp42/lib/python3.7/site-packages/cbpi-ui/__init__.py">
<provider selected="true" editor-type-id="text-editor" />
</entry>
</file>
<file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/requirements.txt">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="150">
<caret line="10" column="8" selection-start-line="10" selection-start-column="8" selection-end-line="10" selection-end-column="8" />
</state>
</provider>
</entry>
</file>
<file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/.gitignore">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="120">
<caret line="8" column="17" selection-start-line="8" selection-start-column="17" selection-end-line="8" selection-end-column="17" />
</state> </state>
</provider> </provider>
</entry> </entry>
@ -161,8 +152,11 @@
<file pinned="false" current-in-tab="false"> <file pinned="false" current-in-tab="false">
<entry file="file://$USER_HOME$/cbp42/lib/python3.7/site-packages/cbpi/craftbeerpi.py"> <entry file="file://$USER_HOME$/cbp42/lib/python3.7/site-packages/cbpi/craftbeerpi.py">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="119"> <state relative-caret-position="186">
<caret line="33" column="5" selection-start-line="33" selection-start-column="5" selection-end-line="33" selection-end-column="5" /> <caret line="38" lean-forward="true" selection-start-line="38" selection-end-line="38" />
<folding>
<element signature="e#0#14#0" expanded="true" />
</folding>
</state> </state>
</provider> </provider>
</entry> </entry>
@ -231,7 +225,6 @@
<component name="IdeDocumentHistory"> <component name="IdeDocumentHistory">
<option name="CHANGED_PATHS"> <option name="CHANGED_PATHS">
<list> <list>
<option value="$PROJECT_DIR$/cbpi/websocket.py" />
<option value="$PROJECT_DIR$/sample.py" /> <option value="$PROJECT_DIR$/sample.py" />
<option value="$PROJECT_DIR$/cbpi/api/extension.py" /> <option value="$PROJECT_DIR$/cbpi/api/extension.py" />
<option value="$PROJECT_DIR$/cbpi/api/sensor.py" /> <option value="$PROJECT_DIR$/cbpi/api/sensor.py" />
@ -251,7 +244,6 @@
<option value="$PROJECT_DIR$/docs_src/source/restapi.rst" /> <option value="$PROJECT_DIR$/docs_src/source/restapi.rst" />
<option value="$PROJECT_DIR$/docs_src/source/webapis.rst" /> <option value="$PROJECT_DIR$/docs_src/source/webapis.rst" />
<option value="$PROJECT_DIR$/docs_src/source/index.rst" /> <option value="$PROJECT_DIR$/docs_src/source/index.rst" />
<option value="$PROJECT_DIR$/docs_src/source/install.rst" />
<option value="$PROJECT_DIR$/LICENSE" /> <option value="$PROJECT_DIR$/LICENSE" />
<option value="$PROJECT_DIR$/cbpi/ui/static/js/Wappen_Salzkotten.svg" /> <option value="$PROJECT_DIR$/cbpi/ui/static/js/Wappen_Salzkotten.svg" />
<option value="$PROJECT_DIR$/cbpi/extension/ui/__init__.py" /> <option value="$PROJECT_DIR$/cbpi/extension/ui/__init__.py" />
@ -276,12 +268,14 @@
<option value="$PROJECT_DIR$/cbpi/http_endpoints/http_translation.py" /> <option value="$PROJECT_DIR$/cbpi/http_endpoints/http_translation.py" />
<option value="$PROJECT_DIR$/requirements.txt" /> <option value="$PROJECT_DIR$/requirements.txt" />
<option value="$PROJECT_DIR$/.gitignore" /> <option value="$PROJECT_DIR$/.gitignore" />
<option value="$PROJECT_DIR$/setup.py" />
<option value="$PROJECT_DIR$/config/config.yaml" /> <option value="$PROJECT_DIR$/config/config.yaml" />
<option value="$PROJECT_DIR$/config/plugin_list.txt" /> <option value="$PROJECT_DIR$/config/plugin_list.txt" />
<option value="$PROJECT_DIR$/cbpi/controller/plugin_controller.py" /> <option value="$PROJECT_DIR$/cbpi/controller/plugin_controller.py" />
<option value="$PROJECT_DIR$/cbpi/controller/translation_controller.py" /> <option value="$PROJECT_DIR$/cbpi/controller/translation_controller.py" />
<option value="$PROJECT_DIR$/cbpi/craftbeerpi.py" /> <option value="$PROJECT_DIR$/cbpi/craftbeerpi.py" />
<option value="$PROJECT_DIR$/setup.py" />
<option value="$PROJECT_DIR$/docs_src/source/install.rst" />
<option value="$PROJECT_DIR$/docs_src/source/core.rst" />
</list> </list>
</option> </option>
</component> </component>
@ -307,42 +301,18 @@
<path> <path>
<item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" /> <item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" />
<item name="craftbeerpi4" type="462c0819:PsiDirectoryNode" /> <item name="craftbeerpi4" type="462c0819:PsiDirectoryNode" />
<item name="cbpi" type="462c0819:PsiDirectoryNode" /> <item name="dist" type="462c0819:PsiDirectoryNode" />
</path> </path>
<path> <path>
<item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" /> <item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" />
<item name="craftbeerpi4" type="462c0819:PsiDirectoryNode" /> <item name="craftbeerpi4" type="462c0819:PsiDirectoryNode" />
<item name="config" type="462c0819:PsiDirectoryNode" /> <item name="docs_src" type="462c0819:PsiDirectoryNode" />
</path> </path>
<path> <path>
<item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" /> <item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" />
<item name="External Libraries" type="cb654da1:ExternalLibrariesNode" /> <item name="craftbeerpi4" type="462c0819:PsiDirectoryNode" />
</path> <item name="docs_src" type="462c0819:PsiDirectoryNode" />
<path> <item name="source" type="462c0819:PsiDirectoryNode" />
<item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" />
<item name="External Libraries" type="cb654da1:ExternalLibrariesNode" />
<item name="&lt; Python 3.7.1 virtualenv at ~/cbp42 &gt;" type="70bed36:NamedLibraryElementNode" />
</path>
<path>
<item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" />
<item name="External Libraries" type="cb654da1:ExternalLibrariesNode" />
<item name="&lt; Python 3.7.1 virtualenv at ~/cbp42 &gt;" type="70bed36:NamedLibraryElementNode" />
<item name="site-packages" type="462c0819:PsiDirectoryNode" />
</path>
<path>
<item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" />
<item name="External Libraries" type="cb654da1:ExternalLibrariesNode" />
<item name="&lt; Python 3.7.1 virtualenv at ~/cbp42 &gt;" type="70bed36:NamedLibraryElementNode" />
<item name="site-packages" type="462c0819:PsiDirectoryNode" />
<item name="cbpi" type="462c0819:PsiDirectoryNode" />
</path>
<path>
<item name="craftbeerpi4" type="b2602c69:ProjectViewProjectNode" />
<item name="External Libraries" type="cb654da1:ExternalLibrariesNode" />
<item name="&lt; Python 3.7.1 virtualenv at ~/cbp42 &gt;" type="70bed36:NamedLibraryElementNode" />
<item name="site-packages" type="462c0819:PsiDirectoryNode" />
<item name="cbpi" type="462c0819:PsiDirectoryNode" />
<item name="craftbeerpi.py" type="8704e2dd:PyFileNode" />
</path> </path>
</expand> </expand>
<select /> <select />
@ -611,7 +581,7 @@
<workItem from="1546797494638" duration="14249000" /> <workItem from="1546797494638" duration="14249000" />
<workItem from="1546971487719" duration="1233000" /> <workItem from="1546971487719" duration="1233000" />
<workItem from="1546973098962" duration="96000" /> <workItem from="1546973098962" duration="96000" />
<workItem from="1546975321797" duration="140000" /> <workItem from="1546975321797" duration="1014000" />
</task> </task>
<task id="LOCAL-00001" summary="Lots of changes"> <task id="LOCAL-00001" summary="Lots of changes">
<created>1541288846149</created> <created>1541288846149</created>
@ -663,7 +633,7 @@
</history-entry> </history-entry>
</component> </component>
<component name="TimeTrackingManager"> <component name="TimeTrackingManager">
<option name="totallyTimeSpent" value="175261000" /> <option name="totallyTimeSpent" value="176135000" />
</component> </component>
<component name="TodoView" selected-index="4"> <component name="TodoView" selected-index="4">
<todo-panel id="selected-file"> <todo-panel id="selected-file">
@ -686,7 +656,7 @@
<window_info anchor="bottom" id="Run" order="2" sideWeight="0.7262069" weight="0.47586206" /> <window_info anchor="bottom" id="Run" order="2" sideWeight="0.7262069" weight="0.47586206" />
<window_info anchor="bottom" id="Debug" order="3" weight="0.39731053" /> <window_info anchor="bottom" id="Debug" order="3" weight="0.39731053" />
<window_info anchor="bottom" id="Python Console" order="4" weight="0.32885087" /> <window_info anchor="bottom" id="Python Console" order="4" weight="0.32885087" />
<window_info anchor="bottom" id="Terminal" order="5" sideWeight="0.49761903" visible="true" weight="0.5609195" /> <window_info anchor="bottom" id="Terminal" order="5" sideWeight="0.49761903" visible="true" weight="0.49080458" />
<window_info anchor="bottom" id="TODO" order="6" weight="0.3286945" /> <window_info anchor="bottom" id="TODO" order="6" weight="0.3286945" />
<window_info anchor="bottom" id="Message" order="7" /> <window_info anchor="bottom" id="Message" order="7" />
<window_info anchor="bottom" id="Find" order="8" weight="0.32518336" /> <window_info anchor="bottom" id="Find" order="8" weight="0.32518336" />
@ -745,7 +715,6 @@
</watches-manager> </watches-manager>
</component> </component>
<component name="editorHistoryManager"> <component name="editorHistoryManager">
<entry file="file://$PROJECT_DIR$/cbpi/extension/ui/react/src/recucers/index.js" />
<entry file="file://$PROJECT_DIR$/cbpi/extension/ui/react/src/recucers/sensor.js" /> <entry file="file://$PROJECT_DIR$/cbpi/extension/ui/react/src/recucers/sensor.js" />
<entry file="file://$PROJECT_DIR$/cbpi/extension/ui/react/src/recucers/actor.js" /> <entry file="file://$PROJECT_DIR$/cbpi/extension/ui/react/src/recucers/actor.js" />
<entry file="file://$PROJECT_DIR$/cbpi/extension/ui/react/src/recucers/kettle.js" /> <entry file="file://$PROJECT_DIR$/cbpi/extension/ui/react/src/recucers/kettle.js" />
@ -895,13 +864,6 @@
</state> </state>
</provider> </provider>
</entry> </entry>
<entry file="file://$PROJECT_DIR$/setup.py">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="45">
<caret line="3" column="20" selection-start-line="3" selection-start-column="20" selection-end-line="3" selection-end-column="20" />
</state>
</provider>
</entry>
<entry file="file://$PROJECT_DIR$/.nojekyll"> <entry file="file://$PROJECT_DIR$/.nojekyll">
<provider selected="true" editor-type-id="text-editor" /> <provider selected="true" editor-type-id="text-editor" />
</entry> </entry>
@ -975,19 +937,38 @@
</state> </state>
</provider> </provider>
</entry> </entry>
<entry file="file://$USER_HOME$/cbp42/lib/python3.7/site-packages/cbpi/craftbeerpi.py">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="119">
<caret line="33" column="5" selection-start-line="33" selection-start-column="5" selection-end-line="33" selection-end-column="5" />
</state>
</provider>
</entry>
<entry file="file://$PROJECT_DIR$/cbpi/craftbeerpi.py"> <entry file="file://$PROJECT_DIR$/cbpi/craftbeerpi.py">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="86"> <state relative-caret-position="86">
<caret line="32" column="8" lean-forward="true" selection-start-line="32" selection-start-column="8" selection-end-line="32" selection-end-column="8" /> <caret line="32" column="8" selection-start-line="32" selection-start-column="8" selection-end-line="32" selection-end-column="8" />
</state> </state>
</provider> </provider>
</entry> </entry>
<entry file="file://$USER_HOME$/cbp42/lib/python3.7/site-packages/cbpi/craftbeerpi.py">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="186">
<caret line="38" lean-forward="true" selection-start-line="38" selection-end-line="38" />
<folding>
<element signature="e#0#14#0" expanded="true" />
</folding>
</state>
</provider>
</entry>
<entry file="file://$PROJECT_DIR$/setup.py">
<provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="45">
<caret line="3" column="22" selection-start-line="3" selection-start-column="22" selection-end-line="3" selection-end-column="22" />
</state>
</provider>
</entry>
<entry file="file://$PROJECT_DIR$/docs_src/source/install.rst">
<provider selected="true" editor-type-id="restructured-text-editor" />
</entry>
<entry file="file://$PROJECT_DIR$/docs_src/source/index.rst">
<provider selected="true" editor-type-id="restructured-text-editor" />
</entry>
<entry file="file://$PROJECT_DIR$/docs_src/source/core.rst">
<provider selected="true" editor-type-id="restructured-text-editor" />
</entry>
</component> </component>
</project> </project>

2
docs/_sources/contribute.rst.txt Normal file
View file

@ -0,0 +1,2 @@
Core
=====

2
docs/_sources/core.rst.txt
View file

@ -1,2 +1,2 @@
Core Core
======== =====

34
docs/_sources/install.rst.txt
View file

@ -10,14 +10,17 @@ It will also run on MacOS
Download and Installation Download and Installation
========================= =========================
Raspberry PI
^^^^^^^^^^^^
:: ::
$ sudo pip install -i https://test.pypi.org/simple/ cbpi $ sudo pip install cbpi
Further version can be found on PiPy: https://test.pypi.org/project/cbpi/ Further version can be found on PiPy: https://pypi.org/project/cbpi/
.. note:: .. note::
All dependencies will be installed automatically. The installation will add the command "cbpi" to your shell. All dependencies will be installed automatically.
To uninstall just remove the package via pip. To uninstall just remove the package via pip.
@ -25,10 +28,30 @@ To uninstall just remove the package via pip.
$ sudo pip uninstall cbpi $ sudo pip uninstall cbpi
MacOS
^^^^^^^^^^^^
Make sure to have Python 3 installed. For example via Homebrew. !!!Attention pip3 not just pip!!!
::
$ sudo pip3 install cbpi
Further version can be found on PiPy: https://pypi.org/project/cbpi/
.. note::
All dependencies will be installed automatically.
To uninstall just remove the package via pip.
::
$ sudo pip uninstall cbpi
Run the Server Run the Server
============== ==============
To start CraftBeerPi just run the following command in your shell The installation will add the command "cbpi" to your shell. To start CraftBeerPi just run the following command in your shell
:: ::
$ cbpi $ cbpi
@ -41,8 +64,9 @@ PIP Website: https://test.pypi.org/project/cbpi/
Update CraftBeerPi Update CraftBeerPi
================== ==================
That's super easy. Just run again with upgrade option That's super easy. Just run again with upgrade option.
:: ::
$ sudo pip install -i https://test.pypi.org/simple/ cbpi --upgrade $ sudo pip install -i https://test.pypi.org/simple/ cbpi --upgrade

2
docs/actor.html
View file

@ -93,6 +93,8 @@
<li class="toctree-l1"><a class="reference internal" href="kettle_controller.html">Kettle</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="properties.html">Properties</a></li>
<li class="toctree-l1"><a class="reference internal" href="standards.html">Standard &amp; Guidelines</a></li> <li class="toctree-l1"><a class="reference internal" href="standards.html">Standard &amp; Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html">REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html#websocket-api">WebSocket API</a></li>
</ul> </ul>

207
docs/contribute.html Normal file
View file

@ -0,0 +1,207 @@
<!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>Core &mdash; 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" />
<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>
<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 &amp; Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html">REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html#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> &raquo;</li>
<li>Core</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/contribute.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="core">
<h1>Core<a class="headerlink" href="#core" title="Permalink to this headline"></a></h1>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>

3
docs/core.html
View file

@ -86,6 +86,9 @@
<li class="toctree-l1"><a class="reference internal" href="step.html">Brewing Step</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="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="properties.html">Properties</a></li>
<li class="toctree-l1"><a class="reference internal" href="standards.html">Standard &amp; Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html">REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html#websocket-api">WebSocket API</a></li>
</ul> </ul>

6
docs/index.html
View file

@ -157,7 +157,11 @@
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul> <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#download-and-installation">Download and Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="install.html#download-and-installation">Download and Installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#raspberry-pi">Raspberry PI</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#macos">MacOS</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#run-the-server">Run the Server</a></li> <li class="toctree-l2"><a class="reference internal" href="install.html#run-the-server">Run the Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#update-craftbeerpi">Update CraftBeerPi</a></li> <li class="toctree-l2"><a class="reference internal" href="install.html#update-craftbeerpi">Update CraftBeerPi</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#install-plugins">Install plugins</a></li> <li class="toctree-l2"><a class="reference internal" href="install.html#install-plugins">Install plugins</a></li>

35
docs/install.html
View file

@ -80,7 +80,11 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#download-and-installation">Download and Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="#download-and-installation">Download and Installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#raspberry-pi">Raspberry PI</a></li>
<li class="toctree-l3"><a class="reference internal" href="#macos">MacOS</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#run-the-server">Run the Server</a></li> <li class="toctree-l2"><a class="reference internal" href="#run-the-server">Run the Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="#update-craftbeerpi">Update CraftBeerPi</a></li> <li class="toctree-l2"><a class="reference internal" href="#update-craftbeerpi">Update CraftBeerPi</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-plugins">Install plugins</a></li> <li class="toctree-l2"><a class="reference internal" href="#install-plugins">Install plugins</a></li>
@ -166,22 +170,41 @@
It will also run on MacOS</p> It will also run on MacOS</p>
<div class="section" id="download-and-installation"> <div class="section" id="download-and-installation">
<h2>Download and Installation<a class="headerlink" href="#download-and-installation" title="Permalink to this headline"></a></h2> <h2>Download and Installation<a class="headerlink" href="#download-and-installation" title="Permalink to this headline"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip install -i https://test.pypi.org/simple/ cbpi <div class="section" id="raspberry-pi">
<h3>Raspberry PI<a class="headerlink" href="#raspberry-pi" title="Permalink to this headline"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip install cbpi
</pre></div> </pre></div>
</div> </div>
<p>Further version can be found on PiPy: <a class="reference external" href="https://test.pypi.org/project/cbpi/">https://test.pypi.org/project/cbpi/</a></p> <p>Further version can be found on PiPy: <a class="reference external" href="https://pypi.org/project/cbpi/">https://pypi.org/project/cbpi/</a></p>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<p class="last">All dependencies will be installed automatically. The installation will add the command “cbpi” to your shell.</p> <p class="last">All dependencies will be installed automatically.</p>
</div> </div>
<p>To uninstall just remove the package via pip.</p> <p>To uninstall just remove the package via pip.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip uninstall cbpi <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip uninstall cbpi
</pre></div> </pre></div>
</div> </div>
</div> </div>
<div class="section" id="macos">
<h3>MacOS<a class="headerlink" href="#macos" title="Permalink to this headline"></a></h3>
<p>Make sure to have Python 3 installed. For example via Homebrew. !!!Attention pip3 not just pip!!!</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip3 install cbpi
</pre></div>
</div>
<p>Further version can be found on PiPy: <a class="reference external" href="https://pypi.org/project/cbpi/">https://pypi.org/project/cbpi/</a></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">All dependencies will be installed automatically.</p>
</div>
<p>To uninstall just remove the package via pip.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip uninstall cbpi
</pre></div>
</div>
</div>
</div>
<div class="section" id="run-the-server"> <div class="section" id="run-the-server">
<h2>Run the Server<a class="headerlink" href="#run-the-server" title="Permalink to this headline"></a></h2> <h2>Run the Server<a class="headerlink" href="#run-the-server" title="Permalink to this headline"></a></h2>
<p>To start CraftBeerPi just run the following command in your shell</p> <p>The installation will add the command “cbpi” to your shell. To start CraftBeerPi just run the following command in your shell</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cbpi <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cbpi
</pre></div> </pre></div>
</div> </div>
@ -190,7 +213,7 @@ PIP Website: <a class="reference external" href="https://test.pypi.org/project/c
</div> </div>
<div class="section" id="update-craftbeerpi"> <div class="section" id="update-craftbeerpi">
<h2>Update CraftBeerPi<a class="headerlink" href="#update-craftbeerpi" title="Permalink to this headline"></a></h2> <h2>Update CraftBeerPi<a class="headerlink" href="#update-craftbeerpi" title="Permalink to this headline"></a></h2>
<p>That’s super easy. Just run again with upgrade option</p> <p>That’s super easy. Just run again with upgrade option.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip install -i https://test.pypi.org/simple/ cbpi --upgrade <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo pip install -i https://test.pypi.org/simple/ cbpi --upgrade
</pre></div> </pre></div>
</div> </div>

2
docs/kettle_controller.html
View file

@ -92,6 +92,8 @@
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="properties.html">Properties</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 &amp; Guidelines</a></li> <li class="toctree-l1"><a class="reference internal" href="standards.html">Standard &amp; Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html">REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html#websocket-api">WebSocket API</a></li>
</ul> </ul>

BIN
docs/objects.inv
View file

Binary file not shown.

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long

2
docs/sensor.html
View file

@ -92,6 +92,8 @@
<li class="toctree-l1"><a class="reference internal" href="kettle_controller.html">Kettle</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="properties.html">Properties</a></li>
<li class="toctree-l1"><a class="reference internal" href="standards.html">Standard &amp; Guidelines</a></li> <li class="toctree-l1"><a class="reference internal" href="standards.html">Standard &amp; Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html">REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="webapis.html#websocket-api">WebSocket API</a></li>
</ul> </ul>

2
docs_src/source/contribute.rst Normal file
View file

@ -0,0 +1,2 @@
Core
=====

2
docs_src/source/core.rst
View file

@ -1,2 +1,2 @@
Core Core
======== =====

34
docs_src/source/install.rst
View file

@ -10,14 +10,17 @@ It will also run on MacOS
Download and Installation Download and Installation
========================= =========================
Raspberry PI
^^^^^^^^^^^^
:: ::
$ sudo pip install -i https://test.pypi.org/simple/ cbpi $ sudo pip install cbpi
Further version can be found on PiPy: https://test.pypi.org/project/cbpi/ Further version can be found on PiPy: https://pypi.org/project/cbpi/
.. note:: .. note::
All dependencies will be installed automatically. The installation will add the command "cbpi" to your shell. All dependencies will be installed automatically.
To uninstall just remove the package via pip. To uninstall just remove the package via pip.
@ -25,10 +28,30 @@ To uninstall just remove the package via pip.
$ sudo pip uninstall cbpi $ sudo pip uninstall cbpi
MacOS
^^^^^^^^^^^^
Make sure to have Python 3 installed. For example via Homebrew. !!!Attention pip3 not just pip!!!
::
$ sudo pip3 install cbpi
Further version can be found on PiPy: https://pypi.org/project/cbpi/
.. note::
All dependencies will be installed automatically.
To uninstall just remove the package via pip.
::
$ sudo pip uninstall cbpi
Run the Server Run the Server
============== ==============
To start CraftBeerPi just run the following command in your shell The installation will add the command "cbpi" to your shell. To start CraftBeerPi just run the following command in your shell
:: ::
$ cbpi $ cbpi
@ -41,8 +64,9 @@ PIP Website: https://test.pypi.org/project/cbpi/
Update CraftBeerPi Update CraftBeerPi
================== ==================
That's super easy. Just run again with upgrade option That's super easy. Just run again with upgrade option.
:: ::
$ sudo pip install -i https://test.pypi.org/simple/ cbpi --upgrade $ sudo pip install -i https://test.pypi.org/simple/ cbpi --upgrade

2
setup.py
View file

@ -1,7 +1,7 @@
from setuptools import setup, find_packages from setuptools import setup, find_packages
setup(name='cbpi', setup(name='cbpi',
version='4.0.4', version='4.0.0.1',
description='CraftBeerPi API', description='CraftBeerPi API',
author='Manuel Fritsch', author='Manuel Fritsch',
author_email='manuel@craftbeerpi.com', author_email='manuel@craftbeerpi.com',