Commit 61eb3b66 authored by Boksebeld, N.H.J.'s avatar Boksebeld, N.H.J.
Browse files

Update README.md

parent f4c60498
# Choreographe Tutorial
This project contains all code and installation instructions neccessary to follow the Choreographe Tutorial in which we get Pepper moving!
In order to participate in this tutorial you will need to have both Choreographe and NAOqi installed to run code on Pepper. Here are the instructions to installing these:
In order to participate in this tutorial you will need to have both Choreographe and NAOqi installed to run code on Pepper. Choreographe 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:
# Installing Choreographe
1. Start by downloading the `Choregraphe Setup version 2.5.10, Win 32` from the [Choreographe download page](https://developer.softbankrobotics.com/pepper-2-5/downloads/pepper-naoqi-25-downloads-windows).
> Note: If you are not using Windows you can click on Downloads and select either Linux or Mac to download the right installer. I will continue using the Windows version but your installation procedure should be similar.
2. Execute the downloaded **`choregraphe-suite-2.5.10.7-win32-setup.exe`**.
3. Click "next", then accept the licence agreement and click "next" again.
4. Choose for a the Quick installation mode, again click "next" and Choreographe should start installing.
5. At the end of the installation leave the checkmark to launch Choreographe and click "finish".
6. Once Choreographe 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
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:
### Installing Python 2.7.18 32-bit
1. Download the installer [here](https://www.python.org/downloads/release/python-2718/), for Windows choose the `Windows x86 MSI installer` **not the 64-bit version**.
> Note: If you already had the 64-bit version of Python 2.7 installed remove this version and replace it with the 32-bit version.
2. Run the installer you just downloaded.
3. (Optional) Test if you installed Python 2.7 correctly by writing a small python file and running it using `py -2 myfile.py`. For more detailed instructions on this look at the last step of installing NAOqi.
### Installing the NAOqi Python SDK
After Python 2.7 has been successfully installed we can now install NAOqi itself using the following steps:
1. Download the Python SDK from its [download page](https://developer.softbankrobotics.com/pepper-2-5/downloads/pepper-naoqi-25-downloads-windows).
2. Go to `C:\Program Files (x86)` and create a new folder with the name `softbank`
3. Unzip the downloaded zipfile, and place the `bin`, `lib` and `share` folders inside this `softbank` folder
4. We will now need to make sure that Python knows where to find this SDK by adding its location to the "PYTHONPATH" environment variable. This can be done as follows:
- Press the Windows key, type "environment" and click on "Edit the system environment variables".
- Below on the right press "Environment Variables..."
- Press the first "New..."
- Enter "PYTHONPATH" as the variable name and enter `C:\Program Files (x86)\softbank\lib`as the variable value.
5. Now NAOqi should have been succesfully installed which we will check by importing the library in an exemplary file. This can be done using the following steps:
- Make a python file in a directory of choice called `naoqi_test.py`. You can do this using your text editor of choice like Notepad (already installed in Windows), Atom or Pycharm (the editor used during the tutorials).
- In this python file add the single line `import naoqi`, now save and close the file.
- Now open the Windows command prompt by pressing the Windows key and typing `cmd`.
- Navigate to the folder where you put your `naoqi_test.py` file.
> Note: If you don't know how to move through your directories [here](https://www.howtogeek.com/659411/how-to-change-directories-in-command-prompt-on-windows-10/) is a quick tutorial. Note that you can see the contents of your current directory with the command `dir`.
- Now you're in the folder of `naoqi_test.py` and you can see the file using the `dir` command execute: `py -2 naoqi_test.py`. If this gives no errors (so it outputs nothing) NAOqi has been installed successfully!
> 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).
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