Optical Mouse Odometer for (Arduino) Robot

65,117

248

46

Introduction: Optical Mouse Odometer for (Arduino) Robot

Accurately determining the progress of a wheeled robot can be pretty tricky (and expensive!). Dead reckoning assumes that our motors are perfectly matched, our wheels don't slip and the surface we are running on is perfectly flat: most of these conditions are unattainable and are never guaranteed. Rotary Encoders on the wheels or motors are more accurate, they certainly remove the need for matched motors and can deal with incline changes, however slippage is still an issue. Ultrasonic or Laser range sensors circumvent all of the mechanical issues that plague dead reckoning and encoders but require stationary fixed points of reference, are subject to interference (objects coming between the robot and the reference point) and have issues with regard to range, accuracy and resolution (the more you want, the more it costs!).

Ideally, we want a sensor that can accurately measure positional changes in two dimensions, has a simple interface, has low power requirements, is easily obtainable and cheap into the bargain. The solution: that old optical mouse you have lying around! Computer mice are designed to do just what we want: very accurately track the two dimensional movement of an object in near to real time. They actually have a resolution 1000dpi which means we are able to measure a movement of ~0.03mm in any direction!

We do have to choose our mouse a little carefully however. We need one that either has a PS/2 connector (6 pin mini-DIN) or a USB mouse that is PS/2 compatible (should be stated on the bottom of the mouse somewhere, see picture). This is because the PS/2 protocol is really easy to implement (particularly for microcontrollers) whereas USB is somewhat more difficult!

I happened to have an old Microsoft USB1.1/PS/2 compatible mouse hanging around that I wasn't using, so I decided to sacrifice it to my robotical pursuits in the manner described herein.

Step 1: Tear Down

First things first, we need to open the case and liberate the electronic goodies within. I chose to do this because the mouse is far too big and bulky for my robot. If you don't want to this you just need a USB Type A or PS/2 socket that can be wired to the processor (Arduino in this case) into which the mouse can be plugged without modification, just skip this bit.

So, the process to deconstruct my mouse was as follows (also see pictures):

  1. Remove rubber adhesive feed covering screws (at the rear) and clips (at the front
  2. Remove the two screws at the back and then use a small flat bladed screwdriver to push back the clips holding the top and bottom parts of the case together at the front. (This may take a bit of fiddling, I actually inadvertently broke one of the clips in the process.)
  3. Once the case is open, remove the scroll wheel and then any screws hold the circuit board to the case. There may also be a few small plastic clips that retain the circuit board. The small screwdriver used before and some wiggling should free the circuit board(s) from the case.
  4. There should be a clear plastic piece under the circuit board (the lens) which will also need, so retain this and the circuit boards, discard (or file!) the rest.

If you plug the mouse into a computer or laptop, ensuring the lens is correctly in place on the bottom, the mouse should work normally when you move it around.

Step 2: Initial Circuit Modifications

Now we've got our hands on the board we need to connect it to our microcontroller. To do this we can either use the existing cable (USB) in my case and wire an appropriate socket or we can replace this wire with some of our own. We also need to determine the function of each of our new wires. This is done simply by using a multimeters continuity setting and working out which connection on the board is connected to which pin on the USB (or PS/2) connector. The original wiring can be seen in the first image above and functions are, left to right, as follows:

  1. Red: Vcc (USB pin 1)
  2. White: Data (USB pin 2)
  3. Green: Clock (USB pin 3)
  4. Black: Gnd (USB pin 4)
  5. Black: Shield

I chose to desolder the existing cable form the board and replace it with some wires with Arduino friendly Dupont connectors. I also chose not to connect a wire to the shield connection as its not strictly necessary. We then connect the mouse to our microcontroller of choice, an Arduino Leonardo Nano clone in this case, as follows:

  • Mouse Vcc to Arduino Vcc
  • Mouse Gnd to Arduino Gnd
  • Mouse Clock to to Arduino Pin 6
  • Mouse Data to Arduino Pin 5

Step 3: Software

Now we've connected everything up we need some software for the microcontroller. Firstly we need some code that implements the PS/2 protocol. Helpfully there is an Arduino library available for this, however I found it to be a little outdated and I wanted to add some new functionality so I reimplemented and extended it a bit and it can be found here: https://github.com/jazzycamel/PS2Mouse.

The library contains a simple example sketch (PS2Mouse.ino) which requests the mouses status and position delta (the change in X and Y directions since we last asked) and prints it to the serial port once every second. If we program the Arduino, and everything has gone well, the mouse will light up and your favourite terminal application (or the Arduino IDE's serial monitor) will show a stream of status, X and Y deltas once a second. The X and Y data has a (theoretical) range of -255 to +255 and each step (theoretically) represents 0.25mm which means we can (theoretically) measure up to 63.75mm change in any direction (for X positive values are to the right, for Y positive values are forwards).

Note: the above numbers are theoretical for the following a reasons:

  1. Whilst a mouse can report the range -255 to 255, so far all the mice I've used only return -128 to 127.
  2. Whilst each step supposedly represents 0.25mm, I've found this to be very dependent on the mouse and the surface its on. Generally the step size seems a lot smaller.

Step 4: Further Modifications and Finishing Up

Once I'd got everything up and running I decided to remove the extra circuit board which has the electronics for the mouses buttons and scroll wheel as I didn't need these features and they were just taking up space. I desoldered both of the ribbon cables, plugged everything in and... nothing. The mouse wouldn't light up and I got nothing from the serial port. A little investigation with the multimeter told me that three of the pins (1,3, and 6) on the rightmost connector (looking from the top) were usually connected together when the button board was connected, so I just shorted them together with some scrap wire as shown in the picture. I then plugged everything back in and Hey Presto! We were back in business!

The final touch was to superglue the clear plastic lens in place on the circuit board to retain it and so I wouldn't lose it.

The next step will be to mount this on my robot and put it to use. I actually intend to cannibalise another mouse in the same way and fit both to the robot so as to be able to accurately determine orientation as well as progress (as described here).

I hope people find this little tutorial useful, please feel free to ask any questions. Thank you.

3 People Made This Project!

Recommendations

  • Tiny Home Contest

    Tiny Home Contest
  • Metalworking Contest

    Metalworking Contest
  • Fix It! Contest

    Fix It! Contest

46 Discussions

Hi,


First of all I gotta say I am very new to microcontroller arduino programming, I am only familiar with CAD modeling and various simulation. Please teach me and correct me if I am wrong.

Currently, I am using ps2 library for my optical mouse (with MX8733) to retrive x- and y-coordinates. The sample programming is shown below:


#include <ps2.h>

PS2 mouse(6, 5);

void mouse_init()
{
mouse.write(0xff); // reset
mouse.read(); // ack byte
mouse.read(); // blank */
mouse.read(); // blank */
mouse.write(0xf0); // remote mode
mouse.read(); // ack
delayMicroseconds(100);
}

void setup()
{
Serial.begin(9600);
mouse_init();
}

void loop()
{
char mstat;
char mx;
char my;

mouse.write(0xeb); // give me data!
mouse.read(); // ignore ack
mstat = mouse.read();
mx = mouse.read();
my = mouse.read();

/* send the data back up */
Serial.print(mstat, BIN);
Serial.print("\tX=");
Serial.print(mx, DEC);
Serial.print("\tY=");
Serial.print(my, DEC);
Serial.println();
// delay(20); /* twiddle */
}

HOWEVER, it stucks at 'mouse.write(0xff); //reset' and nothing is shown at the serial monitor, or some time (rarely) it shows status=1000 x=0 y=0. I feel like MX8733 is using different protocol, no? Anyway, I can't find any detailed datasheet regarding this sensor, only found this http://www.lizhiic.com/admin/Product20/MX8733_SPEC_V1_0.pdf. Ive also found that ADNS
-2620 is a more common mouse sensor after some time of googling.

So my question is, is ps2 library applicable to all types of optical navigation sensor including this MX8733? If not, any idea to still use this sensor? *because I have bought 2 of them and I don't want to waste my money by leaving them aside doing nothing.

Sincerely, all experts and professionals out there, please help

Hi jazzycamel, good job! Can I get INSTANT value of the sensor's VELOCITY? Sorry, I could miss this point in your description. And how fast (msec) can it be calculated by Arduino?

hey
I tried the same but there is no response in Arduino nut sensor is responding

plz suggest some solution

0
None
Ola667

6 months ago

Thanks for this instruction. I have a question , I can't get negative numbers instead like 65000 is printed. Any tips?

I have a question
Why when we stop moving mouse...the serial monitors show x=0 and y=0, it suppose have reading right ?

1 reply

it is completely normal because you have no movement

AWESOME

Thank you for writing this. I am having the issue with being hung on setup. The only theory as to why that I can come up with is that my old (IDK how old) logitech usb mouse does not support USB. The only evidence I have to support this is that there is no mention of PS/2 on the bottom.

I believe that the pins are hooked up correctly because when I connect the green & white one way the mouse LED lights but when I swap those wires the mouse does not light up. Therefore I think I can rule that out. In both cases the serial monitor sits on setup...

Any further troubleshooting recommendations would be appreciated.

Thanks

Hi - I followed your (good) tutorial but the serial output makes no sense -reading x=0, y=0 and then responding only occasionally to some jerky motion, but not to others. Could be that I just have crappy mouse ? or something else ?

in particular , what variable is 'stat' reporting?

isnt x or y reporting the counts (delta) since the last time through loop ?

If when I get this to work - is the -127 to +127 meant to be 63.7mm range ?

Please see sample serial output below - Thanks for any help:

1000x=0y=0

1000x=0y=0

1000x=0y=0

1000x=0y=0

1000x=0y=0

1000x=0y=0

1000x=0y=0

1000x=0y=0

111000x=-127y=-127

11000x=-127y=103

11000x=-127y=73

11000x=-127y=0

11000x=-30y=0

1000x=0y=0

1000x=0y=0

1000x=0y=0

1 reply

Do you know
Why when we stop moving mouse...the serial monitors show x=0 and y=0, it suppose have reading right ?

0
None
dhanu2

1 year ago

Hi , Thanks for nice Tutorial. I used PS2 mouse as you used. but in the serial terminal it gave x = -1 and y = -1 and this value is not change when i move the mouse.

Hello,

Thank you so much for the awesome tutorial! For some reason the serial port just says "setup" and then doesn't say anything after that. What could be causing this?

3 replies

The step after "setup" is the initialisation of the mouse, so if its hanging there i can only imagine that either the mouse is not connected correctly (in which case, check your connections) or not functioning. Sorry i cant be more help.

Hey. I incurred the same error. Any clue if there is something besides the connection error?

Hello, according to PS2 wiki interface the range should be from -127 to 127.
I know it's due to char being 8-bit, however changing like all posible values from char to int doesn't work for me either.
Any solutions, how to increases range to -255,255?

4 replies

You can use Arduino's map() function:

int result=map(ps2value, -127, 127, -255, 255);

ain't sure if it's legit solution.

changing data to 9bit would result in increasing measurement up to 6,4mm in each direction,
mapping still gives me with 3,2mm

Sorry, I misunderstood you original question.

I've updated the library generally and changed it to use 'int' for the x and y variables. I've put the library on github (https://github.com/jazzycamel/PS2Mouse) to make it easier to distribute updates. Please be advised that I don't currently have the hardware setup to test it, so all bug fixes or problems gratefully received.

Also, I changed some of the method names to be more 'Arduino-y', so check the example (PS2Mouse.ino) to see whats changed.