Skip to content

DaanGoslinga/interaction-design-tool-ir

 
 

Repository files navigation

Interaction-Design Tool for Multi-Modal Robot Communication

This project provides a prototyping tool for designing interactions with social robots. The current version of the tool requires Python3 and is compatible with the Pepper and NAO Robots. Interacting with the robots can be via the qi framework (Python2) or the Interactive-Robotics cloud (Python3).

The tool was successfully tested on MAC and LINUX (note that on Linux machines you may need to change the display if the tool is not showing correctly).

Requirements

Python 3.x PyQt 5.15.0 PyYAML 5.x Spotipy 2.9.x

To use the tool you need to do the following:

A. Clone the repository (e.g., in the Documents folder).

$ cd ~/Documents

$ git clone https://github.com/ES-TUDelft/interaction-design-tool-ir.git

B. Install the requirements

Follow the instructions in Section I

C. Run the following script to load the tablet app on Pepper:

$ cd ~/Documents/interaction-design-tool-ir

$ ./scripts/update_app.sh

D. Launch the user interface and robot workers as follows:

$ cd ~/Documents/interaction-design-tool-ir

$ python3 main_tool.py

  • Click "Connect" to the robot and enter the settings (e.g., name and realm or IP) then run:

    • Option 1: using the interactive-robotics cloud (requires Python 3 and robot realm)

      python3 main_robot.py

    • Option 2: using qi framework (requires Python 2 and robot IP)

      python2 main_qi_robot.py

  • Note: This repository is being updated on a regular basis. Use git pull to integrate the latest changes.

Content

I. Installation Guide

II. Setting up Spotify

III. User Manual

IV. Citation


I. Installation Guide

Follow the instructions for MAC and LINUX


II. Setting up Spotify

  • Follow the instructions in the setup Spotify document

  • Once you're connected to Spotify, you'll be able to see your playlists and tracks.

  • To play a song (e.g., using the test button or the mini-player panel in the main interface), you will need an active device (i.e., a Spotify Player) that is running on either your browser or PC/Phone.

  • NOTE: When the player is not able to start a song, it means the device is not active. Just refresh your Spotify Player browser or the desktop app.

  • (DISABLED in the current version) When playing music, you can set the robot to do some animations as follows:


III. User Manual

TODO


IV. Citation

Please cite our work when you use this tool in your studies:

  • Elie Saad, Joost Broekens and Mark A. Neerincx (2020): An Iterative Interaction-Design Method for Multi-Modal Robot Communication. In Proceedings of the IEEE International Conference on Robot and Human Interactive Communication (RO-MAN), pp. 690-697, IEEE.

    @InProceedings{Saad2020,
      author    = {Elie Saad and Joost Broekens and Mark A. Neerincx},
      booktitle = {IEEE International Conference on Robot and Human Interactive Communication (RO-MAN)},
      title     = {An Iterative Interaction-Design Method for Multi-Modal Robot Communication},
      year      = {2020},
      pages     = {690--697},
      publisher = {IEEE},
    }
    

About

Interaction-Design tool for designing human-robot interactions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.9%
  • Other 1.1%