Skip to content

Commit

Permalink
Small edits to developer guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jonnew committed May 11, 2023
1 parent 52c8c3a commit 8403b1f
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions source/coax-commutator/developer-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,26 @@ Developer Guide
Design Files
*************************************************
Open Ephys commutators are open-source. Mechanical, electrical, and firmware designs are available in the
`onix-commutator git repo <https://github.com/open-ephys/onix-commutator>`_. Below explains how to manufacture
your own Open Ephys Commutator using these files. This is helpful if you intend to create a custom commutator or adapt
an off-shelf-commutator Open Ephys Commutator to your system by reprogramming it to accept
other inputs instead of or in addition to the JSON remote procedure calls (RPCs) that the commutator is already designed
to accept. Finally, there are some design considerations at the bottom of the page in case you are considering designing
`onix-commutator git repo <https://github.com/open-ephys/onix-commutator>`_. Here we explain how to build
your own commutator using these files. You might want to do this to make a custom variant of the design (e.g. with a different RF rotary joint) or adapt
an Open Ephys Commutator to your system by reprogramming it to accept
other inputs in addition to the :ref:`JSON commands <remote_control>` that the commutator already
accepts. Finally, there are some design considerations at the bottom of the page in case you are considering designing
your own commutator.

.. _bom:
.. important:: The RF rotary joint and slip rings used in Open Ephys commutator are specified for millions of cycles without failure. If you want to replace these components, make sure you get them from a reputable manufacturer to maintain their reliability. We have found that `Spinner <https://www.spinner-group.com/en/products/rf-rotary-joints>`__ is a very good option for gettin high quality rotary joints.

Bill of Materials (BoM)
*************************************************
.. _bom:

Open Ephys is not affiliated with any of the linked vendors in the following
`BoM <https://docs.google.com/spreadsheets/d/1M2R0Q2-OuRHzctt05BxtA3hxNcCHtRZHORzCKElmG1Q/edit?usp=sharing>`__.

Ordering and Manufacturing Parts
*************************************************

The following sections describe how to fabricate the mechanical parts that comprise the Coaxial Commutator (gears and case).

Bill of Materials (BoM)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The bill of materials is located `here <https://docs.google.com/spreadsheets/d/1M2R0Q2-OuRHzctt05BxtA3hxNcCHtRZHORzCKElmG1Q/edit?usp=sharing>`__.

Mechanical
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -43,27 +43,24 @@ print this for you. They cost more and sometimes have a minimum price to purchas
`3DHubs <https://www.hubs.com/>`_ has a $90 minimum at the time of writing this) which is not great if you are trying to
print a low quantity of pieces. Other popular ones include `Formlabs <https://formlabs.com/>`_,
`Shapeways <https://www.shapeways.com/>`_, `Xometry <https://www.xometry.com/>`_,
`Sculpteo <https://www.sculpteo.com/en/>`_ etc. Open Ephys has no affiliation with any of these companies by the way. To
`Sculpteo <https://www.sculpteo.com/en/>`_ etc. Open Ephys has no affiliation with any of these companies. To
manufacture with these companies, it is often required to upload an
`STL <https://github.com/open-ephys/onix-commutator/tree/master/mechanical/single_channel/stl>`_ or STEP file, but they
are starting now to accommodate other file types as well such as sldprt files.

.. Note:: In creating your own custom commutator, it is possible to change the gear ratio. You are only required to make
one change in the `firmware <https://github.com/open-ephys/onix-commutator/tree/master/firmware/commutator>`_.
which it to modify the GEAR_RATIO macro on line 22.
which it to modify the GEAR_RATIO macro.

Electrical
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Printed circuit boards (PCBs) are boards that electrically connect a set of electronic components to create functional circuits.
Those parts are soldered to the PCB to create mechanically stable and reliable operation. The commutator front panel
is an example of a PCB. Fortunately, PCBs are pretty cheap to fabricate nowadays. For instance,
is a PCB. Fortunately, PCBs are pretty cheap to fabricate nowadays. For instance,
you can get a 5-pack of PCBs from `JLCPCB <https://jlcpcb.com>`_ for less than $5. To fabricate a PCB, a manufacturer usually
requires that you upload `Gerber files <https://github.com/open-ephys/onix-commutator/tree/master/control-board/gerber>`_. For the commutator front panel,
these Gerber files can be found in the public Github repository or produced using ECAD (electrical computer-assisted drawing) files in ECAD software. E
ECAD software permits the design of a PCB. Open Ephys uses `KiCad <https://www.kicad.org/>`_ for this purpose.
There are other ECAD softwares available, but KiCad is strongly encouraged as it is open-source, extensible, undergoing constant
improvement, and most importantly easy-to-use. Teaching such software is beyond the scope of this guide, but you can find
these Gerber files can be found in the public Github repository or produced using ECAD (electrical computer-assisted drawing) files in ECAD software. ECAD software permits the design of a PCB. Open Ephys uses `KiCad <https://www.kicad.org/>`_ for this purpose. Teaching such software is beyond the scope of this guide, but you can find
`tutorials on KiCad's website <https://www.kicad.org/help/learning-resources/>`_ and elsewhere on the web.

For ordering the electronics parts that are mounted onto the PCB, `Digikey <https://www.digikey.com>`_, `Mouser <https://www.mouser.com>`_, and `Arrow <https://www.arrow.com>`_ are go-to vendors.
Expand Down Expand Up @@ -116,17 +113,20 @@ It also allows the user to program the Teensy in a convenient way if that is des

This is the `firmware with which the commutator ships <https://github.com/open-ephys/onix-commutator/tree/master/firmware/commutator>`_.

Mechanical Assembly
Assembly
**************************************************************

#. Gather the materials listed in the `bom`_ for the coaxial commutator
#. Visually inspect to confirm that all the components on the PCB are properly soldered
#. Gather the materials listed in the BOM for the commutator
#. Visually inspect to confirm that all the components on the PCB are properly soldered.
#. If you have access to a multi-meter, check for shorts between power supply rails and ground.
#. Plug a USB cable into the PCB and ensure that the LED and capacitive sense buttons seems to work. Unplug the USB cable.
#. Insert the SMA rotary joint and fasten it with three M2.5 screws 10mm long to the case
#. Insert the stepper motor and fasten it to the case with four M2.5 screws 6mm long
#. Connect the stepper motor to the 4-pin connector on the back of the commutator front panel
#. Fasten the commutator PCB to the case with four M2.5 screws 6mm long
#. Insert the gears onto the rotary joint rotor and motor rotor. Glue them in place such that the gears are properly
meshed. Clamp to ensure the gears do not mis-align during the curing process.
#. Plug the USB cable into the commutator and try a few manual turns. If the commutator is turning the wrong way, remove the PCB and flip the motor connections.

.. toctree::
:hidden:
Expand Down

0 comments on commit 8403b1f

Please sign in to comment.