Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add 3d-print docs #90

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 145 additions & 0 deletions docs/hardware_dev/3d-print.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
Build a 3D-Printed BusKill Instructions
=================================

BusKill is a Dead Man Switch triggered when a magnetic breakaway is tripped, severing a USB connection. While some magnetic breakaways can be found in local stores or purchased on this site, some may prefer to create their own. These instructions guide you through an open hardware design using 3D printed parts designed in OpenSCAD and easily sourceable hardware. Should anyone need to adjust the OpenSCAD files for variations of components, the code is parameterized allowing for easy customization.

The assembly of the BusKill cord is as follows:
(1) attach the caribiner to the usb
(2) insert the USB hard drive into the female usb port in the assembled “breakaway”
(3) connect the magnets of the “breakaway” to the “release”
(4) insert the male usb from the “release” into the female port of the extension cable
(5) insert the male end of the usb cable into the computers usb-a port.

Bill of Materials
----------

To assemble a BusKill Dead Man Switch 3D printed cord you will need:
* a usb-a extension cord,
* a usb hard drive capable of being attached to a caribiner,
* a caribiner,
* the plastic pieces in this file,
* a usb female port,
* a usb male,
* 4 magnets,
* 4 pogo pins,
* 4 pogo receptors,
* wire,
* 8 screws,
* and BusKill software.

Tools
----------
* Soldering equipment
* Wire cutter
* Helping hands or sometimes art putty

Parts Diagram
----------

.. figure:: /image.png
:align: center

Assemble the Breakaway Face
^^^^^^^^^^^^^^^^^^^^^^

Body <hardware_assembly>`


.. figure:: /image.png
:align: center


#. Numbered List 1
#. Numbered List 2
#. Numbered List 3

.. note::
Make sure the ``Volume label`` is ``BusKill`` with an upper-case ``B`` and ``K`` -- not ``Buskill`` nor ``buskill``.


.. warning::
Do *not* proceed if the hash doesn't match.

Assemble the Release Face
^^^^^^^^^^^^^^^^^^^^^^

Body <hardware_assembly>`


.. figure:: /image.png
:align: center


#. Numbered List 1
#. Numbered List 2
#. Numbered List 3

.. note::
Make sure the ``Volume label`` is ``BusKill`` with an upper-case ``B`` and ``K`` -- not ``Buskill`` nor ``buskill``.


.. warning::
Do *not* proceed if the hash doesn't match.

Assemble the Breakaway
^^^^^^^^^^^^^^^^^^^^^^

Body <hardware_assembly>`


.. figure:: /image.png
:align: center


#. Numbered List 1
#. Numbered List 2
#. Numbered List 3

.. note::
Make sure the ``Volume label`` is ``BusKill`` with an upper-case ``B`` and ``K`` -- not ``Buskill`` nor ``buskill``.


.. warning::
Do *not* proceed if the hash doesn't match.

Assemble the Release
^^^^^^^^^^^^^^^^^^^^^^

Body <hardware_assembly>`


.. figure:: /image.png
:align: center


#. Numbered List 1
#. Numbered List 2
#. Numbered List 3

.. note::
Make sure the ``Volume label`` is ``BusKill`` with an upper-case ``B`` and ``K`` -- not ``Buskill`` nor ``buskill``.


.. warning::
Do *not* proceed if the hash doesn't match.

Test
^^^^^^^^^^^^^^^^^^^^^^

Body <hardware_assembly>`


.. figure:: /image.png
:align: center


#. Numbered List 1
#. Numbered List 2
#. Numbered List 3

.. note::
Make sure the ``Volume label`` is ``BusKill`` with an upper-case ``B`` and ``K`` -- not ``Buskill`` nor ``buskill``.


.. warning::
Do *not* proceed if the hash doesn't match.
3 changes: 2 additions & 1 deletion docs/hardware_dev/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ This section will describe how to build the BusKill hardware cable.
For information on how to setup and use the BusKill cable before using the BusKill app, see :ref:`hardware_usr`

.. toctree::
:maxdepth: 3
:maxdepth: 4

bom
assembly
storage
3d-print
Loading