Metadata-Version: 2.1
Name: furhat-remote-api
Version: 1.0.1
Summary: Furhat Remote API
Home-page: https://docs.furhat.io/remote-api
Author: Furhat Robotics
Author-email: support@furhatrobotics.com
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE.md

# furhat
This is the Python Furhat Remote API, used to control the Furhat robot from Python. Find out more at https://docs.furhat.io/remote-api.

Note that the Furhat Remote API Skill needs to be running on the robot for it to work. 

This API is generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen). 
On top of this, some syntactic sugar has been added to make it more intuitive to use in Python. 

## Requirements.

Python 2.7 and 3.4+

## Installation 

You can install the package using pip:

```sh
pip install furhat-remote-api
```
(you may need to run `pip` with root permission: `sudo pip install furhat-remote-api`)

## Getting Started

```python
from furhat_remote_api import FurhatRemoteAPI

# Create an instance of the FurhatRemoteAPI class, providing the address of the robot or the SDK running the virtual robot
furhat = FurhatRemoteAPI("localhost")

# Set voice to Matthew (English)
furhat.set_voice(name='Matthew')

# Get the list of users
users = furhat.get_users()

if len(users) > 0:
    # Attend the nearest user
    furhat.attend(user="CLOSEST")
    furhat.say(text="Oh, hello there", blocking=True)

furhat.say(text="Let me show you my cool LED lights", blocking=True)
# Set the LED lights
furhat.set_led(red=255, green=0, blue=0)

furhat.say(text="And a nice gesture", blocking=True)
# Perform a named gesture
furhat.gesture(name="ExpressDisgust", blocking=True)

furhat.say(text="Please say something", blocking=True)

# Listen for speech
answer = furhat.listen()

if answer.message != "":
    furhat.say(text="I think you said, " + answer.message, blocking=True)
else:
    furhat.say(text="I don't think you said anything", blocking=True)
```

For a complete documentation of the API, see https://docs.furhat.io/remote-api


