浏览代码

Merge branch 'dev' into neurons-OpenWeatherMap

monf 8 年之前
父节点
当前提交
be47addac1
共有 5 个文件被更改,包括 134 次插入112 次删除
  1. 4 4
      Docs/automated_install.md
  2. 1 1
      Docs/dev_env_install.md
  3. 81 76
      Docs/settings.md
  4. 4 3
      README.md
  5. 44 28
      settings.yml

+ 4 - 4
Docs/automated_install.md

@@ -3,7 +3,7 @@
 Clone the project
 ```
 cd
-git clone https://repo/kalliope.git
+git clone https://github.com/kalliope-project/kalliope.git
 ```
 
 Run the install script.
@@ -14,16 +14,16 @@ Run the install script.
 >**Note:** The install script must not be ran as root or with sudo. 
 You will be prompted to enter your sudo password during the installation process.
 
-Be sure you can record you voice, run the following command to capture audio from your microphone
+To ensure that you can record your voice, run the following command to capture audio input from your microphone
 ```
 rec test.wav
 ```
 
-Press CTRL-C after capturing a sample of our voice.
+Press CTRL-C after capturing a sample of your voice.
 
 Then play the recorded audio file
 ```
 play test.wav
 ```
 
-If everything is ok, you can start playing with Kalliope. First, 
+If everything is ok, you can start playing with Kalliope. First, let's take a look to the [default settings](settings.md).

+ 1 - 1
Docs/dev_env_install.md

@@ -46,6 +46,6 @@ play test.wav
 
 Clone the project
 ```
-git clone <TODO set github address>
+git clone https://github.com/kalliope-project/kalliope.git
 ```
 

+ 81 - 76
Docs/settings.md

@@ -1,17 +1,19 @@
 # Kalliope settings
 
-This part of the documentation deals with the main configuration of Kalliope. 
-This configuration is a file placed at the root of the project tree and called settings.yml.
+This part of the documentation explains the main configuration of Kalliope.
+You will have to modify the configuration file called `settings.yml` which is located in the root of the project tree.
 
-The syntax used is YAML.
+The file is written on YAML syntax.
 
-# General defaults
+## Tunable settings
 
-In the settings.yml, the following settings are tunable:
+The following settings can be modified:
+
+## Triggers configuration
 
 #### default_trigger
 
-The trigger is the module in charge detecting the hotword that wake up Kalliope.
+The trigger is the module detecting the hotword that will wake up Kalliope.
 Common usage of hotword include Alexa on Amazon Echo, OK Google on some Android devices and Hey Siri on iPhones.
 
 Specify the name of the trigger module you want to use.
@@ -19,31 +21,70 @@ Specify the name of the trigger module you want to use.
 default_trigger: "trigger_name"
 ```
 
-Available trigger for Kalliope are:
+Available triggers for Kalliope are:
 - snowboy
 
+#### 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/model.pmdl"
+```
+
+## Speech to text configuration
+
 #### 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 Kalliope core. 
-By default, Kalliope use google STT engine.
+A Speech To Text(STT) is an engine used to translate what you say into a text that can be processed by Kalliope core.
+By default, Kalliope uses google STT engine.
 
-You must provide an engine name in this variable following the syntax bellow
+The following syntax is used to provide the engine name:
 ```
 default_speech_to_text: "stt_name"
 ```
 
 E.g
 ```
-default_speech_to_text: "snowboy"
+default_speech_to_text: "google"
 ```
 
 Get the full list of [SST engine here](stt.md).
 
+#### speech_to_text
+Each STT has it own configuration. This configuration is passed as argument as shown bellow
+```
+speech_to_text:
+  - stt_name:
+      parameter_name: "value"
+```
+
+E.g:
+```
+speech_to_text:
+  - google:
+      language: "fr-FR"
+  - bing
+```
+
+Some arguments are required, some others are optional, please refer to the [STT documentation](stt.md) to know available parameters for each supported STT.
+
+## Text to speech configuration
+
 #### default_text_to_speech
 A Text To Speech is an engine used to translate written text into a speech, into an audio stream.
 By default, Kalliope use Pico2wave TTS engine.
 
-You must provide a TTS engine name in this variable following the syntax bellow
+The following syntax is used to provide the TTS engine name
 ```
 default_text_to_speech: "tts_name"
 ```
@@ -55,11 +96,33 @@ default_text_to_speech: "pico2wave"
 
 Get the full list of [TTS engine here](tts.md).
 
+#### text_to_speech
+Each TTS has it own configuration. This configuration is passed as argument following the syntax bellow
+```
+text_to_speech:
+  - tts_name:
+      parameter_name: "value"
+```
+
+E.g
+```
+text_to_speech:
+  - pico2wave:
+      language: "fr-FR"
+  - voxygen:
+      language: "fr"
+      voice: "michel"
+```
+
+Some arguments are required, some other optional, please refer to the [TTS documentation](tts.md) to know available parameters for each supported TTS.
+
+## Wake up answers configuration
+
 #### random_wake_up_answers
-When Kalliope detects your trigger/hotword/magic word, she lets you know that he's operational and now waiting for order by answering randomly 
+When Kalliope detects your trigger/hotword/magic word, it lets you know that it's operational and now waiting for order. It's done by answering randomly
 one of the sentences provided in the variable random_wake_up_answers.
 
-This variable must contain a list of string following the syntax bellow
+This variable must contain a list of strings as shownbellow
 ```
 random_wake_up_answers:
   - "You sentence"
@@ -78,15 +141,15 @@ random_wake_up_answers:
 ```
 
 #### random_wake_up_sounds
-You can play a sound when Kalliope detect the hotword/trigger instead of saying something from
+You can play a sound when Kalliope detects the hotword/trigger instead of saying something from
 the `random_wake_up_answers`.
-Place here a list of full path of the sound file or just the name of the file in `/usr/lib/kalliope/sounds`
-The file must be .wav or .mp3 format. By default two file are provided: ding.wav and dong.wav. Of more than on file is present in the list,
+Place here a list of full paths of the sound files you want to use. Otherwise, you can use some default sounds provided by Kalliope which you can find in `/usr/lib/kalliope/sounds`.
+By default two file are provided: ding.wav and dong.wav. In all cases, the file must be in `.wav` or `.mp3` format. If more than on file is present in the list,
 Kalliope will select one randomly at each wake up.
 
 ```
 random_wake_up_sounds:
-  - "local_file_in_sounds_folder.wav" 
+  - "local_file_in_sounds_folder.wav"
   - "/my/personal/full/path/my_file.mp3"
 ```
 
@@ -100,61 +163,3 @@ random_wake_up_sounds:
 
 >**Note: ** If you want to use a wake up sound instead of a wake up answer you must comment out the `random_wake_up_answers` section.
 E.g: `# random_wake_up_answers:`
-
-#### speech_to_text
-Speech to text configuration.
-Each STT has it own configuration. This configuration is passed as argument following the syntax bellow
-```
-speech_to_text:
-  - stt_name:
-      parameter_name: "value"
-```      
-
-E.g:
-```
-speech_to_text:
-  - google:
-      language: "fr-FR"
-  - bing
-```
-
-Some arguments are required, some other optional, please refer to the [STT documentation](stt.md) to know available parameters for each supported STT.
-
-
-#### text_to_speech
-Text to speech configuration
-Each TTS has it own configuration. This configuration is passed as argument following the syntax bellow
-```
-text_to_speech:
-  - tts_name:
-      parameter_name: "value"
-```
-
-E.g
-```
-text_to_speech:
-  - pico2wave:
-      language: "fr-FR"
-  - voxygen:
-      language: "fr"
-      voice: "michel"
-```
-
-Some arguments are required, some other optional, please refer to the [TTS documentation](tts.md) 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/model.pmdl"
-```

+ 4 - 3
README.md

@@ -1,11 +1,12 @@
 # Kalliope
 
 Kalliope is a modular always-on voice controlled personal assistant designed for home automation.
+Kalliope is based on audio input recognition, so it recognize an order pronounced by the user and then execute actions attached to the order.
 
-TODO: insert video demo EN
-TODO: insert video demo FR
+You can create your own Kalliope bot, by simply choosing and composing the existing modules without writing any code. But, if you need a particular module, you can
+write it by yourself and add it to your project. You can also propose it to the community.
 
-Kalliope can run on a Raspberry Pi and he's multi-lang.
+Kalliope can run on all Linux distribution including a Raspberry Pi and it's multi-lang. The only thing you need is a microphone.
 
 Kalliope is easy-peasy to use, see the hello world
 ```

+ 44 - 28
settings.yml

@@ -4,32 +4,26 @@
 # Use YAML syntax
 # ---------------------------
 
-
+# ---------------------------
+# Trigger
+# ---------------------------
 # This is the trigger that will catch your magic work to wake up Kalliope
 default_trigger: "snowboy"
-# This is the STT that will be used by default
-default_speech_to_text: "google"
-# This is the default TTS that will be used by Kalliope to talk.
-default_text_to_speech: "pico2wave"
 
-# When Kalliope detect the hotword/trigger, he will select randomly a phrase in the following list
-# to notify the user that he's listening for orders
-random_wake_up_answers:
-  - "Oui monsieur?"
-  - "Je vous écoute"
-  - "Monsieur?"
-  - "Que puis-je faire pour vous?"
-  - "J'écoute"
-  - "Oui?"
+# Trigger engine configuration
+# Available engine are:
+# - snowboy
+triggers:
+  - snowboy:
+      pmdl_file: "trigger/snowboy/resources/kalliope-FR-6samples.pmdl"
+      
 
-# You can play a sound when Kalliope detect the hotword/trigger instead of saying something from
-# the `random_wake_up_answers`.
-# Place here the full path of the sound file or just the name of the file in /usr/lib/kalliope/sounds
-# The file must be .wav or .mp3 format. By default two file are provided: ding.wav and dong.wav
-random_wake_up_sounds:
-  - "ding.wav"
-  - "dong.wav"
-  # - "/my/personal/full/path/my_file.mp3"
+# ---------------------------
+# Speech to text
+# ---------------------------
+
+# This is the STT that will be used by default
+default_speech_to_text: "google"
 
 # Spreech to Text engines configuration
 # Available engine are:
@@ -50,6 +44,12 @@ speech_to_text:
       client_id: "lN4JXeaSticbSo9-llczbA=="
 
 
+# ---------------------------
+# Text to speech
+# ---------------------------
+# This is the default TTS that will be used by Kalliope to talk.
+default_text_to_speech: "pico2wave"
+
 # Text to Spreech engines configuration
 # Available engine are:
 # - pico2wave
@@ -73,9 +73,25 @@ text_to_speech:
       language: "fr-fr"
       cache: True
 
-# Trigger engine configuration
-# Available engine are:
-# - snowboy
-triggers:
-  - snowboy:
-      pmdl_file: "trigger/snowboy/resources/kalliope-FR-6samples.pmdl"
+
+# ---------------------------
+# Wake up answers
+# ---------------------------
+# When Kalliope detect the hotword/trigger, he will select randomly a phrase in the following list
+# to notify the user that he's listening for orders
+random_wake_up_answers:
+  - "Oui monsieur?"
+  - "Je vous écoute"
+  - "Monsieur?"
+  - "Que puis-je faire pour vous?"
+  - "J'écoute"
+  - "Oui?"
+
+# You can play a sound when Kalliope detect the hotword/trigger instead of saying something from
+# the `random_wake_up_answers`.
+# Place here the full path of the sound file or just the name of the file in /usr/lib/kalliope/sounds
+# The file must be .wav or .mp3 format. By default two file are provided: ding.wav and dong.wav
+random_wake_up_sounds:
+  - "ding.wav"
+  - "dong.wav"
+  # - "/my/personal/full/path/my_file.mp3"