About this Guide

This guide is intended to explain the basic use of mouseTrap and how to run it.

mouseTrap Arguments List

NOTE: This information can be found running man moustrap under the OPTIONS section.

Option	Description
-i	Changes the input video device index. E.g 0 for /dev/video0
-e cam -e main-window --enable=cam --enable=main-window	When starting mouseTrap, force the enabling of the supplied options.
-d cam -d main-window --disable=cam --disable=main-window	When starting mouseTrap, force the disabling of the supplied options.
-? -h --help	Show the help message of this release of the mouseTrap program.
-v --version	Return the mouseTrap version number.
-q --quit	Quit mouseTrap.

Running mouseTrap

The way to run mouseTrap is as simple as running the command:

$ mouseTrap [ OPTIONS ]

mouseTrap will load the default settings and will overwrite them if an option flag was used (This wont the configuration file).

What should I see?

When running mouseTrap with the standard settings found in the repository two windows will show up, The main window and the Viewer Frame.

Main Window

The main window is a little frame with two buttons (Preferences and Close). It is hardly recommended to use the main window with the current version because there's now keybinding or mousebinding to make it appear again. In case the main-window is disabled mousetrap can be killed with the command mousetrap -q and re-running it without disabling the main-window will solve the problem. If the main window was disabled using the Preferences GUI then running this commands will enable it in the user settings:

$ cd ~/

$ sed -i -ne 'H;${g;s/showMainGui = False/showMainGui = True/;p}' .mouseTrap/userSettings.py

Viewer Frame

The viewer frame is where the Point Mapper and the captured video will be shown. It can be disabled but I also hardly recommend not to do that because it's function is to work as a reference for the user to know where/how much should the head be moved or the position of the green point in the face.

Mouse Movement Methods

It is possible two chose between 3 mouse movement methods (for now):

The first method is the Joystick method known in mouseTrap as the Hold Method which will interpret the head movement as joystick movements. The second (and default) method is the Screen Method which emulates a real mouse, so the head movements will be interpreted as a real mouse movement. The third and last movement mode is the Drag Drop? Method method which let the users drag the mouse pointer and drop it in a different position, this movements can be performed horizontally or vertically not both at the same time.

NOTE: Each method has a section on this wiki that shows the complete review, use cases and related information. Please click in the desired method link to know more about it

Important Information

Fast movements of the head are ignored by mouseTrap because there is a control function that forbids corrupt images to make mousetrap lose the forehead point position, so the movements of the head should be performed slow.