craftbeerpi4-pione/docs_src/source/step.rst

41 lines
703 B
ReStructuredText
Raw Normal View History

2018-12-08 14:21:00 +01:00
Brewing Step
============
StepController
^^^^^^^^^^^^^^^
2019-01-05 23:25:19 +01:00
.. autoclass:: cbpi.controller.step_controller.StepController
2018-12-08 14:21:00 +01:00
: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
2019-01-05 23:25:19 +01:00
.. autoclass:: cbpi.api.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
2019-01-05 23:25:19 +01:00
.. literalinclude:: ../../cbpi/extension/dummystep/__init__.py
2018-12-08 14:21:00 +01:00
:caption: __init__.py
:language: python
:linenos:
config.yaml
2019-01-05 23:25:19 +01:00
.. literalinclude:: ../../cbpi/extension/dummystep/config.yaml
2018-12-08 14:21:00 +01:00
:language: yaml
:linenos: