jens/RhasspyVisualConversationTool
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Put installation instructions in the README.md file.

Browse Source
This commit is contained in:
Jens 2021-02-27 22:58:52 +01:00
parent 43210a90a2
commit 61bcfec015
1 changed files with 73 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -3,3 +3,75 @@
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/
## Setup instructions
### Download jar file
Download the jar file of the program and put it in a folder, e.g. under _/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_
### Configuration file
Create _RhasspyVisualConversationTool-settings.ini_ with the following content:
```
language=de-DE
sslDebug=false
keystoreFilename=
keystorePassword=changeme
logFolderPath=/var/log/rhasspyVisualConversationTool
logLevel=5
mqttClientServerHostname=mqtt.yourServer.com
mqttClientServerPort=1883
mqttClientUseSsl=false
mqttClientUseAuthentication=false
mqttClientUsername=
mqttClientPassword=
siteId=
```
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_ .
### Create start script
I suggest to use this path: _/home/pi/Desktop/startConversationTool.sh_
Put this content into the file (adapt the folder if you changed it above):
```
#!/bin/bash
while(true)
do
cd /home/pi/RhasspyVisualConversationTool/
/usr/bin/java -jar /home/pi/RhasspyVisualConversationTool/RhasspyVisualConversationTool.jar
sleep 5
done
```
Make it runnable: _chmod 775 /home/pi/Desktop/startConversationTool.sh_
### Make the script autostart with the graphical user interface
Create this file: _/home/pi/.config/autostart/conversationTool.desktop_
with the following content:
```
[Desktop Entry]
Type=Application
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.