From 97dbc5245921a1caeab1c22779f42910a60dcd13 Mon Sep 17 00:00:00 2001 From: winterhalderp Date: Fri, 23 Apr 2021 15:39:40 +0200 Subject: [PATCH] Update 'src/pubsub/pubsub/Readme.md' --- src/pubsub/pubsub/Readme.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/src/pubsub/pubsub/Readme.md b/src/pubsub/pubsub/Readme.md index 480073c..31cd019 100644 --- a/src/pubsub/pubsub/Readme.md +++ b/src/pubsub/pubsub/Readme.md @@ -20,10 +20,16 @@ Library files: * `MinimalServiceClient` class ## How to use +In the following the various classes named above are referred to as `Minimal` with `` standing for topic publisher/subscriber or service host/client. + You can use the `Minimal` classes in three ways: -* Create `Minimal` in your script (eg. [topic_listener.py](None) where data is echanged between the script environment and the class environment) -* Implement `Minimal` inside your device class the same way as implementing in your main script (__<-- ToDo !!!__) -* Build device class upon `Minimal` class (eg. [statemachine_host_example.py](None) where a device class is built upon the `MinimalServiceProvider` class) by implementing this structure +* Create `Minimal` in your script (eg. [topic_listener.py](None)): Here data is echanged between the script environment and the class environment. +__Upsides__: You can implement as many instances of `Minimal` as you like +__Downsides__: Code get's complicated and confusing +* Implement `Minimal` inside your device class the same way as implementing in your main script (__<-- ToDo !!!__) +__Upsides__: You can implement as man instances of `Minimal` as you like; You can wrap these instances inside you device class +__Downsides__: __ToDo__ +* Build device class upon `Minimal` by using this structure ```python class Child_Class(Parent_Class): ``` @@ -31,3 +37,6 @@ For example: ```python class StateMachineCMDServiceProvider(MinimalServiceProvider): ``` +(Example: [statemachine_host_example.py](None): device class is built upon `MinimalServiceProvider` class.) +__Upsides__: `Minimal` is automatically instantiated when creating an instance of your device class though `__init()__` +__Downsides__: You can only implement one instance of `Minimal`, eg. one device class can only implement one publisher, in this case you want to implement `Minimal` inside device class (see above) \ No newline at end of file