Getting started with the Furhat SDK

Installation

To install the SDK, follow this process:

  • Download and extract Furhat SDK to any folder of your choice from the Furhat Developer Zone (furhat.io).
  • Open said folder in your terminal.
  • Run gradlew run. This will download all needed assets and eventually run the SDK development server.

Upgrading

To upgrade your SDK (or downgrade a version), follow this process:

  • Run the SDK with gradlew run or by running it from IntelliJ IDEA
  • Open your browser (Chrome is recommended) and navigate to http://localhost:8080
  • Log into the web interface with password "admin"
  • Go to settings and upgrade to the latest version (or choose an older version)

Running the SDK

  • Run gradlew run in your SDK folder

First time setup of SDK

  • Make sure the SDK is running
  • Open your browser (Chrome is recommended) and navigate to http://localhost:8080
  • Log into the web interface with password "admin"
  • Connect the Virtual Furhat (that was opened automatically) by pressing Connect. Test a few gestures on the Home screen of web interface to verify that it works.

Setting up TTS and ASR

The Furhat robot and SDK uses external services for speech (both for output text-to-speech [TTS] and input (automatic) speech recognition [ASR]). For now, you need to get your own credentials to get going. The Furhat 2.0 Alpha SDK comes with a Amazon Polly TTS integration and a Google Cloud ASR integration. Both Amazon and Google lets you set up a free account with a free tier and/or trial. Follow the guides below to get started:

  • To setup Amazon Polly TTS: Follow the guide here to create an AWS account, create an IAM user with Amazon polly read access and finally get a key and secret for that user. Then paste your key and secret into Voice settings in the web interface.
  • To setup Google Cloud ASR: Follow the guide here to create a Google cloud service account, create a project, enable the Cloud Speech API, create a service accound and download a JSON key. Paste your JSON-key into Recognizer settings in the web interface.

Setting up and testing microphones and speaker

  • To set up microphones: Configure microphone under microphone settings in web interface.
  • To set up speaker: Configure speaker under the home settings in web interface.
  • Finally, test the speech, gaze and gestures on the home screen and make sure the Virtual Furhat behaves as it should.
  • To test the microphone and speech recognition, create a new skill and test-run it.