Welcome to the user guide for the Choreography Management Software: TMO, a tool designed for playing, recording, and editing choreographies seamlessly. This software an intuitive interface to interact with the various modules that make up the system.
TMO comprises several modules, each designed to cater to specific functionalities. The user interface is developed using the Python library customtkinter, a refined variant of the tkinter library with enhanced aesthetic properties.
To ensure robust testing and systematic integration, the development process was divided into four distinct modules:
- Play module:
- Connects to the Thymio robot, enabling users to play different choreographies and sequences effortlessly.
- Record module:
- Allows users to record choreographies using the Mimyo controller, capturing creative sequences with ease.
- Info module:
- Displays essential information about choreographies and sequences, offering insights to enhance user experience.
- Editor module:
- Stores and manages different choreographies and sequences, empowering users to trim, create, and customize choreographies. This module also facilitates the creation of sequences and allows users to add responses to sensor events, providing a comprehensive editing experience.
This user guide is designed to walk you through the functionalities of each module, offering step-by-step instructions and insights to help you make the most of our Choreography Management Software. Whether you're a seasoned user or a newcomer, this guide will assist you in navigating the software effectively.
TMO uses a Thymio robot by Mobsya [https://www.thymio.org/] to display the choreography and a Mimyo controller to record the choreographies. Both these elements are required to play and record choreographies. However the software can be launched without these for editing purposes. They also can be connected once the software has been launched.
Before using TMO, you'll need to install Python.
- Here is a link to the Python downloads page.
- Here is a helpful guide to installing Python on various operating systems.
Later in this guide, you will use the Package Installer for Python (pip), which may require you to add Python to your system PATH.
- To run Tkinter Designer from the source code, follow the instructions below.
To program Thymio, you must first download and install the software, then connect your robot (turn it on, then connect it via cable or wireless dongle). Thymio suite must be openned to allow TMO to recognise the Thymio robots connected to the computer.
-
Download the source files for TMO by downloading it manually or using GIT.
git clone https://github.com/Adrien-Pannatier/Thymio_et_mouvement.git -
Change your working directory to the app folder.
cd ...TMO/app/ -
Install the necessary dependencies by running
pip install -r requirements.txt- In the event that pip doesn't work, also try the following commands:
pip3 install -r requirements.txtpython -m pip install -r requirements.txtpython3 -m pip install -r requirements.txt- If this still doesn't work, ensure that Python is added to the PATH.
This will install all requirements needed for TMO to work corectly.
- In the event that pip doesn't work, also try the following commands:
First you'll need to open Thymio suite and select one of the programming options.
To launch TMO you'll need to open a terminal and enter:
python -m app
That's It! You can now use the TMO software on your computer.
The play mode allows you to play choreographies and sequences. You can select what you want to play on the left and modify the playing options:
- Speed factor: between 0.1 and 9.9, scales the playing speed. (⚠ the Thymio robot has a maximal speed, speed instructions over this speed will be set at the maximal speed)
- Nbr repetition: the number of times the choreography/sequence must repeat
- Loop: check to repeat the choreography indefinitely
- Play/Pause/Stop: Buttons to control the playing choreography/sequence
The record mode allows you to record new choreographies. On the left you can write down the choreography name and the description of the choreography.
- The option "⚙" button allows the modification of the calibration constants by hand.
- The "calib" button allows the calibration of the mouse by using the Mimyo controller
- The record "◉" button allows to record a new choreography. The choreography is approximately 20 seconds long.
The info mode displays useful information about choreographies and sequences. You can select wich choreography/sequence you want informations about in the leften lists.
The editor mode features 4 different submodules. We will here cover what they can do.
This is the manage mode, here you can manage choreographies and sequences. you can do the following:
- Delete button "🗑": delete a choreography/sequence
- Rename button "✎": rename a choreography/sequence
- Trim button "✂": trim a choreography
- Copy button "🗒️": copy a choreography/sequence
This is the create sequence mode, here you can create sequences. You can see the choreographies you can add to the sequence on the left. You can also add a description and a name to the sequence. To create the sequence, you need to click on the button 'create sequence' at the bottom of the screen. The sequence order is the order of the choreographies by number. For example, if you want to create a sequence with the choreographies 1, 2 and 3, you need to enter 1-2-3 in the input dialog.
This mode allow you to create random choreographies by specifying the speed range, the length, the timestep size and decide wether the motors should start with the same speed or not.
This modules allows you to add emotions to the robot. Emotions are reactions to sesor triggering. The two emotions provided with the program are "fear" and "curiosity". "fear" makes the robot flee if it detects something. "curiosity" on the opposite, attracts the robot to the detected object.