craftbeerpi4-pione/docs/_sources/step.rst.txt
2019-01-05 23:27:29 +01:00

41 lines
No EOL
703 B
ReStructuredText

Brewing Step
============
StepController
^^^^^^^^^^^^^^^
.. autoclass:: cbpi.controller.step_controller.StepController
:members:
:undoc-members:
:show-inheritance:
CBPiSimpleStep
^^^^^^^^^^^^^^
.. autoclass:: cbpi.api.CBPiSimpleStep
:members:
:undoc-members:
:show-inheritance:
Custom Step
^^^^^^^^^^^
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
.. literalinclude:: ../../cbpi/extension/dummystep/__init__.py
:caption: __init__.py
:language: python
:linenos:
config.yaml
.. literalinclude:: ../../cbpi/extension/dummystep/config.yaml
:language: yaml
:linenos: