PC Mouse Made With Arduino Uno and Joystick

18,435

39

32

Intro: PC Mouse Made With Arduino Uno and Joystick

Hi! Welcome to my first Instructable.

I recently began tinkering with my new Arduino Uno and decided to find an application for a PS2 joystick module. I thought it would be nifty to turn my Arduino into a joystick controlled mouse for my PC.

I must confess: I thought the task would be easy using the "mouse" library I found online, little did I realize that this class only works with Arduino Leonard and Micro (and perhaps a few others), but not the ubiquitous Uno. I was discouraged, but I decided to use the Uno's serial communication as well as my rudimentary Java abilities to "hack" the Uno into a functional mouse for Windows. It surprisingly worked! Here's how:

Step 1: Materials

This project does not require many materials:

1 Arduino Uno

5 male to male wires

5 female to female wires (to connect to joystick module and to add extension length for joystick.

1 Joystick (I used the SainSmart PS2 joystick module and would recommend it)

Step 2: Setting Up the Arduino Uno

The setup of the Uno can be seen in the materials picture, and here's the instructions:

Connect the five female to female wires to the pins of the joystick module. Now, connect five male to male wires into the ends of the female wires and connect them to the Arduino in this way:

1. The Ground on the joystick to Arduino Gnd

2. The +5V on the joystick to Arduino 5V

3. The UPx on the joystick to A0 on the Arduino

4. The UPy on the joystick to A1

5. The SW pin (the digital click switch) to digital pin 7 on the Arduino

Step 3: Upload the Joystick Program to Arduino

Connect the Uno to your PC and upload the joystick code seen here (please note I did not create this code originally):

int pushPin = 7;       	// potentiometer wiper (middle terminal) connected to analog pin 3
int xPin = 0;
int yPin = 1;
int xMove = 0;
int yMove = 0;
			// outside leads to ground and +5V
int valPush = HIGH;     // variable to store the value read
int valX = 0;
int valY = 0;
void setup()
{
	pinMode(pushPin,INPUT);
	Serial.begin(9600);         //  setup serial
	digitalWrite(pushPin,HIGH);
}

void loop()
{
	valX = analogRead(xPin);    // read the x input pin
	valY = analogRead(yPin);    // read the y input pin
	valPush = digitalRead(pushPin); // read the push button input pin
	
	Serial.println(String(valX) + " " + String(valY) + " " + valPush);    //output to Java program
}

Step 4: Setting Up Java Program

Now that the Uno is set up, we need to connect it to my Java program which is capable of taking the Uno's serial output values with the special library RxTx and moving the mouse with the library collection JNA. Both of these libraries are included for download at the end of this step. Please note that the only part of the code I changed from the example RxTx was adding the method that moves the mouse in a way that I calibrated for my joystick. It's a bit crude, but it served my purposes.

I used BlueJ as my IDE, but whichever Java IDE you use, install RxTx and JNA libraries for this project, which I named "Mouse". Once that's done, created a project and include this code:

import java.awt.*;
import java.awt.event.InputEvent; import java.io.BufferedReader; import java.io.InputStreamReader; import java.io.OutputStream; import gnu.io.CommPortIdentifier; import gnu.io.SerialPort; import gnu.io.SerialPortEvent; import gnu.io.SerialPortEventListener; import java.util.Enumeration; public class Mouse implements SerialPortEventListener { SerialPort serialPort; /** The port we're normally going to use. */ private static final String PORT_NAMES[] = { "/dev/tty.usbserial-A9007UX1", // Mac OS X "/dev/ttyACM0", // Raspberry Pi "/dev/ttyUSB0", // Linux "COM4", // Windows**********(I changed) }; /** * A BufferedReader which will be fed by a InputStreamReader * converting the bytes into characters * making the displayed results codepage independent */ private BufferedReader input; /** The output stream to the port */ private OutputStream output; /** Milliseconds to block while waiting for port open */ private static final int TIME_OUT = 2000; /** Default bits per second for COM port. */ private static final int DATA_RATE = 9600; int buttonOld = 1; public void initialize() { // the next line is for Raspberry Pi and // gets us into the while loop and was suggested here was suggested http://www.raspberrypi.org/phpBB3/viewtopic.php?f... //System.setProperty("gnu.io.rxtx.SerialPorts", "/dev/ttyACM0"); I got rid of this CommPortIdentifier portId = null; Enumeration portEnum = CommPortIdentifier.getPortIdentifiers(); //First, Find an instance of serial port as set in PORT_NAMES. while (portEnum.hasMoreElements()) { CommPortIdentifier currPortId = (CommPortIdentifier) portEnum.nextElement(); for (String portName : PORT_NAMES) { if (currPortId.getName().equals(portName)) { portId = currPortId; break; } } } if (portId == null) { System.out.println("Could not find COM port."); return; } try { // open serial port, and use class name for the appName. serialPort = (SerialPort) portId.open(this.getClass().getName(), TIME_OUT); // set port parameters serialPort.setSerialPortParams(DATA_RATE, SerialPort.DATABITS_8, SerialPort.STOPBITS_1, SerialPort.PARITY_NONE); // open the streams input = new BufferedReader(new InputStreamReader(serialPort.getInputStream())); output = serialPort.getOutputStream(); // add event listeners serialPort.addEventListener(this); serialPort.notifyOnDataAvailable(true); } catch (Exception e) { System.err.println(e.toString()); } } /** * This should be called when you stop using the port. * This will prevent port locking on platforms like Linux. */ public synchronized void close() { if (serialPort != null) { serialPort.removeEventListener(); serialPort.close(); } } /** * Handle an event on the serial port. Read the data and print it. In this case, it calls the mouseMove method. */ public synchronized void serialEvent(SerialPortEvent oEvent) { if (oEvent.getEventType() == SerialPortEvent.DATA_AVAILABLE) { try { String inputLine=input.readLine(); mouseMove(inputLine); System.out.println("********************"); //System.out.println(inputLine); } catch (Exception e) { System.err.println(e.toString()); } } // Ignore all the other eventTypes, but you should consider the other ones. } public static void main(String[] args) throws Exception { Mouse main = new Mouse(); main.initialize(); Thread t=new Thread() { public void run() { //the following line will keep this app alive for 1000 seconds, //waiting for events to occur and responding to them (printing incoming messages to console). try {Thread.sleep(1000000);} catch (InterruptedException ie) {} } }; t.start(); System.out.println("Started"); } // My method mouseMove, takes in a string containing the three data points and operates the mouse in turn public void mouseMove(String data) throws AWTException { int index1 = data.indexOf(" ", 0); int index2 = data.indexOf(" ", index1+1); int yCord = Integer.valueOf(data.substring(0, index1)); int xCord = Integer.valueOf(data.substring(index1 + 1 , index2)); int button = Integer.valueOf(data.substring(index2 + 1)); Robot robot = new Robot(); int mouseY = MouseInfo.getPointerInfo().getLocation().y; int mouseX = MouseInfo.getPointerInfo().getLocation().x; if (button == 0) { if (buttonOld == 1) { robot.mousePress(InputEvent.BUTTON1_DOWN_MASK); robot.delay(10); } } else { if (buttonOld == 0) robot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK); } if (Math.abs(xCord - 500) > 5) mouseX = mouseX + (int)((500 - xCord) * 0.02); if (Math.abs(yCord - 500) > 5) mouseY = mouseY - (int)((500 - yCord) * 0.02); robot.mouseMove(mouseX, mouseY); buttonOld = button; System.out.println(xCord + ":" + yCord + ":" + button + ":" + mouseX + ":" + mouseY); return; } }

Step 5: Troubleshooting

Getting the Java program to work may be difficult. I've got some tips if you're stuck:

-Change the "Com4" string in the PORT_NAMES[] to the port your arduino Uno is connected to. (I changed to Com4 from the default Com3 in my Java program)

-Comment out the line relating to Raspberry Pi (if you copied my program, I already did this)

-Click "Rebuild Package" or your IDEs equivalent

-Reset the Java Virtual Machine in your IDE. Maybe even reset the program before using the mouse the first time.

Step 6: Conclusion

I hope this project works for you and that you can improve upon it. Ultimately, the easiest solution is to use an Arduino Leonard or Mini that can function as a system device for mouse inputs, but I found it fun to make the Uno function in a way it was not designed--a mouse--by using my limited Java knowledge.

I learned a lot alone the way and hope to add several features in the future:

-Right Click button. The joystick has one button which I reserved for the left click.

-Real device driver for this project. I'm not sure if this is possible, maybe someone can enlighten me on the subject!

Thanks for reading!

Share

    Recommendations

    • Optics Contest

      Optics Contest
    • Electronics Tips & Tricks Challenge

      Electronics Tips & Tricks Challenge
    • Plastics Contest

      Plastics Contest

    32 Discussions

    0
    None
    Asher Lego Films

    Question 19 days ago

    Hi, it doesn't work in eclipse ide... will you help me?

    here is the console log

    Exception in thread "main" java.lang.NoClassDefFoundError: SerialPortEvent

    at java.lang.Class.getDeclaredMethods0(Native Method)

    at java.lang.Class.privateGetDeclaredMethods(Unknown Source)

    at java.lang.Class.privateGetMethodRecursive(Unknown Source)

    at java.lang.Class.getMethod0(Unknown Source)

    at java.lang.Class.getMethod(Unknown Source)

    at sun.launcher.LauncherHelper.validateMainClass(Unknown Source)

    at sun.launcher.LauncherHelper.checkAndLoadMain(Unknown Source)

    Caused by: java.lang.ClassNotFoundException: SerialPortEvent

    at java.net.URLClassLoader.findClass(Unknown Source)

    at java.lang.ClassLoader.loadClass(Unknown Source)

    at sun.misc.Launcher$AppClassLoader.loadClass(Unknown Source)

    at java.lang.ClassLoader.loadClass(Unknown Source)

    ... 7 more

    I am not very good at java (or using eclipse) so I don;t really know what to do

    jsmouse.png
    0
    None
    yav12

    Question 4 weeks ago

    this isn't working.

    How do I install the libraries on my Mac?

    (High Seirra)

    0
    None
    BeefStew34

    Question 4 months ago

    Im still having a bit of trouble running the program How do you run it in Blue J I am on the final stage and are getting these errors

    java.lang.ClassNotFoundException: gnu.io.RXTXCommDriver thrown while loading gnu.io.RXTXCommDriver

    java.lang.UnsatisfiedLinkError: no rxtxSerial in java.library.path

    at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1867)

    at java.lang.Runtime.loadLibrary0(Runtime.java:870)

    at java.lang.System.loadLibrary(System.java:1122)

    at gnu.io.CommPortIdentifier.<clinit>(CommPortIdentifier.java:126)

    at Mouse.initialize(Mouse.java:41)

    at Mouse.main(Mouse.java:103)

    2 more answers
    0
    None
    SeanY25BeefStew34

    Answer 3 months ago

    I had the same problem, here's what I did to make it work. I am on MacOS.

    I think the reason is because BlueJ is unable to find the two Java library files required for the code to work, "RXTXcomm.jar" and "librxtxSerial.jnilib". You can get the 2 files from (http://rxtx.qbang.org/wiki/index.php/Download). I downloaded binary "rxtx 2.2pre2 (prerelease)" because I was faced with RXTXcom files mismatched, which requires both your Arduino and Java IDE (BlueJ) having the same version (2.2) of RXTX. Now, you have to move the 2 files into your Java directory (which is hidden by default, can be open with Terminal by the following code).

    cd /Library/Java/
    open .

    Move the 2 files into the Extension folder. (Admin password will be required)

    Next, make sure you have directed BlueJ towards 2 libraries, RXTXcom.jar (which is the one you just installed in the Java directory) and the jna-3.2.7-sources.zip (from the tutorial above). You do so by -> BlueJ -> Preferences -> Library -> add files. Now BlueJ should know where to find those correct 2 libraries for the code to work. Restart BlueJ, compile the code, and right click on the "mouse" module -> void main (string[] args) -> "OK". It should work by now. Good luck! (took me 8 hours to figure this all out!)

    Now, i'm off to try to make this work on Processing...

    0
    None
    BeefStew34SeanY25

    Reply 2 months ago

    Thx I haven't Tried yet but It looks like it should work Thx again for your help

    0
    None
    Abdelrahman Ayman

    Question 6 months ago on Step 4

    Hi, i am getting this error in Netbeans, don't know what to do, can any one help?

    run:

    java.lang.UnsatisfiedLinkError: no rxtxSerial in java.library.path thrown while loading gnu.io.RXTXCommDriver

    Exception in thread "main" java.lang.UnsatisfiedLinkError: no rxtxSerial in java.library.path

    at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1867)

    at java.lang.Runtime.loadLibrary0(Runtime.java:870)

    at java.lang.System.loadLibrary(System.java:1122)

    at gnu.io.CommPortIdentifier.(CommPortIdentifier.java:123)

    at mouse.Mouse.initialize(Mouse.java:49)

    at mouse.Mouse.main(Mouse.java:111)

    C:\Users\Abdelrahman Ayman\AppData\Local\NetBeans\Cache\8.2\executor-snippets\run.xml:53: Java returned: 1

    BUILD FAILED (total time: 0 seconds)

    1 more answer
    0
    None
    SeanY25Abdelrahman Ayman

    Answer 3 months ago

    I think my answer to BeefStew above would be applicable in your case too. I believe the problem is in the Java IDE not being able to find the libraries needed for the code to work, due to wrong version of the library file or wrong directories (for where to put the libraries in)

    "I am on MacOS.

    I think the reason is because the Java IDE is unable to find the two Java library files required for the code to work, "RXTXcomm.jar" and "librxtxSerial.jnilib". You can get the 2 files from (http://rxtx.qbang.org/wiki/index.php/Download). I downloaded binary "rxtx 2.2pre2 (prerelease)" because I was faced with RXTXcom files mismatched, which requires both your Arduino and Java IDE (BlueJ) having the same version (2.2) of RXTX. Now, you have to move the 2 files into your Java directory (which is hidden by default, can be open with Terminal by the following code).

    cd /Library/Java/
    open .

    Move the 2 files into the Extension folder. (Admin password will be required)

    Next, make sure you have directed BlueJ towards 2 libraries, RXTXcom.jar (which is the one you just installed in the Java directory) and the jna-3.2.7-sources.zip (from the tutorial above). You do so by -> BlueJ -> Preferences -> Library -> add files. Now BlueJ should know where to find those correct 2 libraries for the code to work. Restart BlueJ, compile the code, and right click on the "mouse" module -> void main (string[] args) -> "OK". It should work by now. Good luck! (took me 8 hours to figure this all out!) "

    0
    None
    BeefStew34JamesG185

    Reply 5 months ago

    That The Same thing happend to Me you What you most likely are doing is trying to import the module strate into the program you need to put all the module into a file call gnu then in that file put another file called io then put your module into there and import that package

    0
    None
    SyntaxianBeefStew34

    Reply 5 months ago

    Good thinking, thanks for the help Beef Stew.

    1
    None
    mgnKiwi

    Question 5 months ago

    When adding the RxTx library, do I take the jar file within the zipped folder or do I have to follow the installation instructions to add the library?

    2 more answers
    0
    None
    mgnKiwimgnKiwi

    Answer 5 months ago

    Hmmmm...the RxTx installation instructions tell me to copy certain parts of the file to the bin and lib subfolders in Java, is there a similar directory path for BlueJ I can use? Also, when I added the zipped RxTx folder it still tells me gnu.io package doesn't exist. Thank you!

    0
    None
    SyntaxianmgnKiwi

    Answer 5 months ago

    If I remember correctly you should add the RxTx library through the BlueJ library section within the IDE. I believe there was an interface where you can "add library" or something like that and navigate to the folder. I think you can leave it zipped for BlueJ, but if it doesn't like that maybe you can unzip it.

    0
    None
    bshieh

    Question 8 months ago

    Is there a c++ version of the program because I don't have java development kit.

    1 more answer
    0
    None
    Syntaxianbshieh

    Answer 5 months ago

    Sorry, I have never learned C++. However, BlueJ is a free IDE for Java, and good for beginners.

    0
    None
    millerr1

    1 year ago

    How do you connect the Java program to the Arduino?

    1 reply
    0
    None
    Battles1

    1 year ago

    How exactly do I connect the Java program to the Arduino program? I have the Arduino code working (confirmed this by opening the Serial Monitor) and have compiled the program using BlueJ (as well as package it in a JAR file). Is their anything I'm missing?

    1 reply
    0
    None
    SyntaxianBattles1

    Reply 7 months ago

    You don't have to explicitly connect them, the java program will be able to read your serial data output from the arduino. You must make sure that your java is accessing the same serial port as the arduino. From above:

    -Change the "Com4" string in the PORT_NAMES[] to the port your arduino
    Uno is connected to. (I changed to Com4 from the default Com3 in my Java
    program.