Bläddra i källkod

[Doc] neuron sleep

monf 8 år sedan
förälder
incheckning
d250500f0e
4 ändrade filer med 42 tillägg och 14 borttagningar
  1. 1 1
      neurons/script/README.md
  2. 0 1
      neurons/script/script.py
  3. 32 0
      neurons/sleep/README.md
  4. 9 12
      neurons/sleep/sleep.py

+ 1 - 1
neurons/script/README.md

@@ -1,4 +1,4 @@
-# shell
+# script
 
 ## Synopsis
 

+ 0 - 1
neurons/script/script.py

@@ -6,7 +6,6 @@ from core.NeuronModule import NeuronModule, MissingParameterException, InvalidPa
 
 class Script(NeuronModule):
     def __init__(self, **kwargs):
-        # get message to spell out loud
         super(Script, self).__init__(**kwargs)
         self.path = kwargs.get("path", None)
 

+ 32 - 0
neurons/sleep/README.md

@@ -0,0 +1,32 @@
+# sleep
+
+## Synopsis
+
+This neuron sleeps the system for a given time in seconds.
+
+## Options
+
+| parameter | required | default | choices | comment                         |
+|-----------|----------|---------|---------|---------------------------------|
+| seconds   | YES      |         |         | The number of seconds to sleep. |
+
+## Return Values
+
+No returned values
+
+## Synapses example
+
+Simple example : 
+
+```
+  - name: "run-simple-sleep"
+    neurons:
+      - sleep:
+          seconds: 60
+    signals:
+      - order: "Wait for me "
+```
+
+
+## Notes
+

+ 9 - 12
neurons/sleep/sleep.py

@@ -1,22 +1,19 @@
 import time
 
-from core.NeuronModule import NeuronModule
-
-
-class NoSecondsException(Exception):
-    pass
+from core.NeuronModule import NeuronModule,  MissingParameterException
 
 
 class Sleep(NeuronModule):
-
     def __init__(self, **kwargs):
-        # get message to spell out loud
         super(Sleep, self).__init__(**kwargs)
-        seconds = kwargs.get('seconds', None)
-        # user must specify a message
-        if seconds is None:
-            raise NoSecondsException("You must set a number of seconds as parameter")
-        time.sleep(seconds)
+        self.seconds = kwargs.get('seconds', None)
+
+        # check parameters
+        if self._is_parameters_ok():
+            time.sleep(self.seconds)
 
+        def _is_parameters_ok(self):
+            if self.seconds is None:
+                raise MissingParameterException("You must set a number of seconds as parameter")