Difference between revisions of "RoballRFDocumentation"

From IntRoLab
(Logging data)
(Logging data)
Line 58: Line 58:
  
 
= Logging data =  
 
= Logging data =  
# Click on the "Enable Logging" button to add log data in the GUI Table View. [[Image:RoballMainWindowLogging.png | 640px | center]]
+
# Click on the "Enable Logging" button to add log data in the GUI Table View. Every log data coming from Roball (at 10Hz) will be inserted into the table as a single row. [[Image:RoballMainWindowLogging.png | 640px | center]]
  
 
== Saving to a log file ==
 
== Saving to a log file ==

Revision as of 14:16, 15 June 2009

Roball RF Documentation

Included with the kit :

  • Roball (pink shell)
  • 12V Charger
  • USB RF-Interface
  • 1/8" Audio cable (male-male)

Using Roball

Turning on Roball

  1. Turn on Roball with the switch indicated by the blue arrow. You should see a red led blinking when Roball is on.
RoballTurningOn.png

Connecting to Roball with the RF Module

  1. Connect the RF Module to your USB port. With Linux, it is seen as a USB-Serial port and the device should be /dev/ttyUSB0.
    RoballRFModule.jpg
  2. Start the Roball-RF GUI
  3. Select the right serial port and click on the "Connect" button.
    RoballMainWindow.png
  4. Connection state should change to "Connected" and the state of the robot should be updated:
    RoballMainWindowConnected.png
  5. You are now ready for operating Roball.

Recharging the battery

  1. 'Roball must be turned off before recharging. Use the provided 12V charger as shown here :
    RoballChargingKit.jpg
  2. Connect the charger to the power outlet and the charging plug to the right of the power on switch.
    RoballCharging.jpg
  3. Charging time should be around 4 hours. Led indicators on the charger tell the charging state.

Operating the robot

Virtual Joystick

  1. You can enable the virtual joystick by clicking on "Enabled" as shown in the next image.
    VirtualJoystick.png
  2. Moving the handle (click & hold on the black circle) up and down will change Roball's speed.
  3. Moving the handle (click & hold on the black circle) left and right will change Roball's Counder Weight.
  4. You should see the "Joystick" behavior activated when the virtual joystick is enabled.

Activating Behaviors Manually

  1. Click on the "Manual" checkbox to activate control of manual behaviors as shown in the following image :
    RoballManualBehaviors.png
  2. Click on any behavior to toggle its state. Gray color means that the behavior is deactivated. Green color means that the behavior is active.

Behaviors priorities are the following :

  1. roball_behavior_CIRCLE1(duty, pos, sound_id); //MIN priority
  2. roball_behavior_CIRCLE2(duty, pos, sound_id);
  3. roball_behavior_CIRCLE3(duty, pos, sound_id);
  4. roball_behavior_WANDER(duty, pos, sound_id);
  5. roball_behavior_UPRIGHT(duty, pos, sound_id);
  6. roball_behavior_FAST(duty,pos,sound_id);
  7. roball_behavior_SLOW(duty,pos,sound_id);
  8. roball_behavior_AVOID(duty, pos, sound_id);
  9. roball_behavior_STATUS(duty, pos, sound_id);
  10. roball_behavior_PLAY_MUSIC(duty,pos,sound_id);
  11. roball_behavior_FLASH_LIGHTS(duty,pos,sound_id);
  12. roball_behavior_ROTATE_LIGHTS(duty,pos,sound_id);
  13. roball_behavior_REST(duty, pos, sound_id);
  14. roball_behavior_JOYSTICK(duty,pos,sound_id); //MAX priority

Starting Pre-Programmed Mode

Clicking the "Start" button when manual control of behaviors is disabled will start the pre-programmed mode. This mode is used by IntroLab for experiments. Clicking on the "Stop" button will stop the pre-programmed mode. Please contact Tamie Salter for more details.

Logging data

  1. Click on the "Enable Logging" button to add log data in the GUI Table View. Every log data coming from Roball (at 10Hz) will be inserted into the table as a single row.
    RoballMainWindowLogging.png

Saving to a log file

  1. Click on the "Save Log" button to save the content of the table into a text file.
    RoballLogSave.png

Clearing the Displayed Log

  1. Click on the "Clear Log" button to clear the log. Clearing the table can require few seconds if a lot of entries are present.

Changing the Audio Setup

  1. Connect the audio cable from your computer to Roball's audio jack. You need a cable with 1/8" male audio jack at both ends.(the one that connects to the phone jack of your computer)
    RoballAudioSetupConnectCable.jpg
  2. Turn on the robot if not already done.
  3. Start the Roball-RF GUI and connect to the robot.
  4. In the application menu, click on Config->Audio Setup You should see the following dialog:
    RoballAudioSetupEmpty.png
  5. Create a text file containing the list of audio files you want to use with Roball. Here is an example of configuration File:AudioSetup.txt. Use absolute path names for files. Audio files must be of type WAV, MP3 or AAC depending on your installation.Roball can record up to 8 audio files, lasting a maximum of 30 seconds each.
  6. Click on the "Load List" button and select the text file containing the file list. The dialog should now look like this :
    RoballAudioSetup.png
  7. Make sure your volume is high enough.
  8. Click on the "Record" button. This will play audio files to the robot and send commands to Roball to record them in its internal audio memory. The red led on Roball should stop blinking during this step.
  9. Verify if the record worked by selecting any file on the list and clicking on the "Play" button. The audio should come out of Roball's speaker. If the audio is not loud enough, try raising the volume and go repeat the previous step.
Note : Audio configuration will be kept in Roball's memory, even after powering Roball down.