Add documentation

introlab · Oct 15, 2021 · 849808e · 849808e
1 parent 0e74f9e
commit 849808e
Show file tree

Hide file tree

Showing 17 changed files with 107 additions and 2 deletions.
diff --git a/CAD/3d printed parts/.gitkeep b/CAD/3d printed parts/.gitkeep
diff --git a/CAD/BOM.md b/CAD/BOM.md
@@ -0,0 +1,16 @@
+# Bill of Materials
+
+## Digi-Key
+| Part                    | Link              | Quantity |
+| ----------------------- | ----------------- | -------- |
+|                         |                   |          |
+
+## McMaster-Carr
+
+## Robotis
+
+## Amazon
+
+## Aliexpress
+
+## Other
diff --git a/CAD/DXF/.gitkeep b/CAD/DXF/.gitkeep
diff --git a/CAD/README.md b/CAD/README.md
@@ -0,0 +1,52 @@
+# CAD
+This folder contains all mechanical-related files.
+
+## Bill of Materials
+ - [BOM](BOM.md)
+
+## Folder Structure
+SolidWorks files: 
+ - [3d printed parts](3d%20printed%20parts) contains the SolidWorks files for the 3D printed parts.
+ - [assemblies](assemblies) contains the SolidWorks files for the assemblies. The robot assembly file is [robot.SLDASM](assemblies/robot.SLDASM).
+ - [electronics](electronics) contains the SolidWorks files for all electronics parts.
+ - [gazebo_meshes](gazebo_meshes) contains the CAD files for the simulation.
+ - [hardware](hardware) contains the SolidWorks files for screws, nuts, spacers and rods.
+ - [laser](laser) contains the SolidWorks files for the laser cutted parts.
+
+Manufacture files:
+ - [DXF](DXF) 
+ - [STL](STL)
+
+## 3D Printed Parts
+The print parameters and the quantity are shown in the following table.
+
+| File                                                           | Wall Thickness | Infill Percentage | Quantity |
+| -------------------------------------------------------------- | -------------- | ----------------- | -------- |
+| [base gear](STL/base%20gear.STL)                               | 2 mm           | 25 %              |          |
+| [base](STL/base.STL)                                           | 2 mm           | 25 %              |          |
+| [base_audio_1](STL/base_audio_1.STL)                           | 2 mm           | 25 %              |          |
+| [base_audio_2](STL/base_audio_2.STL)                           | 2 mm           | 25 %              |          |
+| [battery holder](STL/battery%20holder.STL)                     | 2 mm           | 25 %              |          |
+| [gear servo support](STL/gear%20servo%20support.STL)           | 2 mm           | 25 %              |          |
+| [head](STL/head.STL)                                           | 2 mm           | 25 %              |          |
+| [head_cable_protector](STL/head_cable_protector.STL)           | 2 mm           | 25 %              |          |
+| [limit switch support](STL/limit%20switch%20support.STL)       | 2 mm           | 25 %              |          |
+| [OpenCR support 1](STL/OpenCR%20support%201.STL)               | 2 mm           | 25 %              |          |
+| [OpenCR support 1](STL/OpenCR%20support%202.STL)               | 2 mm           | 25 %              |          |
+| [stewart bottom](STL/stewart%20bottom.STL)                     | 2 mm           | 25 %              |          |
+| [stewart horn (left)](STL/stewart%20horn%20(left).STL)         | 2 mm           | 25 %              |          |
+| [stewart horn (right)](STL/stewart%20horn%20(right).STL)       | 2 mm           | 25 %              |          |
+| [stewart support](STL/stewart%20support.STL)                   | 2 mm           | 25 %              |          |
+| [stewart top](STL/stewart%20top.STL)                           | 2 mm           | 25 %              |          |
+| [torso bottom (external)](STL/torso%20bottom%20(external).STL) | 2 mm           | 25 %              |          |
+| [torso bottom (internal)](STL/torso%20bottom%20(internal).STL) | 2 mm           | 25 %              |          |
+| [torso bottom gear](STL/torso%20bottom%20gear.STL)             | 2 mm           | 25 %              |          |
+| [torso bottom holder](STL/torso%20bottom%20holder.STL)         | 2 mm           | 25 %              |          |
+| [USB hub support](STL/USB%20hub%20support.STL)                 | 2 mm           | 25 %              |          |
+
+## Laser Cutted Parts
+The material and the quantity are shown in the following table.
+
+| File                           | Material | Thickness | Quantity |
+| ------------------------------ | -------- | --------- | -------- |
+| [base_disk](DXF/base_disk.DXF) | Acrylic  | 4 mm      | 1        |
diff --git a/CAD/STL/.gitkeep b/CAD/STL/.gitkeep
diff --git a/CAD/assemblies/.gitkeep b/CAD/assemblies/.gitkeep
diff --git a/CAD/electronics/.gitkeep b/CAD/electronics/.gitkeep
diff --git a/CAD/gazebo_meshes/.gitkeep b/CAD/gazebo_meshes/.gitkeep
diff --git a/CAD/hardware/.gitkeep b/CAD/hardware/.gitkeep
diff --git a/CAD/laser/.gitkeep b/CAD/laser/.gitkeep
diff --git a/PCB/README.md b/PCB/README.md
@@ -0,0 +1,13 @@
+# PCB
+To build T-Top, two cutom PCBs must be made. 
+
+## Folder Structure
+ - The [psu_control](psu_control) folder the PCB files for PCB that controls and monitors the battery, audio amplifier, fans and LEDs.
+ - The [buck_boost](buck_boost) folder the PCB files for the Buck-Boost PCB.
+ - The [t-top.pretty](t-top.pretty) folder contains the custom footprints.
+ - The [t-top.lib](t-top.lib) file contains the custom parts.
+
+## PSU Control PCB
+
+
+## Buck-Boost PCB
diff --git a/README.md b/README.md
@@ -1,2 +1,10 @@
-# t-top
-T-Top Design Files and ROS nodes
+# T-Top
+T-Top is a tabletop robotdesigned with advanced audio and vision sensors, deep learningperceptual processing and telecommunication capabilities to provide  richer interaction modalities and develop higher cognitive abilities from interacting with people. 
+
+## Repository Structure
+ - The [documentation](documentation) folder contains the documentation to build and configure T-Top.
+ - The [CAD](CAD) folder contains the SolidWorks files of the robot. Il also contains the DXF and STL files to cut and print custom parts.
+ - The [PCB](PCB) folder contains the KiCad files of the custom PCBs. Il also contains the Gerber files to manufacture the PCBs.
+ - The [firmwares](firmwares) folder contains the firmware for the MCUs.
+
+## Papers
diff --git a/documentation/COMPUTER_CONFIGURATION.md b/documentation/COMPUTER_CONFIGURATION.md
@@ -0,0 +1 @@
+# Computer Configuration
diff --git a/documentation/MCU_CONFIGURATION.md b/documentation/MCU_CONFIGURATION.md
@@ -0,0 +1 @@
+# MCU Configuration
diff --git a/documentation/README.md b/documentation/README.md
@@ -0,0 +1,8 @@
+# Documentation
+
+## Building Steps
+ 1. [PCB Assembly](pcb_assembly)
+ 2. [MCU Configuration](MCU_CONFIGURATION.md)
+ 3. [Robot Assembly](robot_assembly)
+ 4. [Computer Configuration](COMPUTER_CONFIGURATION.md)
+
diff --git a/documentation/pcb_assembly/README.md b/documentation/pcb_assembly/README.md
@@ -0,0 +1,5 @@
+# PCB Assembly
+
+## PSU Control PCB
+
+## 12V Buck-Boost PCB
diff --git a/documentation/robot_assembly/README.md b/documentation/robot_assembly/README.md
@@ -0,0 +1 @@
+# Robot Assembly