Difference between revisions of "Hemera:UserGuide"

From HemeraBook
Jump to: navigation, search
 
Line 1: Line 1:
{| align="right"
+
__NOTOC__
|-
+
| __TOC__
+
|}
+
 
+
 
=Introduction=
 
=Introduction=
 
'''System administrator''' must have installed [[Hemera:Install |Hemera]], and [[Third-party |third-party tools]].<br />
 
'''System administrator''' must have installed [[Hemera:Install |Hemera]], and [[Third-party |third-party tools]].<br />
Line 9: Line 5:
 
<br />
 
<br />
 
All command lines are given assuming Hemera scripts are [[Appendix#Hemera_scripts_availability |available in '''PATH''']].<br />
 
All command lines are given assuming Hemera scripts are [[Appendix#Hemera_scripts_availability |available in '''PATH''']].<br />
<br />
 
  
=Configuration=
+
=Preparation=
==Environment and third-party tools==
+
* ensure your configuration is good
Ensure you have well updated your configuration file.<br />
+
You can launch the following script to help you:
+
 
  checkConfig.sh
 
  checkConfig.sh
  
==Core module==
+
* ensure your [[Hemera:UserGuide:Hardware |hardware]] works
To quickly test some core modules, you may consider following the [[Hemera:QuickStart |Hemera Quick start]].
+
  
==Hardware==
+
* ensure everything works together, performing [[Hemera:QuickStart |quick tests]]
Before using Hemera, you must ensure hardware is well configured.
+
 
+
===Microphone===
+
You must ensure you can record with your microphone.<br />
+
<br/>
+
If you are using directly [http://www.alsa-project.org/ ALSA project], you may find interesting information:
+
* on [http://alsa.opensrc.org/ unofficial wiki]
+
* on [http://tldp.org/HOWTO/Alsa-sound-6.html The Linux Documentation Project]
+
<br/>
+
If you are using [http://www.pulseaudio.org/ Pulse Audio], you may find interesting information:
+
* for RedHat-based distributions, on [http://doc.fedora-fr.org/wiki/PulseAudio Fedora Wiki]
+
* for Debian-based distributions, on [http://doc.ubuntu-fr.org/pulseaudio Ubuntu Documentation]
+
You may need to use [http://0pointer.de/lennart/projects/pavucontrol/ pavucontrol] to ensure:
+
* output AND input are defined
+
* the good input is the default one (in case you have several)
+
* the good input is NOT in 'mute'
+
* [http://sox.sourceforge.net/ sox/rec] (which is used by Hemera) uses the good input (it must NOT use "monitor")
+
 
+
<br/>
+
'''In any case''', you may test your microphone with a recording tool like [http://audacity.sourceforge.net/ Audacity].
+
 
+
===Webcam===
+
(will come later)
+
  
 +
=Enjoy Hemera=
 +
* [[Hemera:UserGuide:Hemera |start Hemera]] (and learn to status and stop)
 
<br />
 
<br />
=Use Hemera=
+
Now, you can control Hemera with your voice:
==Hemera accessibility==
+
* in any case, Hemera will use the speech synthesis core module to give you an acknowledgment (including error) or an answer
===Start===
+
To start Hemera:
+
hemera.sh -S
+
  
Output sample:
+
* play with [[Hemera:UserGuide:Parrot |parrot mode]]
<pre>
+
14/05/11 16:51.26  [hemera]  LogFile: /home/projettwk/programmation/projects/hemera/Hemera/run/log/2011-05-14-16-51-26-hemera.log
+
14/05/11 16:51.26  [inputMonitor]  Launched input monitor.
+
14/05/11 16:51.26  [IOProcessor] Launched input/output processor.
+
14/05/11 16:51.26  [soundRecorder]  Launched sound recorder.
+
14/05/11 16:51.26  [hemera]  Found: Apache Tomcat Version 7.0.12
+
14/05/11 16:51.26  [hemera] Apache Tomcat start ... ok
+
</pre>
+
  
===Status===
+
* use one of [[Hemera:UserGuide:Commands |recognized commands]]
At any time, you can get Hemera status:
+
hemera.sh -T
+
 
+
Output sample:
+
<pre>
+
14/05/11 16:55.48  [hemera]  LogFile: /home/projettwk/programmation/projects/hemera/Hemera/run/log/2011-05-14-16-55-48-hemera.log
+
14/05/11 16:55.48  [hemera]  Hemera uptime: 00d 00h:04m.22s
+
14/05/11 16:55.48  [hemera]  Hemera mode: local
+
14/05/11 16:55.48  [hemera]  Recognized commands mode: normal
+
14/05/11 16:55.48  [inputMonitor]  input monitor is running.
+
14/05/11 16:55.48  [IOProcessor]  input/output processor is running.
+
14/05/11 16:55.48  [soundRecorder]  sound recorder is running.
+
</pre>
+
 
+
Obviously, Hemera status can be requested even if it is not started, output sample:
+
<pre>
+
14/05/11 16:57.05  [hemera]  LogFile: /home/projettwk/programmation/projects/hemera/Hemera/run/log/2011-05-14-16-57-05-hemera.log
+
14/05/11 16:57.05  [hemera]  Hemera uptime: not started
+
14/05/11 16:57.05  [hemera]  Hemera mode: local
+
14/05/11 16:57.05  [inputMonitor]  input monitor is stopped.
+
14/05/11 16:57.05  [IOProcessor]  input/output processor is stopped.
+
14/05/11 16:57.06  [soundRecorder]  sound recorder is stopped.
+
</pre>
+
 
+
===Stop===
+
At any time, you can stop all Hemera activities:
+
hemera.sh -K
+
 
+
Output sample:
+
<pre>
+
14/05/11 16:56.56  [hemera]  LogFile: /home/projettwk/programmation/projects/hemera/Hemera/run/log/2011-05-14-16-56-56-hemera.log
+
14/05/11 16:56.56  [inputMonitor]  Stopped input monitor.
+
14/05/11 16:56.57  [IOProcessor]  Stopped input/output processor.
+
14/05/11 16:56.58  [soundRecorder]  Stopped sound recorder.
+
14/05/11 16:56.58  [hemera]  Found: Apache Tomcat Version 7.0.12
+
14/05/11 16:56.58  [hemera]  Apache Tomcat stop ... ok
+
</pre>
+
 
+
==Hemera features==
+
===Web module===
+
''Since Hemera v0.2.''<br /><br />
+
If Hemera has been launched in "local" mode, you can use the Web module (address must be adapted to your configuration):
+
http://localhost:8080/Hemera/
+
 
+
===Speech synthesis & Speech recognition===
+
''Since Hemera v0.1.''<br /><br />
+
You can use your microphone to give command to Hemera.<br />
+
You can test/use any of the [[Hemera:Features#Recognized_commands |recognized commands]].<br />
+
<br />
+
For instance, you can request to '''search''' definition of '''Intelligence'''.<br />
+
Another interesting test is to activate the '''parrot mode''', and then to say what you want.<br />
+
<br />
+
In any case, Hemera will give you an acknowledgment or an answer.<br />
+
If a command is not understood, Hemera will say an error message.
+
  
 
[[Category:HemeraBook/en]]
 
[[Category:HemeraBook/en]]
 
[[Category:user/en]]
 
[[Category:user/en]]

Latest revision as of 21:42, 14 December 2011

Introduction

System administrator must have installed Hemera, and third-party tools.
Trick: if it is not the case, Standard user can perform a local installation (usually in ~/hemera).

All command lines are given assuming Hemera scripts are available in PATH.

Preparation

  • ensure your configuration is good
checkConfig.sh
  • ensure everything works together, performing quick tests

Enjoy Hemera


Now, you can control Hemera with your voice:

  • in any case, Hemera will use the speech synthesis core module to give you an acknowledgment (including error) or an answer