added design constraints documentation

emoshou · Jun 23, 2024 · 98b4dd4 · 98b4dd4
1 parent b788b3c
commit 98b4dd4
Show file tree

Hide file tree

Showing 11 changed files with 205 additions and 13 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -164,5 +164,62 @@ cython_debug/
 # Standard Stuff
 .DS_Store
 
-# FreeCAD/Ondsel Files
+# CAD files not native to project
+*.sldprt
 *.FCBak
+*.dxf
+*.dwg
+*.3dm
+*.igs
+*.iges
+*.stl
+*.obj
+*.fcstd1
+*.x_t
+*.x_b
+*.prt
+*.asm
+*.catpart
+*.catproduct
+*.prt
+*.sldprt
+*.sldasm
+*.iam
+*.ipt
+*.par
+*.psm
+*.cgr
+*.3dxml
+*.jt
+*.cst
+
+*.SLDPRT
+*.FCBAK
+*.DXF
+*.DWG
+*.3DM
+*.IGS
+*.IGES
+*.STL
+*.OBJ
+*.FCSTD1
+*.X_T
+*.X_B
+*.PRT
+*.ASM
+*.CATPART
+*.CATPRODUCT
+*.PRT
+*.SLDPRT
+*.SLDASM
+*.IAM
+*.IPT
+*.PAR
+*.PSM
+*.CGR
+*.3DXML
+*.JT
+*.CST
+*.plasticity
+.tmp
+.TMP
diff --git a/README.md b/README.md
@@ -1,6 +1,4 @@
 # ondroid - The Open Source Humanoid Robot
-## Mission
-Design a full DOF humanoid robot incrementally, halving the cost until the BOM is $1000. 
 
 ## Discord
 Join our Discord at: [https://discord.gg/uaXHsjFq4B](https://discord.gg/uaXHsjFq4B)

diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/analysis/materials/materialSelection/matCompare.ipynb b/docs/analysis/materials/materialSelection/matCompare.ipynb
diff --git a/docs/analysis/materials/materialSelection/matData.csv b/docs/analysis/materials/materialSelection/matData.csv
@@ -0,0 +1,17 @@
+material,yield,cost
+AR500 Steel,187,1.5
+AR400 Steel,140,1.2
+7075-T6 Aluminum,73,5
+2024-T3 Aluminum,50,3.5
+6061-T6 Aluminum,40,2.8
+5052-H32 Aluminum,28,2.5
+4130 Chromoly Steel,63.1,5
+G90 Steel,33,1
+Mild Steel (A36),36,0.6
+Stainless Steel 304,30,3
+Stainless Steel 316,30,4
+Titanium (Grade 5),128,20
+Titanium (Grade 2),50,15
+Brass,14,2.5
+Copper,10,3
+1075 Blue Temper Spring Steel,75,5
diff --git a/docs/design/constraints.md b/docs/design/constraints.md
@@ -0,0 +1,12 @@
+# Design Constraints
+## Materials
+Aluminum and stainless preferred.
+
+Plastics (except for bearings or cowlings) are disqualified until the project can source anisotropic materials analysts (go to [Contribute](../gettingStarted/index.md) if that describes you!)
+
+## General Engineering 
+- Design for sheet metal manufacturing (CNC Laser, Waterjet, press braking, etc.). Machined parts that require CNC are likely to be rejected in PRs (exceptions made for actuator components)
+### Welding
+Welding is not permitted for Aluminum as it more than halves the allowable yield stress of the material.
+
+Welding Steel is permitted, provided it takes place at manufacture and not assembly (in situ).
diff --git a/docs/design/loadsAndDynamics.md b/docs/design/loadsAndDynamics.md
diff --git a/docs/devops/software/index.md b/docs/devops/software/index.md
@@ -1,6 +1,4 @@
 # Software DevOps
-## Code
-Code is stored on GitHub.
 
 ## Language
 Python is the preferred language of the project.
diff --git a/docs/gettingStarted/mission.md b/docs/gettingStarted/mission.md
@@ -1,5 +1,5 @@
 # Mission
-Design a full DOF humanoid robot incrementally, halving the cost until the BOM is $1000. <br><br>
+Design a full DOF humanoid robot for research use incrementally, halving the cost until the BOM is $1000.
 
 # Nice to Haves
 1. Educate the public about Engineering and get people excited about it through Robotics

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,9 +22,9 @@ nav:
         - analysis/arms/arm, L/index.md
         - Arm, L Calculations:
           - Arm Calculations, L, 1: analysis/arms/arm, L/notebook.ipynb
-  - Design:
+  - Design and Engineering:
     - design/index.md
-    - Loads and Dynamics: design/loadsAndDynamics.md
+    - Design Constraints: design/constraints.md
     - Concept Design: design/conceptDesign.md
 
 theme: