|
1 | | -# Reference implementation in Java for the Cognitive Spaces Websocket client |
| 1 | +# Reference implementation in Java for the Watson Assistant Solutions Audio Gateway client |
2 | 2 |
|
3 | 3 | This application is responsible for audio streaming on the client to and from the server using the WebSocket protocol. See the Client Interface Specification for details on the messages used to authenticate and converse with the server. |
4 | 4 |
|
@@ -70,9 +70,7 @@ $ scp target/wpa-1.4-SNAPSHOT.jar pi@192.168.1.101:~/watson |
70 | 70 | ``` |
71 | 71 |
|
72 | 72 | ## Run |
73 | | -Copy `configure.properties.example` to `configure.properties` into the the `~/watson/config` directory of the device. Provide configuration and credential information and options by editing the following properties: |
74 | | - |
75 | | -The `start` directory contains startup scripts for both debug and non-debug modes. These scripts can be copied to the `watson` directory on the device. |
| 73 | +Copy `configure.properties.example` to `configure.properties` into the the `~/watson/config` directory of the device. A properly configured `configure.properties` file must exist in the `~/watson/config` directory for the client to run. Provide configuration and credential information and options by editing the following properties: |
76 | 74 |
|
77 | 75 | ### Required Connection Information |
78 | 76 | * `host` The URL of the Audio Gateway server (should NOT include the protocol prefix such as "https://") |
@@ -121,6 +119,15 @@ $ java -jar target/wpa-1.4-SNAPSHOT.jar |
121 | 119 |
|
122 | 120 | Note: the primary logging control is configured with the [Log4J Configuration](src/main/java/log4j2.xml). These controls will be moved there as specific loggers in the future. |
123 | 121 |
|
| 122 | +### Commands to Run the Client |
| 123 | +The `start` directory in the project contains startup scripts for both debug and non-debug modes. These scripts can be copied to the `~/watson` directory on the device and be used to run the client. |
| 124 | + |
| 125 | +The commands to run in standard mode are: |
| 126 | +(Raspberry Pi, Linux, Apple) |
| 127 | +`sudo java -jar wpa-1.4-SNAPSHOT.jar` |
| 128 | +(Windows) |
| 129 | +`java -jar wpa-1.4-SNAPSHOT.jar` |
| 130 | + |
124 | 131 |
|
125 | 132 | ## Socket Interface |
126 | 133 | The client provides a socket command and audio interface to allow remote control of the client (rather than through the GPIO, local microphone, and speaker). |
|
0 commit comments