2018-11-16 20:49:16 +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 > Brewing Step — 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" / >
2018-12-08 14:21:00 +01:00
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "Kettle" href = "kettle_controller.html" / >
2018-12-09 22:20:33 +01:00
< link rel = "prev" title = "Sensor" href = "sensor.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 >
< / 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 >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
< 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 current" > < a class = "current reference internal" href = "#" > Brewing Step< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#stepcontroller" > StepController< / a > < / li >
2018-12-10 22:13:28 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#cbpisimplestep" > CBPiSimpleStep< / a > < / li >
2018-12-09 22:20:33 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#custom-step" > Custom Step< / a > < / li >
< / ul >
< / 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 >
< / 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" >
< 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 > Brewing Step< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/step.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" >
2018-12-08 14:21:00 +01:00
< div class = "section" id = "brewing-step" >
< h1 > Brewing Step< a class = "headerlink" href = "#brewing-step" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "stepcontroller" >
< h2 > StepController< a class = "headerlink" href = "#stepcontroller" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "class" >
< dt id = "core.controller.step_controller.StepController" >
< em class = "property" > class < / em > < code class = "descclassname" > core.controller.step_controller.< / code > < code class = "descname" > StepController< / code > < span class = "sig-paren" > (< / span > < em > cbpi< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > The Step Controller. This controller is responsible to start and stop the brewing steps.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Undoc-members:< / th > < td class = "field-body" > < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" colspan = "2" > Show-inheritance:< / th > < / tr >
< tr class = "field-even field" > < td >   < / td > < td class = "field-body" > < / td >
< / tr >
< / tbody >
< / table >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
2018-12-09 22:20:33 +01:00
< dt id = "core.controller.step_controller.StepController.handle_action" >
< code class = "descname" > handle_action< / code > < span class = "sig-paren" > (< / span > < em > action< / em > , < em > **kwargs< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.handle_action" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Event Handler for “step/action”.
It invokes the provided method name on the current step< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > action< / strong > – < / li >
< li > < strong > kwargs< / strong > – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first last" > None< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
2018-12-09 22:20:33 +01:00
< dt id = "core.controller.step_controller.StepController.handle_done" >
< code class = "descname" > handle_done< / code > < span class = "sig-paren" > (< / span > < em > topic< / em > , < em > **kwargs< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.handle_done" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Event Handler for “step/+/done”.
Starts the next step< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > topic< / strong > – < / li >
< li > < strong > kwargs< / strong > – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first last" > < / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.handle_next" >
< code class = "descname" > handle_next< / code > < span class = "sig-paren" > (< / span > < em > **kwargs< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.handle_next" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Event Handler for “step/next”.
It start the next step< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > kwargs< / strong > – < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.handle_reset" >
2018-12-09 22:20:33 +01:00
< code class = "descname" > handle_reset< / code > < span class = "sig-paren" > (< / span > < em > **kwargs< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.handle_reset" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Event Handler for “step/reset”.
Resets the current step< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > kwargs< / strong > – < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.handle_start" >
2018-12-09 22:20:33 +01:00
< code class = "descname" > handle_start< / code > < span class = "sig-paren" > (< / span > < em > **kwargs< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.handle_start" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Event Handler for “step/start”.
It starts the brewing process< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > kwargs< / strong > – < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.handle_stop" >
2018-12-09 22:20:33 +01:00
< code class = "descname" > handle_stop< / code > < span class = "sig-paren" > (< / span > < em > **kwargs< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.handle_stop" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Event Handler for “step/stop”.
Stops the current step< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > kwargs< / strong > – < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.http_action" >
< code class = "descname" > http_action< / code > < span class = "sig-paren" > (< / span > < em > request< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.http_action" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > HTTP Endpoint to call an action on the current step.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > request< / strong > – < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > web.Response(text=”OK”< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.http_next" >
< code class = "descname" > http_next< / code > < span class = "sig-paren" > (< / span > < em > request< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.http_next" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > HTTP Endpoint to start the next step. The current step will be stopped< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > request< / strong > – < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.http_reset" >
< code class = "descname" > http_reset< / code > < span class = "sig-paren" > (< / span > < em > request< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.http_reset" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > HTTP Endpoint to call reset on the current step.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > request< / strong > – < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.http_start" >
< code class = "descname" > http_start< / code > < span class = "sig-paren" > (< / span > < em > request< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.http_start" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > HTTP Endpoint to start the brewing process.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
2018-12-08 14:21:00 +01:00
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
2018-12-09 22:20:33 +01:00
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > request< / strong > – < / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < / td >
2018-12-08 14:21:00 +01:00
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-09 22:20:33 +01:00
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.init" >
2019-01-01 15:35:35 +01:00
< code class = "descname" > setup< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.init" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Initializer of the the Step Controller.
:return:< / p >
2018-12-08 14:21:00 +01:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "core.controller.step_controller.StepController.start" >
< code class = "descname" > start< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.controller.step_controller.StepController.start" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Start the first step< / p >
< p > :return:None< / p >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< / dd > < / dl >
2018-11-18 15:40:10 +01:00
2018-12-08 14:21:00 +01:00
< / div >
2018-12-10 22:13:28 +01:00
< div class = "section" id = "cbpisimplestep" >
< h2 > CBPiSimpleStep< a class = "headerlink" href = "#cbpisimplestep" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-12-08 14:21:00 +01:00
< dl class = "class" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep" >
< em class = "property" > class < / em > < code class = "descclassname" > core.api.step.< / code > < code class = "descname" > CBPiSimpleStep< / code > < span class = "sig-paren" > (< / span > < em > *args< / em > , < em > **kwargs< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-08 14:21:00 +01:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > object< / span > < / code > < / p >
< dl class = "method" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.is_dirty" >
< code class = "descname" > is_dirty< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.is_dirty" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Check if a managed variable has a new value< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > True if at least one managed variable has a new value assigend. Otherwise False< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "attribute" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.managed_fields" >
< code class = "descname" > managed_fields< / code > < em class = "property" > = []< / em > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.managed_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-08 14:21:00 +01:00
< dd > < / dd > < / dl >
< dl class = "method" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.next" >
< code class = "descname" > next< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.next" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Request to stop the the step< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.reset" >
< code class = "descname" > reset< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.reset" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Reset the step. This method needs to be overwritten by the custom step implementation< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.reset_dirty" >
< code class = "descname" > reset_dirty< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.reset_dirty" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Reset the dirty flag< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.run" >
< code class = "descname" > run< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.run" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > This method in running in the background. It invokes the run_cycle method in the configured interval
It checks if a managed variable was modified in the last exection cycle. If yes, the method will persisit the new value of the
managed property< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.run_cycle" >
< code class = "descname" > run_cycle< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.run_cycle" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > This method is executed in the defined interval.
That the place to put your step logic.
The method need to be overwritten in the Ccstom step implementaion< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.running" >
< code class = "descname" > running< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.running" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Method checks if the step should continue running.
The method will return False if the step is requested to stop or the next step should start< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > True if the step is running. Otherwise False.< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< dl class = "method" >
2018-12-10 22:13:28 +01:00
< dt id = "core.api.step.CBPiSimpleStep.stop" >
< code class = "descname" > stop< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#core.api.step.CBPiSimpleStep.stop" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-12-09 22:20:33 +01:00
< dd > < p > Request to stop the step< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > None< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-12-08 14:21:00 +01:00
< / dd > < / dl >
2018-11-16 20:49:16 +01:00
2018-12-08 14:21:00 +01:00
< / div >
< div class = "section" id = "custom-step" >
< h2 > Custom Step< a class = "headerlink" href = "#custom-step" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-12-09 22:20:33 +01:00
< p > This is an example of a custom step. The Step class need to extend Simple step. In addtion at least the run_cycle method needs to be overwritten< / p >
2018-12-08 14:21:00 +01:00
< div class = "literal-block-wrapper docutils container" id = "init-py" >
< div class = "code-block-caption" > < span class = "caption-text" > __init__.py< / span > < a class = "headerlink" href = "#init-py" title = "Permalink to this code" > ¶< / a > < / div >
< div class = "highlight-python notranslate" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35< / pre > < / div > < / td > < td class = "code" > < div class = "highlight" > < pre > < span > < / span > < span class = "kn" > import< / span > < span class = "nn" > asyncio< / span >
< span class = "kn" > from< / span > < span class = "nn" > core.api< / span > < span class = "kn" > import< / span > < span class = "n" > Property< / span > < span class = "p" > ,< / span > < span class = "n" > action< / span >
2018-12-10 22:13:28 +01:00
< span class = "kn" > from< / span > < span class = "nn" > core.api.step< / span > < span class = "kn" > import< / span > < span class = "n" > CBPiSimpleStep< / span >
2018-12-08 14:21:00 +01:00
2018-12-10 22:13:28 +01:00
< span class = "k" > class< / span > < span class = "nc" > CustomStepCBPi< / span > < span class = "p" > (< / span > < span class = "n" > CBPiSimpleStep< / span > < span class = "p" > ):< / span >
2018-12-08 14:21:00 +01:00
< span class = "n" > name< / span > < span class = "o" > =< / span > < span class = "n" > Property< / span > < span class = "o" > .< / span > < span class = "n" > Number< / span > < span class = "p" > (< / span > < span class = "n" > label< / span > < span class = "o" > =< / span > < span class = "s2" > " Test" < / span > < span class = "p" > )< / span >
< span class = "n" > i< / span > < span class = "o" > =< / span > < span class = "mi" > 0< / span >
< span class = "nd" > @action< / span > < span class = "p" > (< / span > < span class = "n" > key< / span > < span class = "o" > =< / span > < span class = "s2" > " name" < / span > < span class = "p" > ,< / span > < span class = "n" > parameters< / span > < span class = "o" > =< / span > < span class = "bp" > None< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > test< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > name< / span > < span class = "o" > =< / span > < span class = "s2" > " WOOHOO" < / span >
2018-11-18 15:40:10 +01:00
2018-12-08 14:21:00 +01:00
< span class = "n" > async< / span > < span class = "k" > def< / span > < span class = "nf" > run_cycle< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
2018-11-18 15:40:10 +01:00
2018-12-08 14:21:00 +01:00
< span class = "c1" > #await asyncio.sleep(1)< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > i< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > i< / span > < span class = "o" > +< / span > < span class = "mi" > 1< / span >
2018-12-10 22:13:28 +01:00
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > cbpi< / span > < span class = "o" > .< / span > < span class = "n" > notify< / span > < span class = "p" > (< / span > < span class = "n" > key< / span > < span class = "o" > =< / span > < span class = "s2" > " step" < / span > < span class = "p" > ,< / span > < span class = "n" > message< / span > < span class = "o" > =< / span > < span class = "s2" > " OH YES" < / span > < span class = "p" > )< / span >
2018-12-08 14:21:00 +01:00
< span class = "k" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " RUN STEP" < / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > id< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __dict__< / span > < span class = "p" > )< / span >
2018-11-18 15:40:10 +01:00
2018-11-16 20:49:16 +01:00
2018-12-08 14:21:00 +01:00
< span class = "k" > def< / span > < span class = "nf" > setup< / span > < span class = "p" > (< / span > < span class = "n" > cbpi< / span > < span class = "p" > ):< / span >
< span class = "sd" > ' ' ' < / span >
< span class = "sd" > This method is called by the server during startup < / span >
< span class = "sd" > Here you need to register your plugins at the server< / span >
2018-11-18 15:40:10 +01:00
2018-12-08 14:21:00 +01:00
< span class = "sd" > :param cbpi: the cbpi core < / span >
< span class = "sd" > :return: < / span >
< span class = "sd" > ' ' ' < / span >
2018-11-18 15:40:10 +01:00
2018-12-10 22:13:28 +01:00
< span class = "n" > cbpi< / span > < span class = "o" > .< / span > < span class = "n" > plugin< / span > < span class = "o" > .< / span > < span class = "n" > register< / span > < span class = "p" > (< / span > < span class = "s2" > " CustomStepCBPi" < / span > < span class = "p" > ,< / span > < span class = "n" > CustomStepCBPi< / span > < span class = "p" > )< / span >
2018-12-08 14:21:00 +01:00
< / pre > < / div >
< / td > < / tr > < / table > < / div >
< / div >
< p > config.yaml< / p >
< div class = "highlight-yaml notranslate" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > 1
2< / pre > < / div > < / td > < td class = "code" > < div class = "highlight" > < pre > < span > < / span > < span class = "l l-Scalar l-Scalar-Plain" > name< / span > < span class = "p p-Indicator" > :< / span > < span class = "l l-Scalar l-Scalar-Plain" > DummyStep< / span >
< span class = "l l-Scalar l-Scalar-Plain" > version< / span > < span class = "p p-Indicator" > :< / span > < span class = "l l-Scalar l-Scalar-Plain" > 4< / span >
< / pre > < / div >
< / td > < / tr > < / table > < / div >
< / div >
2018-11-16 20:49:16 +01:00
< / div >
2018-12-09 22:20:33 +01:00
< / div >
2018-12-08 14:21:00 +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 = "kettle_controller.html" class = "btn btn-neutral float-right" title = "Kettle" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< a href = "sensor.html" class = "btn btn-neutral" title = "Sensor" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
< / div >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< hr / >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< div role = "contentinfo" >
< p >
© Copyright 2018, Manuel Fritsch
2018-11-18 15:40:10 +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-11-18 15:40:10 +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-11-16 20:49:16 +01:00
2018-12-09 22:20:33 +01:00
< / section >
2018-11-16 20:49:16 +01:00
2018-12-09 22:20:33 +01:00
< / div >
2018-11-16 20:49:16 +01:00
2018-12-09 22:20:33 +01:00
2018-11-16 20:49:16 +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:49:16 +01:00
2018-12-09 22:20:33 +01:00
2018-11-16 20:49:16 +01:00
2018-12-09 22:20:33 +01:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
2018-11-16 20:49:16 +01:00
2018-12-09 22:20:33 +01:00
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
2018-11-18 15:40:10 +01:00
2018-12-09 22:20:33 +01:00
< / body >
2018-11-16 20:49:16 +01:00
< / html >
