Commit 24a28310 authored by Boksebeld, N.H.J.'s avatar Boksebeld, N.H.J.
Browse files

Update README.md

parent 2cf5fe39
# Choregraphe Tutorial
This project contains all code and installation instructions neccessary to follow the Choregraphe Tutorial in which we get Pepper moving!
In order to participate in this tutorial you will need to have both Choregraphe and NAOqi installed to run code on Pepper. Choregraphe is a graphical programming interface with which you can quickly get access to very high level functions of Pepper such as speech recognition. NAOqi is the Python 2.7 interface with which you can program Pepper. Here are the instructions to installing these:
In order to participate in this tutorial you will need Choregraphe installed to run code on Pepper. Choregraphe is a graphical programming interface with which you can quickly get access to very high level functions of Pepper such as speech recognition. There are also optional instructions to install NAOqi already which is the Python 2.7 interface with which you can program Pepper. If there's time left during this tutorial NAOqi can also be used. The instructions to installing both of these are below:
# Installing Choregraphe
......@@ -20,7 +20,19 @@ In order to participate in this tutorial you will need to have both Choregraphe
6. Once Choregraphe runs for the first time it will ask for a license key here enter the key: `654e-4564-153c-6518-2f44-7562-206e-4c60-5f47-5f45`
# Installing NAOqi
# Tutorial Preparation
Now you've got all the software above installed you are almost fully prepared for the Choregraphe Robot interaction tutorial. As a last step we will configure Choregraphe to use the built in virtual robot. This is a simulator that renders Pepper executing your code so you can see the movements you program. To initialize and connect to your virtual robot, follow these steps:
* `Edit > Preferences > Virtual robot` - Change the robot to Pepper Y20 (V16).
* `Connect > Connect to virtual robot`
This virtual robot has limited capabilities compared to the real robot: any visual, auditory or sensory functions do not work. This virtual robot is really only meant for checking if you are not producing any dangerous movement. The qiBullet simulator, for which there's a tutorial [here](https://gitlab.tue.nl/ha800-hri/tutorials/intelligent-robots-co-rdinate-transformations/sprint-2/-/tree/master/qibullet), allows you to simulate other behaviors as well.
Now that the virtual robot has been connected you are fully prepared for the tutorial. However, to get started more quickly and get your virtual robot to move for the first time you could already check out the examples in this Gitlab repository in the folder [`Choregraphe Old Examples`](https://gitlab.tue.nl/ha800-hri/tutorials/intelligent-robots-co-rdinate-transformations/choreography-tutorial/-/tree/main/Choregraphe%20old%20Examples). This folder contains three very nice examples made by Thomas Wagenaar and a good introductory README.md. See if you can already run the movement example on the virtual robot and see Pepper come to life and maybe even let it move yourself in just a few minutes of work.
# Documentation
This repository is mainly focused on supplying all of the information for the 2021/2022 tutorial on Robots and environments using Choregraphe. In 2020/2021 Thomas Wagenaar made a set of tutorials for Choregraphe, NAOqi and qiBullet for which the documented code can still be found in the [`Choregraphe NAOqi qiBullet -20-21-`](https://gitlab.tue.nl/ha800-hri/tutorials/intelligent-robots-co-rdinate-transformations/sprint-2) repository. Here you will find installation instructions, examples and documentation for these three robot programming/simulating environments which you could use as a good starting point for this sprint or future sprints.
# (Optional) Installing NAOqi
In order to install NAOqi we need Python version `2.7.18`, version `3` will not work. Specifically we need the 32-bit version of Python `2.7.18` as the 64-bit version will not work either. Therefore install Python **`2.7.18` 32-bit** as follows:
......@@ -71,7 +83,3 @@ After Python 2.7 has been successfully installed we can now install NAOqi itself
> These instructions were made using the [NAOqi installation guide](https://developer.softbankrobotics.com/pepper-naoqi-25/naoqi-developer-guide/sdks/python-sdk/python-sdk-installation-guide). Documentation of NAOqi can be found in the [Developer guide](https://developer.softbankrobotics.com/pepper-naoqi-25/naoqi-developer-guide).
# Tutorial Preparation
Now you've got all the software above installed you are fully prepared for the Choreograph Robot interaction tutorial. However, to get started more quickly you could already check out the examples in this Gitlab repository in the folder `Choregraphe Old Examples`. This folder contains three very nice examples made by Thomas Wagenaar and a good introductory README.md. See if you can already run the movement example on the virtual robot and see Pepper come to life and maybe even let it move yourself in just a few minutes of work.
# Documentation
This repository is mainly focused on supplying all of the information for the 2021/2022 tutorial on Robots and environments using Choreograph. In 2020/2021 Thomas Wagenaar made a set of tutorials for Choreograph, NAOqi and qiBullet for which the documented code can still be found in the [`Choreographe NAOqi qiBullet -20-21-`](https://gitlab.tue.nl/ha800-hri/tutorials/intelligent-robots-co-rdinate-transformations/sprint-2) repository. Here you will find installation instructions, examples and documentation for these three robot programming/simulating environments which you could use as a good starting point for this sprint or future sprints.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment