Build Manual Template

Hardware Specs

Cost

$

Approximate Work Time

Performance spec 1

Performance spec 2

Hardware Description

Describe your hardware, highlighting the customization rather than the steps involved in the procedure. Explain how it differs from other hardware and the advantages it offers over pre-existing methods. For example, how does this hardware compare to other hardware in terms of cost or ease of use, or how can it be used to develop further designs in a particular area?

Insert picture of completed hardware

Useful Links:

Link to Operation Manual and other related documents

Tools

  • Tool 1

  • Tool 2

  • Tool 3

Bill of Materials

Stuff to buy. The BOM should include everything necessary to make the components in the next section, design files.

Link to spreadsheet - edit sheet then update or copy table here

Name

QTY

Cost per unit - USD

Total cost - USD

Purchasing Link

Item 1

10

0.01

0.1

McMaster

Item 2

1

10

10

Amazon

0

You can use this space for any additional descriptions of the materials used.

Design File Summary

Stuff to make. Complete a separate row for each design file associated with your hardware (including the primary design files). Any empty rows should be deleted.

Link to GitHub repository

File Name w/ link

Description

QTY

Tools Used

Mechanical File 1

Housing for Electronics, connects to XYZ component. 3D printed from ABS.

2

3D printer

Electronic File 1

PCB that controls XYZ sensors and actuators. Controlled by XYZ component

3

PCB fab, pick and place machine

Software File 1

Firmware for XYZ microcontroller.

N/A

Arduino Uno

CAD files:

You are encouraged to use free and open source software packages for creating the files. For CAD files, OpenSCAD, FreeCAD, or Blender are encouraged, but, if these are not available, we accept source files from proprietary CAD packages, such as Autocad or Solidworks, and other drawing packages.

3D printing:

Supplementary files that facilitate digital replication of the devices are encouraged; for example, STL/3MF files for 3D printing components.

Electronics:

PCB layouts and other electronics design files should be uploaded to Github.

Software and firmware:

All software files used in the design and operation of the hardware should be included in the repository. Provide a description of the software and firmware and use extensive comments in the code.

Build Instructions

Provide detailed, step-by-step construction instructions for the submitted hardware:

  • Include all necessary information for reproducing it.

  • Explain and (when possible) characterize design decisions. Include any design alternatives you created.

  • Use visual instructions such as schematics, images and videos.

  • Clearly reference design files and component parts described in the Design file summary and the Bill of materials summary

  • Highlight any potential safety concerns.

  • Tips and tricks to simplify the assembly process

  • Possible errors that might occur during assembly and how to rectify them

3D Print Sub-assembly 1

  1. Step 1

  2. Step 2

  3. Step 3

Solder Sub-assembly 2

  1. Step 1

  2. Step 2

  3. Step 3

Validation and Characterization

Demonstrate the operation of the hardware and characterize its performance for a specific application.

  • Highlight a relevant use case.

  • If possible, characterize performance of the hardware over operational parameters.

  • Create a bulleted list describing the capabilities (and limitations) of the hardware. For example, load and operation time, spin speed, coefficient of variation, accuracy, precision, etc

Safety

Appendix

Last updated