浏览代码

update doc

nico 8 年之前
父节点
当前提交
821c9c941c
共有 5 个文件被更改,包括 90 次插入14 次删除
  1. 24 9
      Docs/default_settings.md
  2. 32 0
      Docs/neuron_template.md
  3. 27 1
      Docs/neurons.md
  4. 1 4
      Docs/signals.md
  5. 6 0
      Docs/trigger.md

+ 24 - 9
Docs/default_settings.md

@@ -9,21 +9,19 @@ The syntax used is YAML.
 
 In the settings.yml, the following settings are tunable:
 
-#### trigger
+#### default_trigger
 
-The current hotword(also called a wake word or trigger word) detector is based on [Snowboy](https://snowboy.kitt.ai/).
+The trigger is the module in charge detecting the hotword that wake up JARVIS.
 Common usage of hotword include Alexa on Amazon Echo, OK Google on some Android devices and Hey Siri on iPhones.
-With JARVIS project, you can set the Hotword you want. You can create your magic word by connecting to [Snowboy](https://snowboy.kitt.ai/) 
-and then download the trained model file.
 
-Once downloaded, place the file in **trigger/snowboy/resources**.
-
-Then, specify the name of the Snowboy model use the following syntax
+Specify the name of the trigger module you want to use.
 ```
-trigger:
-  name: "my_model_name.pmdl"
+default_trigger: "trigger_name"
 ```
 
+Available trigger for JARVIS are:
+- snowboy
+
 #### default_speech_to_text
 
 A Speech To Text(STT) is an engine used to translate what you say into a text that can be processed by JARVIS core. 
@@ -113,3 +111,20 @@ text_to_speech:
 ```
 
 Some arguments are required, some other optional, please refer to the TTS documentation to know available parameters for each supported TTS.
+
+#### triggers
+The default hotword (also called a wake word or trigger word) detector is based on [Snowboy](https://snowboy.kitt.ai/).
+
+Each Trigger has it own configuration. This configuration is passed as argument following the syntax bellow
+```
+triggers:
+  - trigger_name:
+      parameter_name: "value"
+```
+
+E.g, the default Snowboy trigger configuration is
+```
+triggers:
+  - snowboy:
+      pmdl_file: "trigger/snowboy/resources/jarvis.pmdl"
+```

+ 32 - 0
Docs/neuron_template.md

@@ -0,0 +1,32 @@
+# neuron_name
+
+## Synopsis
+
+Little description of what the neuron do.
+
+## Parameters
+
+(usage of a [table generator](http://www.tablesgenerator.com/markdown_tables) is recommended)
+
+| parameter        | required | default                       | choices                           | comments                     |
+|------------------|----------|-------------------------------|-----------------------------------|------------------------------|
+| parameter_name_1 | yes      |                               |                                   | description of the parameter |
+| parameter_name_2 | no       |                               | possible_value_1,possible_value_2 | description of the parameter |
+| parameter_name_3 | yes      | default_value_if_not_provided |                                   | description of the parameter |
+
+
+## Synapse example
+
+```
+ - name: "type here your name"
+    neurons:      
+      - neuron_name:
+          parameter: "value"
+    signals:
+      - order: "this is what I have to say to run this synapse"
+```
+
+
+## Notes
+
+> **Note:** This is an important note concerning the neuron

+ 27 - 1
Docs/neurons.md

@@ -1 +1,27 @@
-# Neurons
+# Neurons
+
+A neuron is a plugin that you can use in a synapse to perform action. 
+Neurons are executed one by one when the input action is triggered.
+
+Neurons are declared in the `neurons` section of a synapse in your brain file.
+The `neurons` section is a list (because it starts with a "-") which contains neuron module name
+```
+neurons:
+    - neuron_name
+    - neuron_2
+    - another_neuron
+```
+
+Some neurons need parameters that can be passed as argument following the syntax bellow:
+```
+neurons:
+    - neuron_name:
+        parameter1: "value1"
+        parameter2: "value2"
+```
+> **note:** parameters are indented with one tabulation bellow the neuron's name.
+
+To know which parameter are required, check of documentation of the neuron.
+
+## List of available neuron
+

+ 1 - 4
Docs/signals.md

@@ -6,9 +6,6 @@ The syntax is the following
 ```
 signals:
     - signal_name: parameter
-    - signal_name:
-        parameter_1: value
-        parameter_2: value
 ```
 
 ## Order
@@ -18,7 +15,7 @@ An **order** signal is a word, or a sentence caught by the microphone and proces
 Syntax:
 ```
 signals:
-    - order: "sentence"
+    - order: "<sentence>"
 ```
 
 Example:

+ 6 - 0
Docs/trigger.md

@@ -0,0 +1,6 @@
+
+
+With JARVIS project, you can set the Hotword you want. You can create your magic word by connecting to [Snowboy](https://snowboy.kitt.ai/) 
+and then download the trained model file.
+
+Once downloaded, place the file in **trigger/snowboy/resources**.