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

Start docs for 3DPrint build instructions #89

Closed
wants to merge 1 commit into from
Closed
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
Start docs for 3DPrint build instructions
  • Loading branch information
goldfishlaser authored Aug 6, 2024
commit 62ab6f8c32f840a4cc5c51478fb9e02613776024
225 changes: 225 additions & 0 deletions docs/hardware_dev/3d-print.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
.. _3D_Print_Instructions:

Create a 3D-Printed BusKill
=================================

This section will describe from start to finish how to create a 3D printed BusKill.

.. note::
Example Note.

Bill of Materials
----------
Add BOM here.

Print the Parts
----------

Step 1: Get OpenSCAD file and create STL.
^^^^^^^^^^^^^^^^^^^^^^

Example Reference- If you haven't yet, :ref:`assemble the BusKill cable <hardware_assembly>`

Step 2: Prepare STL for Print
^^^^^^^^^^^^^^^^^^^^^^^^^^

Under ``Devices and drives``, right-click on the USB drive and choose ``Format``

.. figure:: /images/buskill_usb_storage_win_click_format.png
:align: center

.. warning::
Make absolutely sure you've selected the correct drive!!

If you select the **wrong drive**, it may result in **irrevocable deletion of all your data!**

If you're not sure, unplug the BusKill cable and plug it back in again. The drive will disappear and reappear. **Make absolutely sure you're choosing the BusKill USB Storage Drive** before proceeding with the format.

In the new window:

#. Set the ``File system`` to ``FAT32``
#. Leave the ``Allocation unit size`` at the default ``4096 bytes``
#. For ``Volume label``, type ``BusKill``
#. Leave the ``Quick Format`` option checked
#. Click ``Start``

.. figure:: /images/buskill_usb_storage_win_click_usbRoot.png
:alt: screenshot shows the extracted archive's contents root with one folder titled "usbRoot"
:align: center
:target: ../_images/buskill_usb_storage_win_click_usbRoot.png

.. note ::
Do not copy the ``usbRoot`` folder to the USB Storage Drive. Copy the *contents* of the ``usbRoot`` folder to the USB Storage Drive.

Click ``Home`` -> ``Select All``

.. figure:: /images/buskill_usb_storage_win_select_all.png
:alt: screenshot shows the process to click Home -> Select All
:align: center
:target: ../_images/buskill_usb_storage_win_select_all.png

Click ``Home`` -> ``Copy to`` -> ``Choose location...``

.. figure:: /images/buskill_usb_storage_win_copy_to.png
:alt: screenshot shows the process to click Home -> Copy to -> Choose location...
:align: center
:target: ../_images/buskill_usb_storage_win_copy_to.png

.. list-table::

* - .. figure:: /images/buskill_usb_storage_win_pass.png
:alt: screenshot shows how to close the command prompt window, with the "X" on the top-right highlighted
:align: center
:target: ../_images/buskill_usb_storage_win_pass.png

- .. figure:: /images/buskill_usb_storage_win_eject.png
:alt: screenshot shows the right-click menu for the "BUSKILL" drive and the "Eject" option highlighted
:align: center
:target: ../_images/buskill_usb_storage_win_eject.png

Create the pogo connection
-----

Step 1: Create the Release pogo connection
^^^^^^^^^^^^^^^^^^^^^^

If you haven't yet, :ref:`assemble the BusKill cable <hardware_assembly>`

Step 2: Create the Breakaway pogo connection
^^^^^^^^^^^^^^^^^^^^^^^^^^

Under ``Devices and drives``, right-click on the USB drive and choose ``Format``

.. figure:: /images/buskill_usb_storage_win_click_format.png
:align: center

.. warning::
Make absolutely sure you've selected the correct drive!!

If you select the **wrong drive**, it may result in **irrevocable deletion of all your data!**

If you're not sure, unplug the BusKill cable and plug it back in again. The drive will disappear and reappear. **Make absolutely sure you're choosing the BusKill USB Storage Drive** before proceeding with the format.

In the new window:

#. Set the ``File system`` to ``FAT32``
#. Leave the ``Allocation unit size`` at the default ``4096 bytes``
#. For ``Volume label``, type ``BusKill``
#. Leave the ``Quick Format`` option checked
#. Click ``Start``

.. figure:: /images/buskill_usb_storage_win_click_usbRoot.png
:alt: screenshot shows the extracted archive's contents root with one folder titled "usbRoot"
:align: center
:target: ../_images/buskill_usb_storage_win_click_usbRoot.png

.. note ::
Do not copy the ``usbRoot`` folder to the USB Storage Drive. Copy the *contents* of the ``usbRoot`` folder to the USB Storage Drive.

Click ``Home`` -> ``Select All``

.. figure:: /images/buskill_usb_storage_win_select_all.png
:alt: screenshot shows the process to click Home -> Select All
:align: center
:target: ../_images/buskill_usb_storage_win_select_all.png

Click ``Home`` -> ``Copy to`` -> ``Choose location...``

.. figure:: /images/buskill_usb_storage_win_copy_to.png
:alt: screenshot shows the process to click Home -> Copy to -> Choose location...
:align: center
:target: ../_images/buskill_usb_storage_win_copy_to.png

.. list-table::

* - .. figure:: /images/buskill_usb_storage_win_pass.png
:alt: screenshot shows how to close the command prompt window, with the "X" on the top-right highlighted
:align: center
:target: ../_images/buskill_usb_storage_win_pass.png

- .. figure:: /images/buskill_usb_storage_win_eject.png
:alt: screenshot shows the right-click menu for the "BUSKILL" drive and the "Eject" option highlighted
:align: center
:target: ../_images/buskill_usb_storage_win_eject.png

Insert pogo connection into case and connect to USB parts.
-----
Step 1: Create Release
^^^^^^^^^^^^^^^^^^^^^^

If you haven't yet, :ref:`assemble the BusKill cable <hardware_assembly>`

Step 2: Create Breakaway
^^^^^^^^^^^^^^^^^^^^^^^^^^

Under ``Devices and drives``, right-click on the USB drive and choose ``Format``

.. figure:: /images/buskill_usb_storage_win_click_format.png
:align: center

.. warning::
Make absolutely sure you've selected the correct drive!!

If you select the **wrong drive**, it may result in **irrevocable deletion of all your data!**

If you're not sure, unplug the BusKill cable and plug it back in again. The drive will disappear and reappear. **Make absolutely sure you're choosing the BusKill USB Storage Drive** before proceeding with the format.

In the new window:

#. Set the ``File system`` to ``FAT32``
#. Leave the ``Allocation unit size`` at the default ``4096 bytes``
#. For ``Volume label``, type ``BusKill``
#. Leave the ``Quick Format`` option checked
#. Click ``Start``

.. figure:: /images/buskill_usb_storage_win_click_usbRoot.png
:alt: screenshot shows the extracted archive's contents root with one folder titled "usbRoot"
:align: center
:target: ../_images/buskill_usb_storage_win_click_usbRoot.png

.. note ::
Do not copy the ``usbRoot`` folder to the USB Storage Drive. Copy the *contents* of the ``usbRoot`` folder to the USB Storage Drive.

Click ``Home`` -> ``Select All``

.. figure:: /images/buskill_usb_storage_win_select_all.png
:alt: screenshot shows the process to click Home -> Select All
:align: center
:target: ../_images/buskill_usb_storage_win_select_all.png

Click ``Home`` -> ``Copy to`` -> ``Choose location...``

.. figure:: /images/buskill_usb_storage_win_copy_to.png
:alt: screenshot shows the process to click Home -> Copy to -> Choose location...
:align: center
:target: ../_images/buskill_usb_storage_win_copy_to.png

.. list-table::

* - .. figure:: /images/buskill_usb_storage_win_pass.png
:alt: screenshot shows how to close the command prompt window, with the "X" on the top-right highlighted
:align: center
:target: ../_images/buskill_usb_storage_win_pass.png

- .. figure:: /images/buskill_usb_storage_win_eject.png
:alt: screenshot shows the right-click menu for the "BUSKILL" drive and the "Eject" option highlighted
:align: center
:target: ../_images/buskill_usb_storage_win_eject.png

Test
-----

Step 1: See whether computer detects your drive
^^^^^^^^^^^^^^^^^^^^^^

If you haven't yet, :ref:`assemble the BusKill cable <hardware_assembly>`

Add glue and screw on the lid
-----

Step 1: See whether computer detects your drive
^^^^^^^^^^^^^^^^^^^^^^

If you haven't yet, :ref:`assemble the BusKill cable <hardware_assembly>`


Loading