From b4640b477ae7cc6841e422d6a3023ca2ebb428c9 Mon Sep 17 00:00:00 2001 From: manuel83 Date: Sat, 5 Jan 2019 23:25:19 +0100 Subject: [PATCH] documentation updated --- docs_src/source/actor.rst | 8 ++-- docs_src/source/index.rst | 1 + docs_src/source/install.rst | 61 +++++++++++++++++++++++++-- docs_src/source/kettle_controller.rst | 8 ++-- docs_src/source/properties.rst | 4 +- docs_src/source/sensor.rst | 10 ++--- docs_src/source/step.rst | 8 ++-- docs_src/source/webapis.rst | 24 +++++++++++ 8 files changed, 101 insertions(+), 23 deletions(-) create mode 100644 docs_src/source/webapis.rst diff --git a/docs_src/source/actor.rst b/docs_src/source/actor.rst index 02275e8..3e1cca8 100644 --- a/docs_src/source/actor.rst +++ b/docs_src/source/actor.rst @@ -11,7 +11,7 @@ Architecture ActorController ^^^^^^^^^^^^^^^ -.. autoclass:: core.controller.actor_controller.ActorController +.. autoclass:: cbpi.controller.actor_controller.ActorController :members: :private-members: :undoc-members: @@ -21,7 +21,7 @@ ActorController CBPiActor ^^^^^^^^^ -.. autoclass:: cbpi_api.CBPiActor +.. autoclass:: cbpi.api.CBPiActor :members: :private-members: :undoc-members: @@ -31,7 +31,7 @@ CBPiActor Custom Actor ^^^^^^^^^^^^^ -.. literalinclude:: ../../core/extension/dummyactor/__init__.py +.. literalinclude:: ../../cbpi/extension/dummyactor/__init__.py :caption: __init__.py :name: __init__-py :language: python @@ -40,6 +40,6 @@ Custom Actor config.yaml -.. literalinclude:: ../../core/extension/dummyactor/config.yaml +.. literalinclude:: ../../cbpi/extension/dummyactor/config.yaml :language: yaml :linenos: \ No newline at end of file diff --git a/docs_src/source/index.rst b/docs_src/source/index.rst index 2815a46..4fbc04d 100644 --- a/docs_src/source/index.rst +++ b/docs_src/source/index.rst @@ -18,6 +18,7 @@ Welcome to CraftBeerPi's documentation! kettle_controller properties standards + webapis .. diff --git a/docs_src/source/install.rst b/docs_src/source/install.rst index 5de32fd..b52e87f 100644 --- a/docs_src/source/install.rst +++ b/docs_src/source/install.rst @@ -1,12 +1,65 @@ +============ Installation ============ -Please make sure that Python 3.6 is installed +Please make sure that Python 3.5 is installed. +`Rapsbian Stretch `_ is required at least. +It will also run on MacOS + + +Download and Installation +========================= + :: - git clone https://github.com/manuel83/craftbeerpi4 + $ sudo pip install -i https://test.pypi.org/simple/ cbpi - cd craftbeerpi4 +Further version can be found on PiPy: https://test.pypi.org/project/cbpi/ + +.. note:: + All dependencies will be installed automatically. The installation will add the command "cbpi" to your shell. + +To uninstall just remove the package via pip. + +:: + + $ sudo pip uninstall cbpi + +Run the Server +============== + +To start CraftBeerPi just run the following command in your shell +:: + + $ cbpi + + +During the first startup a `config` and `logs` folder gets created in the directory from where the `$ cbpi` in called +PIP Website: https://test.pypi.org/project/cbpi/ + + +Update CraftBeerPi +================== + +That's super easy. Just run again with upgrade option +:: + $ sudo pip install -i https://test.pypi.org/simple/ cbpi --upgrade + + +Install plugins +=============== + +Plugins are normal Python Pip packages. + +Install +:: + + $ sudo pip install -i https://test.pypi.org/simple/ CBPiActor1 + +Uninstall + +:: + + $ pip uninstall CBPiActor1 - pip install -r requirements.txt diff --git a/docs_src/source/kettle_controller.rst b/docs_src/source/kettle_controller.rst index 99e18ff..41bde1e 100644 --- a/docs_src/source/kettle_controller.rst +++ b/docs_src/source/kettle_controller.rst @@ -6,7 +6,7 @@ Kettle KettleController ^^^^^^^^^^^^^^^^ -.. autoclass:: core.controller.kettle_controller.KettleController +.. autoclass:: cbpi.controller.kettle_controller.KettleController :members: :private-members: :undoc-members: @@ -16,7 +16,7 @@ CBPiKettleLogic ^^^^^^^^^^^^^^^ -.. autoclass:: cbpi_api.CBPiKettleLogic +.. autoclass:: cbpi.api.CBPiKettleLogic :members: :show-inheritance: :inherited-members: @@ -25,7 +25,7 @@ CBPiKettleLogic Custom Logic ^^^^^^^^^^^^^ -.. literalinclude:: ../../core/extension/dummylogic/__init__.py +.. literalinclude:: ../../cbpi/extension/dummylogic/__init__.py :caption: __init__.py :name: __init__-py :language: python @@ -34,6 +34,6 @@ Custom Logic config.yaml -.. literalinclude:: ../../core/extension/dummylogic/config.yaml +.. literalinclude:: ../../cbpi/extension/dummylogic/config.yaml :language: yaml :linenos: \ No newline at end of file diff --git a/docs_src/source/properties.rst b/docs_src/source/properties.rst index 36efa58..caa5fcb 100644 --- a/docs_src/source/properties.rst +++ b/docs_src/source/properties.rst @@ -13,7 +13,7 @@ Typical example how to use properties in an actor module. Custom Actor ^^^^^^^^^^^^^ -.. literalinclude:: ../../core/extension/dummyactor/__init__.py +.. literalinclude:: ../../cbpi/extension/dummyactor/__init__.py :caption: __init__.py :name: __init__-py :language: python @@ -23,7 +23,7 @@ Custom Actor -.. autoclass:: cbpi_api.Property +.. autoclass:: cbpi.api.Property :members: :private-members: :undoc-members: diff --git a/docs_src/source/sensor.rst b/docs_src/source/sensor.rst index 79bf0c6..5d13a7f 100644 --- a/docs_src/source/sensor.rst +++ b/docs_src/source/sensor.rst @@ -5,7 +5,7 @@ Sensor Sensor Controller ^^^^^^^^^^^^^^^^^ -.. autoclass:: core.controller.sensor_controller.SensorController +.. autoclass:: cbpi.controller.sensor_controller.SensorController :members: :private-members: :undoc-members: @@ -15,7 +15,7 @@ Sensor Controller CBPiSensor ^^^^^^^^^^ -.. autoclass:: cbpi_api.CBPiSensor +.. autoclass:: cbpi.api.CBPiSensor :members: :private-members: :undoc-members: @@ -25,15 +25,15 @@ CBPiSensor Custom Sensor ^^^^^^^^^^^^^ -.. literalinclude:: ../../core/extension/dummysensor/__init__.py +.. literalinclude:: ../../cbpi/extension/dummysensor/__init__.py :caption: __init__.py - :name: __init__-py + :name: __init__.py :language: python :linenos: config.yaml -.. literalinclude:: ../../core/extension/dummysensor/config.yaml +.. literalinclude:: ../../cbpi/extension/dummysensor/config.yaml :language: yaml :linenos: \ No newline at end of file diff --git a/docs_src/source/step.rst b/docs_src/source/step.rst index 9491107..eb7a706 100644 --- a/docs_src/source/step.rst +++ b/docs_src/source/step.rst @@ -6,7 +6,7 @@ Brewing Step StepController ^^^^^^^^^^^^^^^ -.. autoclass:: core.controller.step_controller.StepController +.. autoclass:: cbpi.controller.step_controller.StepController :members: :undoc-members: @@ -16,7 +16,7 @@ StepController CBPiSimpleStep ^^^^^^^^^^^^^^ -.. autoclass:: cbpi_api.CBPiSimpleStep +.. autoclass:: cbpi.api.CBPiSimpleStep :members: :undoc-members: :show-inheritance: @@ -28,7 +28,7 @@ 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:: ../../core/extension/dummystep/__init__.py +.. literalinclude:: ../../cbpi/extension/dummystep/__init__.py :caption: __init__.py :language: python :linenos: @@ -36,6 +36,6 @@ This is an example of a custom step. The Step class need to extend Simple step. config.yaml -.. literalinclude:: ../../core/extension/dummystep/config.yaml +.. literalinclude:: ../../cbpi/extension/dummystep/config.yaml :language: yaml :linenos: \ No newline at end of file diff --git a/docs_src/source/webapis.rst b/docs_src/source/webapis.rst new file mode 100644 index 0000000..3509033 --- /dev/null +++ b/docs_src/source/webapis.rst @@ -0,0 +1,24 @@ +REST API +======== + +The REST API is document by using Swagger.IO. +After startup of the server the API documentation is available under: + +:: + + http://:/api/doc + + +WebSocket API +============= + +WebSocket client can be connected to the following endpoint: + +:: + + http://:/ws + +I recommend to use Dark WebSocket Terminal for testing. At the moment the WebSocket API is just pushing data. + +.. note:: + Currently Security is not enabled. That means you need no password to connect to th Web APIs