Moved the single tenant audio client from the deprecated internal repository to the public repository

Author: arivatibm

README.md

@@ -37,54 +37,38 @@ $ mvn package
 ## Development and Debugging (ability to use Eclipse IDE)
 **For deployment to a device (e.g. Raspberry Pi) the Maven build must be run from the command line (to create a correctly configured JAR)**
 
-# Instructions for Eclipse
-These instructions are for Eclipse, but those of you that use other IDE's can probably adapt to these instuctions.
+For development and debugging - an `Eclipse project` has been created.  Using a dedicated Java IDE like Eclipse can provide significant benefits during development (and especially debugging).  The Eclipse project is configured to function as a Maven Project/Build.  This means you can edit, build, and debug directly from Eclipse. Remote debugging is also possible.  The Maven build is configured with debug information, so if you run the client on the Raspberry Pi in debug mode you can connect to it from Eclipse and debug interactively.  
 
-For development and debugging - an `Eclipse project` has been created.  Find it as `.project` in the main folder.
+An example command to run the client in remote debug mode is:
+`sudo java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000 -jar wpa-1.4-SNAPSHOT.jar`
+In Eclipse, simply configure a 'Debug Configuration' that specifies the IP address and port of the target and the main class: `Driver`
 
-Using a dedicated Java IDE like Eclipse can provide significant benefits during development (and especially debugging).  The Eclipse project is configured to function as a Maven Project/Build.  This means you can edit, build, and debug directly from Eclipse. Remote debugging is also possible.  The Maven build is configured with debug information, so if you run the client on the Raspberry Pi in debug mode you can connect to it from Eclipse and debug interactively.
+The `start` directory contains startup scripts for both debug and non-debug modes.
 
-Create a new workspace and import the project (as an existing Eclipse project).
+If you are setting this up for the first time, it means you will need to create an Eclipse Workspace or use an existing Workspace.  Import the Eclipse project from this directory into the Workspace.
 
-You can run and debug the client within Eclipse - just set up a 'Run/Debug' configuration with the main class of 'Driver'.
-
-To debug remotely on the Raspberry Pi:
-	An example command to run the client in remote debug mode is:
-	`sudo java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000 -jar wpa-1.4-SNAPSHOT.jar`
-	In Eclipse, simply configure a 'Debug Configuration' that specifies the IP address and port of the target and the main class: `Driver`
-
-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.
-
-To Run/Debug directly from Eclipse (on the local machine) you will need to set up a local Run/Debug configuration.  The main requirement for this is that you will need to indicate that the working directory is the `target/` directory and make sure that the config directory includes a properly configured `configure.properties` file (the Eclipse build does not put one there, so if a 'clean' build is performed there will not be a `configure.properties` file in the directory.  If the `configure.properties` file doesn't exist in the `config` directory the client should announce that to you (a good test really...).
+To Run/Debug directly from Eclipse (on the local machine) you will need to set up a local Run/Debug configuration.  The main requirement for this is that you will need to indicate that the working directory is the `target/` directory and make sure that it includes a properly configured `configure.properties` file (the Eclipse build does not put one there, so if a 'clean' build is performed there will not be a `configure.properties` file in the directory.  If the `configure.properties` file doesn't exist the client should announce that to you (a good test really...).
 
 *(as we find and resolve problems with the Eclipse project, we will add to this section - for example, a 'clean' build will delete 'target', so we probably want a build step to copy a `configure.properties` in at the end of the build.)*
 
 
 ## Deploy
-Our standard deployment to a device is into the ~/watson directory.
-
-Copy the jar (created using the `maven package` command) from the `target/` directory on your local system to the device `~/watson` directory, e.g.
+Copy the jar (created using the `maven package` command) from the `target/` directory to the device, e.g.
 
 ```
-$ scp target/wpa-1.4-SNAPSHOT.jar  pi@192.168.1.101:~/watson
+$ scp target/wpa-1.4-SNAPSHOT.jar  pi@192.168.1.15:~/watson
 ```
 
-## Run
-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:
 
-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.
+## Run
+Copy `configure.properties.example` to `configure.properties` and copy it to the device `~/watson`.  Provide configuration and credential information and options by editing the following properties:
 
 ### Required Connection Information
-* `host` The URL of the Audio Gateway server (should NOT include the protocol prefix such as "https://")
-* `IAMAPIKey` The client IAM API Key associated with the device in the IBM cloud IAM management system
-* `skillset` The skillset to be used by this client
+* `host` The URL of the server
+* `header` The client ID associated with the device in the client database
+* `key` The password, as established in the client database
 
 ### Optional Settings
-
-#### Speech to text engine
-The server supports two STT engines out of the box - Watson STT and Google STT 
-* `engine` - if you use the value `watson`, the server will use the Watson STT for converting audio to text, if you use `google` the server will use the Google STT. (default=google)
-
 #### Audio Response via URL or Streaming
 The server supports returning the response via an audio URL or by streaming the audio to the client.
 * `urltts` (if `true` the server will respond with a URL, if `false` the server will stream the audio (using `audio_data` messages) - default=false)

config/configure.properties.example configure.properties.exampleconfig/configure.properties.example renamed to configure.properties.example

@@ -1,22 +1,10 @@
 ### Server connection parameters
 host=<<endpoint-address>>
-userID=<<user ID or client-id>>
-
+header=<<client-id>>
+key=<<client-password>>
 # Used to make a non-SSL connection if testing on a server without SSL configured (locally). Default=false
 #nossl=true
 
-# IAM API Key is Used to authenticate the client device - created per IBM ID (or Service ID) using IBM Cloud
-IAMAPIKey=
-
-# Choosing which skill set to use (Required parameter)
-skillset=
-
-# Client language specific preferences can be passed (Optional parameter with a default value: en-US)
-#language=en-US
-
-# Choosing which STT and TTS engine to convert audio to text and text to audio - possible values are : watson, google , (Optional parameter with a default value : watson)
-#engine=
-
 ### Controls playback method. Playback using an audio URL in the response [true], playback by streaming audio from the server [false]
 urltts=false
 

pom.xml

@@ -199,10 +199,6 @@
     <artifactId>apache-log4j-extras</artifactId>
     <version>1.2.17</version>
   </dependency>
-    <dependency>
-      <groupId>commons-io</groupId>
-      <artifactId>commons-io</artifactId>
-      <version>2.5</version>
-    </dependency>
   </dependencies>
+
 </project>

src/main/java/Driver.java

@@ -111,9 +111,7 @@ private static Properties readProps() {
             // Just return a null properties...
         } finally {
             try {
-            	if (null != file) {
-            		file.close();
-            	}
+                file.close();
             } catch (IOException e) { }
         }
         return props;

src/main/java/wa/audio/AudioInput.java

@@ -183,7 +183,7 @@ private void captureInternal() throws InterruptedException {
             e.printStackTrace();
         } finally {
             client.getIndicator().off();
-            client.logFinalServerWriteStatus();            
+            client.logFinalServerWriteStatus();
             if (this.client.isServerConnectionReady() && writingToServer) {
                 this.client.writeToServer(ClientHelpers.getClientEndAudioAction().toString());
             }
@@ -192,10 +192,6 @@ private void captureInternal() throws InterruptedException {
                 audioInputDevice.release();
                 audioInputDevice = null;
             }
-            
-            client.wakeupTriggerIsAllowed();
-
-            // TODO is this still needed?
             // Enable a client 'trigger wake up safety' in case we never get a response
             client.scheduleWakeupTriggerEnable();
         }

src/main/java/wa/client/Client.java

@@ -18,10 +18,7 @@
 import java.io.IOException;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
-import java.net.HttpURLConnection;
 import java.net.InetAddress;
-import java.net.URL;
-import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
@@ -38,8 +35,11 @@
 import org.json.JSONException;
 import org.json.JSONObject;
 
+import okhttp3.Credentials;
+import okhttp3.MediaType;
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
+import okhttp3.RequestBody;
 import okhttp3.Response;
 import okhttp3.WebSocket;
 import okhttp3.WebSocketListener;
@@ -81,21 +81,15 @@ public class Client extends WebSocketListener implements ThreadManager, Runnable
 
     private WebSocket webSocket;
 
-    private String IAMAccessToken = null;
-    
-    private String skillset = null;
-
-    private String language = null;
-    
-    private String engine = null;
-
     private String watsonHost = null;
 
     private String watsonPort = null;
 
     private Boolean watsonSsl = true;
 
-    private String userID = null;
+    private String watsonHeader = null;
+
+    private String watsonKey = null;
 
     private Debouncer<String> debouncer;
 
@@ -303,9 +297,6 @@ public void run() {
                         LOG.error("Server connection is not ready and microphone is open - Problem closing the microphone.", e);
                     }
                     if (ServerConnectionStatus.NOTCONNECTED == getServerConnectionStatus()) {
-                    		// IAMAccessToken should be retrieved from the IAM service by providing it with your cloud API Key (based on your IBM ID)
-                        IAMAccessToken = getIAMAccessToken(IAMAPIKey);
-
                         // We need to connect...
                         connect();
                         Thread.sleep(1500);
@@ -790,10 +781,7 @@ else if (null != currentAudioId && null != previousAudioId && !currentAudioId.eq
                 LOG.debug(String.format(" Server sent a different response without a CARD - treat as STOP and play new response. Current-ID: %s  Previous-ID: %s", currentAudioId, previousAudioId));
                 // Clear current audioId
                 previousAudioId = null;
-                
-                // commented the next line as it was causing a bug - after 2-3 utterances the voice playbacks stops
-                //this.audioOutput.stop();
-                                
+                this.audioOutput.stop();
                 getSocketCommandProcessor().sendPlaybackStop();
                 // Don't enable the wake up trigger.  End of playback will do it.
                 allowWakeUpTriggerAfterProcessing = false;
@@ -929,7 +917,6 @@ private void continueConversation(String id, JSONObject complexPromptSttOptions)
 
     private int writeToServerCount;
     private int writeToServerBytes;
-	private String IAMAPIKey;
 
     public synchronized void clearServerWriteLogging() {
         writeToServerCount = 0;
@@ -1041,21 +1028,12 @@ private void joinThreads() {
     }
 
     private void initialize(Properties props) {
-        // Required parameter
-        IAMAPIKey = props.getProperty("IAMAPIKey");
-        skillset = props.getProperty("skillset");
-        
-        // Optional parameters
-        language = props.getProperty("language");
-        engine = props.getProperty("engine");
-        
-
         watsonHost = props.getProperty("host");
         watsonPort = props.getProperty("port");
         String noSsl = props.getProperty("nossl", "false");
         watsonSsl = noSsl.equalsIgnoreCase("false");
-        // the userId
-        userID = props.getProperty("userID");
+        watsonHeader = props.getProperty("header");
+        watsonKey = props.getProperty("key");
         watsonVoice = props.getProperty("voice");
         commandSocketPort = Integer.parseInt(props.getProperty("cmdSocketPort", "10010"));
         audioSocketPort = Integer.parseInt(props.getProperty("audioSocketPort", "10011"));
@@ -1069,15 +1047,13 @@ private void initialize(Properties props) {
             java.util.logging.Logger.getLogger(OkHttpClient.class.getName()).setLevel(Level.FINE);
         }
 
-        LOG.info("USER ID (Optional): " + userID);
-        LOG.info("Language (Optional): " + language);
-        LOG.info("Engine (Optional): " + engine);
         LOG.info("WATSON HOST: " + watsonHost);
         LOG.info("WATSON PORT: " + watsonPort);
-        LOG.info("SKILLSET: " + skillset);        
-        LOG.info("WATSON IAM API Key: *****");        
+        LOG.info("WATSON HEADER: " + watsonHeader);
+        LOG.info("WATSON KEY: *****");
+        LOG.debug(" (" + watsonKey + ")");
 
-        if (watsonHost == null || skillset == null || IAMAPIKey == null) {
+        if (watsonHost == null || watsonHeader == null || watsonKey == null) {
             LocalAudio.play(LocalAudio.ERROR_CONFIG);
             throw new Error("Missing authentication information.  Aborting.");
         }
@@ -1129,43 +1105,7 @@ private void initialize(Properties props) {
 
     }
 
-    private String getIAMAccessToken(String apikey) {    	
-    		String IAMAccessToken = "";
-    		
-	    	String urlParameters  = "apikey="+apikey+"&grant_type=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey";
-	    	byte[] postData       = urlParameters.getBytes( StandardCharsets.UTF_8 );
-	    	int    postDataLength = postData.length;
-	    	String request        = "https://iam.bluemix.net/oidc/token";
-	    	URL url;
-	    	try {
-	    		url = new URL( request );
-	
-	    		HttpURLConnection conn= (HttpURLConnection) url.openConnection();           
-	    		conn.setDoOutput( true );
-	    		conn.setInstanceFollowRedirects( false );
-	    		conn.setRequestMethod( "POST" );
-	    		conn.setRequestProperty( "Content-Type", "application/x-www-form-urlencoded"); 
-	    		conn.setRequestProperty( "cache-control", "no-cache");
-	    		conn.setRequestProperty( "accept","application/json");
-	    		//	conn.setRequestProperty( "charset", "utf-8");
-	    		//	conn.setRequestProperty( "Content-Length", Integer.toString( postDataLength ));
-	    		conn.setUseCaches( false );
-	    		conn.getOutputStream().write(postData);
-	
-	    		String response = org.apache.commons.io.IOUtils.toString(conn.getInputStream(), StandardCharsets.UTF_8);
-	    		JSONObject jsonObj = new JSONObject(response);
-	    		IAMAccessToken = jsonObj.getString("access_token");
-	    		
-	    	} catch (IOException e) {
-	    		LOG.error(String.format("Error - Could not convert IAM API Key to IAM Access token : %s",
-                        e.getMessage()),e);
-	    	}
-    		
-	    return IAMAccessToken;
-    }
-
-
-	/**
+    /**
      * Connect the client to the Watson (Websocket) Server.
      * If the client is currently connected, it will first disconnect and then attempt a new connection.
      * 
@@ -1192,13 +1132,35 @@ private synchronized void connect() throws InterruptedException {
                 .build();
 
         try {
+            String tokenUrl = (watsonSsl ? "https" : "http")
+                    + "://" + watsonHost
+                    + (watsonPort == null ? "" : ":" + watsonPort) + "/v1/api/tokens";
+            Request tokenRequest = new Request.Builder()
+                    .url(tokenUrl)
+                    .header("Authorization", Credentials.basic(watsonHeader, watsonKey))
+                    .post(RequestBody.create(MediaType.parse("text/plain"), ""))
+                    .build();
+
+            Response response = httpClient.newCall(tokenRequest).execute();
+            if (!response.isSuccessful()) {
+                int code = response.code();
+                response.body().close();
+                if (code == 401 || code == 403) {
+                    throw new AuthException("Authentication failure: " + response.message());
+                }
+            }
+
+            String tokenJSON = response.body().string();
+            JSONObject tokenObject = new JSONObject(tokenJSON);
+            String token = tokenObject.getString("token");
+            LOG.info("Token received: " + token);
+
             // Build request
             String webSocketUrl = (watsonSsl ? "wss" : "ws")
                     + "://" + watsonHost
-                    + (watsonPort == null ? "" : ":" + watsonPort) + "?skillset=" + skillset+"&userID=" + userID + "&language=" + language + "&engine=" + engine;
+                    + (watsonPort == null ? "" : ":" + watsonPort) + "?token=" + token;
             Request request = new Request.Builder()
                     .url(webSocketUrl)
-                    .addHeader("Authorization", "Bearer " + IAMAccessToken)
                     .build();
 
             // initialize the watch dog