Readme.md
This commit is contained in:
parent
61bcfec015
commit
e5f172c890
38
README.md
38
README.md
@ -74,4 +74,40 @@ Exec=/home/pi/Desktop/startConversationTool.sh
|
||||
### Test run
|
||||
When double-clicking your start script the app should come up and connect successfully.
|
||||
|
||||
Restart your Raspberry Pi to make sure the script comes up automatically.
|
||||
Restart your Raspberry Pi to make sure the script comes up automatically.
|
||||
|
||||
### Power settings for normal operation
|
||||
|
||||
In my own use-case the screen is usually off and turns on only when a command is spoken. In case you want that, too:
|
||||
|
||||
* The turning on is done by this application by briefly simulating mouse action.
|
||||
* After the dialogue has finished I want the screen to turn off again soon.
|
||||
* The default power off setting is 10 min.
|
||||
* To decrease that the easiest way will be to install xscreensaver:
|
||||
* _sudo apt install xscreensaver_
|
||||
* Then open the configuration from the "Preferences" menu in the start menu and set the blank value to what is to your liking.
|
||||
|
||||
### How exactly does the application respond to events?
|
||||
#### Hotword detected
|
||||
It will wakeup when a message with a topic of this kind is published: _hermes/hotword/+/detected_
|
||||
However it will only wake up if the message is targeted to the siteId specified in this instance's configuration file.
|
||||
|
||||
#### Intent recognized
|
||||
If an intent is successfully recognized the text recognized will be displayed, so this topic is being watched for: _hermes/intent/#_
|
||||
|
||||
#### When text is asked to be spoken
|
||||
...then it's also printed: _hermes/tts/say_
|
||||
|
||||
#### Session ends
|
||||
Session is ended when the appropriate event is recognized: _hermes/dialogueManager/sessionEnded_
|
||||
|
||||
#### Bonus material
|
||||
Up until here those are events built into Rhasspy. But I've come up with these additional events/commands:
|
||||
|
||||
##### Simply display text
|
||||
Your application just wants some text to be displayed, publish it under topic _hermes/tts/displayText_ using the same syntax as for the speak command.
|
||||
|
||||
##### Display selectable options
|
||||
CONSTRUCTION SITE, NOT FINISHED, YET
|
||||
If you'd like to publish a list of selectable options for the user send it for topic _hermes/tts/displayOptions_
|
||||
Syntax
|
||||
|
Loading…
Reference in New Issue
Block a user