furhat-core v0.2.0

FurhatJSCore

Client library for connecting to and operating FurhatOS (read more at: www.furhatrobotics.com)

Usage

Install using:

npm install furhat-core

Import (ES6 import syntax) using:

import Furhat from 'furhat-core'

Initialize the connection:

let furhat = new Furhat()

furhat.init('localhost', '80', 'api', (status, hat) => {
    if (status === 'open') {
        hat.say('I am connected!')
    }
})

API

Table of Contents

• Furhat
  • init
  • onConnectionError
  • onConnectionClose
  • send
  • subscribe
  • subscribeGroup
  • say
  • userSpeech
  • userSpeechStart
  • gesture

Furhat

Furhat main class. Maintains the websocket connection to furhatOS and has methods to send events, subscribe to events and helper methods such as say, gesture, etc.

Parameters

• domain IP Address for furhatOS - localhost if SDK.
• port port for RealTimeAPI module of furhatOS.
• route route for RealTimeAPI module of furhatOS.

init

Initializes the connection and return a promise. Await for the promise to resolve before using the object

onConnectionError

Method to set a callback that will be triggered onerror of the underlying websocket

Parameters

• callback Callback function to be trigger on WebSocket connection error

onConnectionClose

Method to set a callback that will be triggered onclose of the underlying websocket

Parameters

• callback Callback function to be trigger on WebSocket connection close

send

Sends an event to furhatOS

Parameters

• event Object containing the event. Mandtory to have event_name parameter in the object

subscribe

Subscribes to the given event and triggers the supplied callback on event

Parameters

• eventName Name of the event to subscribe
• callback Function which needs to be triggered when the given event is recieved
• dontSend Optional Boolean which determines wether to send the subscribe event or not. use it to set callbacks for event that are already subscribed to, for instance with group subscriptions

subscribeGroup

Subscribes to the given event group

Parameters

• groupNumber Number(Assigned ENUM) of the group that needs to be subscribed to

say

Says a given text

Parameters

• text Text which needs to be said by Furhat

userSpeech

Stimulates the speech of a user in the interaction space

Parameters

• text Text which needs to be said by the user

userSpeechStart

Stimulates SenseSpeechStart event. Can be used to stimulate user speech via typing

gesture

Performs the given gesture

Parameters

• name Name of the gesture that needs to be performed