:hide-toc:

*********
big-sammy
*********
*big-sammy* is an open source wired mouse hardware implementation.


State of the project
====================

First prototype under testing, firmware support for openinput_ under development.


.. admonition:: Roadmap

   - Initial design |:+1:|
   - First prototype manufactured and assembled |:+1:|
   - Barebones firmware support |:+1:|
   - Documentation |:hammer:|
   - Hardware improvements |:hammer:|
   - First release

   ========== ================
   |:+1:|     Done!
   |:hammer:| Work in progress
   ========== ================


Specifications
==============

* 8 kHz sampling rate support
* Zero latency switch debounce
* Onboard configuration memory
* 2 main mouse buttons (satellite* configuration for both)
* 2 side buttons (symmetric to allow easy left/right handedness)
* encoder + wheel button (satellite* configuration)
* RGB Led

Hardware
========

.. image:: assets/r0.1-core-render.png
   :width: 50%

* ATSAMS70 MCU (ATSAMS70JxxB-M)
* Optical sensor [PMW3330, PMW3360, PMW3389, Truemove3]
* onboard conectors:
   * JST PH (2mm pitch) for USB
   * JST SH (1mm pitch) for stellite boards
* M2 mounting hardware

+--------------+
| USB   pinout |
+-----+--------+
| pin | func   |
+=====+========+
| 1 	| VCC    |
+-----+--------+
| 2 	| DM     |
+-----+--------+
| 3 	| DP     |
+-----+--------+
| 4 	| GND    |
+-----+--------+
| 5 	| Shield |
+-----+--------+

Peripheral boards are used for the buttons and encoder, available at generic-mouse-boards.


.. toctree::
   :caption: Development
   :hidden:

   Contributing <contributing/index>
   

.. toctree::
   :caption: External Links
   :hidden:

   Source <https://github.com/openinput-fw/big-sammy>
   Firmware <https://openinput.readthedocs.io>
   Issue Tracker <https://github.com/openinput-fw/big-sammy/issues>
   
   
.. _openinput: https://openinput.readthedocs.io