# furhat-core

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

Latest version **0.2.0** (published 2021-02-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install furhat-core
pnpm add furhat-core
yarn add furhat-core
bun add furhat-core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2021-02-22 |
| First published | 2018-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Unpacked size | 23.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | subbu |
| Maintainers | subbualagappan |
| Keywords | furhat-core |

## Links

- npm: https://www.npmjs.com/package/furhat-core
- Repository: https://github.com/FurhatRobotics/FurhatJSCore
- Homepage: https://github.com/FurhatRobotics/FurhatJSCore#readme
- Issues: https://github.com/FurhatRobotics/FurhatJSCore/issues
- npm.io page: https://npm.io/package/furhat-core

## Recent versions

- 0.2.0 (latest) — 2021-02-22
- 0.1.0 — 2021-02-18
- 0.0.4 — 2018-05-08
- 0.0.3 — 2018-01-12
- 0.0.2 — 2018-01-11
- 0.0.1 — 2018-01-11

## README

# 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

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

#### Table of Contents

-   [Furhat](#furhat)
    -   [init](#init)
    -   [onConnectionError](#onconnectionerror)
    -   [onConnectionClose](#onconnectionclose)
    -   [send](#send)
    -   [subscribe](#subscribe)
    -   [subscribeGroup](#subscribegroup)
    -   [say](#say)
    -   [userSpeech](#userspeech)
    -   [userSpeechStart](#userspeechstart)
    -   [gesture](#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][false by default] 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

---
_Source: https://npm.io/package/furhat-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
