mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-12-24 22:44:56 +01:00
bug fixing
This commit is contained in:
parent
8cfffa17bb
commit
b1526fa247
4 changed files with 10 additions and 17 deletions
|
@ -8,6 +8,7 @@ Architecture
|
|||
.. image:: picture.jpeg
|
||||
:scale: 50%
|
||||
|
||||
|
||||
ActorController
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
|
@ -44,16 +45,3 @@ config.yaml
|
|||
:language: yaml
|
||||
:linenos:
|
||||
|
||||
.. mermaid::
|
||||
|
||||
sequenceDiagram
|
||||
participant Alice
|
||||
participant Bob
|
||||
Alice->John: Hello John, how are you?
|
||||
loop Healthcheck
|
||||
John->John: Fight against hypochondria
|
||||
end
|
||||
Note right of John: Rational thoughts <br/>prevail...
|
||||
John-->Alice: Great!
|
||||
John->Bob: How about you?
|
||||
Bob-->John: Jolly good!
|
|
@ -40,7 +40,9 @@ release = '4.0'
|
|||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinxcontrib.mermaid'
|
||||
'sphinxcontrib.mermaid',
|
||||
'sphinxcontrib.blockdiag',
|
||||
'sphinxcontrib.swaggerdoc'
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
|
|
@ -10,7 +10,7 @@ As a main framework CraftBeerPi is based on `aiohttp`
|
|||
* aioHTTP https://aiohttp.readthedocs.io/en/stable/
|
||||
|
||||
CBPiEventBus
|
||||
--------
|
||||
------------
|
||||
|
||||
One core concept of CraftBeerPi 4.x is the CBPiEventBus.
|
||||
It should be avoided to call method on a controller directly. Events should be fired and listener methods should be used.
|
||||
|
@ -34,7 +34,8 @@ Here an example how listen on an event.
|
|||
|
||||
.. note::
|
||||
|
||||
It's imporante to add **kwargs as parameter to the listening method. This makes sure that maybe addtional event paramenter are not causing an exception.
|
||||
It is important to add **kwargs as parameter to the listening method. This makes sure that maybe addtional event paramenter are not causing an exception.
|
||||
|
||||
|
||||
A list of all registered events listeners can be found under: `http://<IP_ADDRESS>:<PORT>/system/events`
|
||||
|
||||
|
@ -59,7 +60,7 @@ Typically you perform just some basing parameter validation and fire an event so
|
|||
|
||||
|
||||
CBPiWebSocket
|
||||
---------
|
||||
-------------
|
||||
|
||||
The CBPiWebSocket is listening on `http://<IP_ADDRESS>:<PORT>/ws`
|
||||
All events are forwarded to all connected web socket clients.
|
||||
|
|
|
@ -8,6 +8,8 @@ After startup of the server the API documentation is available under:
|
|||
|
||||
http://<SERVER_IP>:<PORT>/api/doc
|
||||
|
||||
.. swaggerv2doc:: http://0.0.0.0:8080/api/doc/swagger.json
|
||||
|
||||
|
||||
WebSocket API
|
||||
=============
|
||||
|
|
Loading…
Reference in a new issue