craftbeerpi4-pione/docs/_sources/step.rst.txt

42 lines
730 B
Text
Raw Normal View History

2018-12-08 14:21:00 +01:00
Brewing Step
============
StepController
^^^^^^^^^^^^^^^
.. autoclass:: core.controller.step_controller.StepController
:members:
2018-12-09 22:20:33 +01:00
2018-12-08 14:21:00 +01:00
:undoc-members:
:show-inheritance:
2018-12-10 22:13:28 +01:00
CBPiSimpleStep
^^^^^^^^^^^^^^
2018-12-08 14:21:00 +01:00
2018-12-10 22:13:28 +01:00
.. autoclass:: core.api.step.CBPiSimpleStep
2018-12-08 14:21:00 +01:00
:members:
:undoc-members:
:show-inheritance:
Custom Step
2018-12-10 22:13:28 +01:00
^^^^^^^^^^^
2018-12-08 14:21:00 +01:00
2018-12-09 22:20:33 +01:00
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
2018-12-08 14:21:00 +01:00
.. literalinclude:: ../../core/extension/dummystep/__init__.py
:caption: __init__.py
:name: __init__-py
:language: python
:linenos:
config.yaml
.. literalinclude:: ../../core/extension/dummystep/config.yaml
:language: yaml
:linenos: