Project Log 10: Awesome, a 3D mouse!

A project log for OS3M Mouse

"Awesome" Mouse - the open source 3D mouse... mouse

coltonbaldridgecolton.baldridge 11/17/2023 at 06:392 Comments

Some of you might be wondering, if I had MVP 5 months ago... what happened to the OS3M mouse? And I'll tell you - my life got busy! Work on the project stalled for a few months following the last update. I reached a point where I knew a hardware revision was the right path, yet wasn't ready to take the plunge and actually do it with everything else I had going on. But, now that pretty much all daylight is gone here in Seattle, I don't feel bad about sitting inside after work! So, over the past month or so, I crafted the next revision of the OS3M mouse. It wasn't a major upgrade, but a necessary one nonetheless. I had the following list of improvements I knew I wanted to make after building and using revision 0 (the one in the MVP video):

All things considered, revision 0 was a very good prototype that unlocked a lot of testing, but it wasn't good enough in my mind to be released to the public. That's where revision 1.0 comes in. It implements fixes to all of the above issues and (spoiler alert) is actually a viable release candidate! But first, I want to explain the needs behind a couple of the improvements I made.

The 40MHz oscillator is probably the biggest change from the last revision, as it is the only major hardware addition. The reason for the oscillator comes down to noise. The LDC chips used to actually do the sensing rely on a reference AC signal and compare it with the resonant frequency of the coil circuits to get their output data. This means that any deviation in the reference signal directly couples into the output data as noise. Normally, this reference signal is generated by an RC oscillator internal to the LDC ICs, but TI also allows you to pipe in an external up-to 40MHz signal, which is what I have chosen to do. 

The second major change is the addition of an expansion header. It breaks out GND, +3.3V, I2C_SDA, and I2C_SCL onto a right angle pin header. This should allow anyone to add something like the TI TCA9534 I2C I/O expander to the OS3M mouse, which could unlock even more functionality. Other ideas I've had are I2C LED controllers, I2C analog inputs (for potentiometers or sliders), or even I2C motor controllers. The sky is the limit.

The design of revision 1.0 was actually a bit more involved than I initially expected. I did a full rip-up of all routing, and added in 2 more layers, making it a 4 layer board. Here you can see the revision 0 and 1 layouts side-by-side:

You can see the clear addition of the expansion header in the bottom right, addition of the 40MHz crystal in the bottom left, and the movement of the 3.3V LDO to the top middle (where it probably should've been from the start). You can also see the orange ground plane and green power planes in the middle layers. I was slightly worried about adding the ground planes as close to the coils as I did (violates TI's recommendations), but this would prove to not be an issue. I sent the boards to good ol' JLCPCB and got them made with a stencil to boot.

I squeegeed and soldered one up to use for development:

And away I went.

First development activities consisted of upgrading the project files to be compatible with the new, larger flash MCU. A task that actually wasn't as hard as I was expecting it to be. STM32CubeMX required a little finagling, but not too bad.

I then set off on enabling the 40MHz oscillator, since it was only a single bit flag to turn on. And let me tell you... it really does make a huge difference: 



You might be asking - "ok, you decreased the noise, but why does that matter?" 

The answer lies within one of the OS3M mouse's key "flaws" - the fact that it's almost entirely 3d printed, including the flexure. When a user moves the mouse and lets go, due to a small amount of plastic deformation, the mouse doesn't return exactly to center. In order to fix this, I need to rely on software to determine when to "re-home" the mouse to its new center and prevent drift. And in order to know when to "re-home", I need to know when the user is using the mouse or not. The easiest way to do that is to look at all the channels and see if they all fall within what I consider to be the "deadband". Previously, when I took this approach, the noise from the RC oscillator made it so that the range of noise received was outside of the deadband and thus it was impossible to distinguish between the user using the mouse and the user not using the mouse, just reading the noise. Now, it is night and day when the user is touching the mouse and not, even the smallest touches register. Here you can see the homing in action:

And with that, I am proud to say, the OS3M mouse works and is ready for release! Check out this cool video I made explaining the project:

Obviously the project is far from done. The firmware is not great, doesn't support interrupts (though the hardware is there), is still using STM's HID mouse example as the backend, and is not very easy to expand on for any expansion functionality you want to add. The software also is only a command line application which only supports SolidWorks, whereas I have a dream of a GUI with configurable gains, many programs supported, and expansion button configuration. The hardware is also still not perfect, as I haven't updated the base to support the extra expansion header either. But, I felt the need to update everyone so they know the project isn't dead, and is in fact alive and well! 

Thanks for reading!


kelvinA wrote 11/21/2023 at 09:59 point

It seems to be more than sensitive enough as is, but was there a reason for sticking with 2-layer coils when moving to a 4-layer board?

  Are you sure? yes | no

colton.baldridge wrote 11/21/2023 at 16:48 point

Great question, a couple reasons - one being that 2 layer coils work, so I didn’t feel the need to change it, and secondly, the program I wrote to generate the coils (since kicad doesn’t natively support it) only works on 2 layers. I did see someone recently forked my repo though and added support for 4 layers so I might consider using that in the future!

  Are you sure? yes | no