diff --git a/README.md b/README.md index 6af22ea..f2e5ad6 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,27 @@ This application is supposed to work as a visual helper for Rhasspy conversations on setups that have a screen or even a touchscreen. -See more information and detailed instructions on https://server47.de/rhasspy/ +See more of my Rhasspy accessories and skills on https://server47.de/rhasspy/ +![Idle state](https://server47.de/rhasspy/RhasspyVisualConversationTool/RVCT_screenshot_1.png) + +![Wakeword recognized](https://server47.de/rhasspy/RhasspyVisualConversationTool/RVCT_screenshot_2.png) + +![Intent recognized](https://server47.de/rhasspy/RhasspyVisualConversationTool/RVCT_screenshot_3.png) ## Setup instructions ### Download jar file -Download the jar file of the program and put it in a folder, e.g. under _/home/pi/RhasspyVisualConversationTool_ +Download the jar file from [here](https://git.server47.de/jens/RhasspyVisualConversationTool/raw/branch/master/executable/RhasspyVisualConversationTool.jar) +or compile it yourself. +Then put it in a folder, e.g. _/home/pi/RhasspyVisualConversationTool_ ### Make sure java is installed -_which java_ should return something. If it doesn't install a java runtime environment, e.g. with _apt install openjdk-11-jre_ +_which java_ should return something. If it does not then install a java runtime environment, e.g. with _apt install openjdk-11-jre_ ### Configuration file -Create _RhasspyVisualConversationTool-settings.ini_ with the following content: +Create _RhasspyVisualConversationTool-settings.ini_ with the following content: ``` language=de-DE @@ -37,12 +44,16 @@ mqttClientPassword= siteId=satellite01 ``` -If you have set _mqttClientUseSsl=true_ it's at least likely you have your own PKI. In that case create a java keystore and put your root certificate in it. Then save the keystore in the folder of the jar and config file and put its filename for _keystoreFilename_ . +If you have set _mqttClientUseSsl=true_ it's at least likely you have your own PKI. In that case create a java keystore and put your root certificate in it. Save the keystore in the folder of the jar and config file and put its filename as value for _keystoreFilename_ . + +If you want the window to always stay visible set _hideWindowWhenIdle_ to false. Otherwise the window will minimize after 2 seconds when it has nothing to do. ### Create start script I suggest to use this path: _/home/pi/Desktop/startConversationTool.sh_ +That way you could start simply start it manually if you have a touchscreen. + Put this content into the file (adapt the folder if you changed it above): ``` @@ -88,6 +99,12 @@ In my own use-case the screen is usually off and turns on only when a command is * _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. +For me these settings have worked quite well: + +![Idle state](https://server47.de/rhasspy/RhasspyVisualConversationTool/RPI_Screensaver_settings_1.png) + +![Idle state](https://server47.de/rhasspy/RhasspyVisualConversationTool/RPI_Screensaver_settings_2.png) + ### 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_