2018-11-18 15:40:10 +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" >
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
< title > Installation — CraftBeerPi 4.0 documentation< / title >
2018-12-08 14:21:00 +01:00
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
2018-12-08 14:21:00 +01:00
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
2018-11-18 15:40:10 +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 = "Core" href = "core.html" / >
< link rel = "prev" title = "Welcome to CraftBeerPi’ href = "index.html" / >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< script src = "_static/js/modernizr.min.js" > < / script >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< / head >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< body class = "wy-body-for-nav" >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< div class = "wy-grid-for-nav" >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< a href = "index.html" class = "icon icon-home" > CraftBeerPi
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< / a >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< 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 >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul class = "current" >
2019-01-05 23:27:29 +01:00
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > Installation< / a > < ul >
2019-01-08 20:40:03 +01:00
< 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 >
2019-01-05 23:27:29 +01:00
< 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 = "#install-plugins" > Install plugins< / a > < / li >
< / ul >
< / li >
2018-12-08 14:21:00 +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 > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "sensor.html" > Sensor< / a > < / li >
2018-12-09 22:20:33 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "step.html" > Brewing Step< / a > < / li >
2018-12-08 14:21:00 +01:00
< 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 >
2019-01-05 23:27:29 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "standards.html" > Standard & 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 >
2018-12-08 14:21:00 +01:00
< / ul >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
< 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" >
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 = "index.html" > Docs< / a > » < / li >
< li > Installation< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/install.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 = "installation" >
< h1 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this headline" > ¶< / a > < / h1 >
2019-01-05 23:27:29 +01:00
< p > Please make sure that Python 3.5 is installed.
< a class = "reference external" href = "https://www.raspberrypi.org/downloads/raspbian//" > Rapsbian Stretch< / a > is required at least.
It will also run on MacOS< / p >
< 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 >
2019-01-08 20:40:03 +01:00
< 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
2019-01-05 23:27:29 +01:00
< / pre > < / div >
< / div >
2019-01-08 20:40:03 +01:00
< 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 >
2019-01-05 23:27:29 +01:00
< div class = "admonition note" >
< p class = "first admonition-title" > Note< / p >
2019-01-08 20:40:03 +01:00
< p class = "last" > All dependencies will be installed automatically.< / p >
2019-01-05 23:27:29 +01:00
< / 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 >
2019-01-08 20:40:03 +01:00
< 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 >
2019-01-05 23:27:29 +01:00
< 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 >
2019-01-08 20:40:03 +01:00
< p > The installation will add the command “cbpi” to your shell. To start CraftBeerPi just run the following command in your shell< / p >
2019-01-05 23:27:29 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ cbpi
2018-12-09 22:20:33 +01:00
< / pre > < / div >
< / div >
2019-01-05 23:27:29 +01:00
< p > During the first startup a < cite > config< / cite > and < cite > logs< / cite > folder gets created in the directory from where the < cite > $ cbpi< / cite > in called
PIP Website: < a class = "reference external" href = "https://test.pypi.org/project/cbpi/" > https://test.pypi.org/project/cbpi/< / a > < / p >
< / div >
< div class = "section" id = "update-craftbeerpi" >
< h2 > Update CraftBeerPi< a class = "headerlink" href = "#update-craftbeerpi" title = "Permalink to this headline" > ¶< / a > < / h2 >
2019-01-08 20:40:03 +01:00
< p > That’ < / p >
2019-01-05 23:27:29 +01:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ sudo pip install -i https://test.pypi.org/simple/ cbpi --upgrade
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "install-plugins" >
< h2 > Install plugins< a class = "headerlink" href = "#install-plugins" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Plugins are normal Python Pip packages.< / p >
< p > Install< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ sudo pip install -i https://test.pypi.org/simple/ CBPiActor1
< / pre > < / div >
< / div >
< p > Uninstall< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > $ pip uninstall CBPiActor1
< / pre > < / div >
< / div >
< / div >
2018-12-09 22:20:33 +01:00
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
< a href = "core.html" class = "btn btn-neutral float-right" title = "Core" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< a href = "index.html" class = "btn btn-neutral" title = "Welcome to CraftBeerPi’ accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2018-12-08 14:21:00 +01:00
< / div >
2018-12-09 22:20:33 +01:00
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< 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 >
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 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 >
2018-11-18 15:40:10 +01:00
< / html >
